Skip to content

Commit 9bcf111

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 0f4fd9de of spec repo
1 parent d5b07e4 commit 9bcf111

File tree

7 files changed

+63
-38
lines changed

7 files changed

+63
-38
lines changed

‎.apigentools-info‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-11-25 17:56:03.740290",
8-
"spec_repo_commit": "3cfd102e"
7+
"regenerated": "2024-11-25 20:30:31.028009",
8+
"spec_repo_commit": "0f4fd9de"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-11-25 17:56:03.759282",
13-
"spec_repo_commit": "3cfd102e"
12+
"regenerated": "2024-11-25 20:30:31.046769",
13+
"spec_repo_commit": "0f4fd9de"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 46 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ components:
8585
schema:
8686
$ref: '#/components/schemas/APIKeysSort'
8787
AWSAccountConfigIDPathParameter:
88-
description: Unique Datadog ID of the AWS Account Integration Config
88+
description: Unique Datadog ID of the AWS Account Integration Config. To get
89+
the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)
90+
endpoint and query by AWS Account ID.
8991
in: path
9092
name: aws_account_config_id
9193
required: true
@@ -991,7 +993,9 @@ components:
991993
x-enum-varnames:
992994
- API_KEYS
993995
AWSAccountConfigID:
994-
description: Unique Datadog ID of the AWS Account Integration Config
996+
description: Unique Datadog ID of the AWS Account Integration Config. To get
997+
the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)
998+
endpoint and query by AWS Account ID.
995999
example: 00000000-abcd-0001-0000-000000000000
9961000
type: string
9971001
AWSAccountCreateRequest:
@@ -1112,10 +1116,11 @@ components:
11121116
- type
11131117
type: object
11141118
AWSAccountTags:
1119+
default: []
11151120
description: Tags to apply to all metrics in the account
11161121
items:
11171122
description: Tag to apply to all metrics in the account
1118-
example: key:value
1123+
example: env:prod
11191124
type: string
11201125
nullable: true
11211126
type: array
@@ -1224,12 +1229,14 @@ components:
12241229
description: AWS Lambda forwarder
12251230
properties:
12261231
lambdas:
1232+
default: []
12271233
description: List of Datadog Lambda Log Forwarder ARNs
12281234
items:
12291235
example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder
12301236
type: string
12311237
type: array
12321238
sources:
1239+
default: []
12331240
description: List of AWS services that will send logs to the Datadog Lambda
12341241
Log Forwarder
12351242
items:
@@ -1294,18 +1301,22 @@ components:
12941301
description: AWS Metrics config
12951302
properties:
12961303
automute_enabled:
1304+
default: true
12971305
description: Enable EC2 automute for AWS metrics
12981306
example: true
12991307
type: boolean
13001308
collect_cloudwatch_alarms:
1309+
default: false
13011310
description: Enable CloudWatch alarms collection
13021311
example: true
13031312
type: boolean
13041313
collect_custom_metrics:
1314+
default: false
13051315
description: Enable custom metrics collection
13061316
example: true
13071317
type: boolean
13081318
enabled:
1319+
default: true
13091320
description: Enable AWS metrics collection
13101321
example: true
13111322
type: boolean
@@ -1323,12 +1334,20 @@ components:
13231334
- $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly'
13241335
- $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly'
13251336
AWSNamespaceFiltersExcludeOnly:
1326-
description: Exclude only these namespaces
1337+
description: Exclude only these namespaces from metrics collection. `AWS/SQS`
1338+
and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch costs
1339+
from `GetMetricData` API calls.
13271340
properties:
13281341
exclude_only:
1329-
description: Exclude only these namespaces
1342+
default:
1343+
- AWS/SQS
1344+
- AWS/ElasticMapReduce
1345+
description: Exclude only these namespaces from metrics collection. `AWS/SQS`
1346+
and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch
1347+
costs from `GetMetricData` API calls.
13301348
example:
1331-
- AWS/EC2
1349+
- AWS/SQS
1350+
- AWS/ElasticMapReduce
13321351
items:
13331352
example: AWS/EC2
13341353
type: string
@@ -1462,6 +1481,7 @@ components:
14621481
description: Include all regions
14631482
properties:
14641483
include_all:
1484+
default: true
14651485
description: Include all regions
14661486
example: false
14671487
type: boolean
@@ -1484,14 +1504,17 @@ components:
14841504
description: AWS Resources config
14851505
properties:
14861506
cloud_security_posture_management_collection:
1487-
description: Whether Datadog collects cloud security posture management
1488-
resources from your AWS account.
1507+
default: false
1508+
description: Enable Cloud Security Management to scan AWS resources for
1509+
vulnerabilities, misconfigurations, identity risks, and compliance violations.
1510+
Requires `extended_collection` to be set to `true`.
14891511
example: false
14901512
type: boolean
14911513
extended_collection:
1514+
default: true
14921515
description: Whether Datadog collects additional attributes and configuration
1493-
information about the resources in your AWS account. Required for `cspm_resource_collection`.
1494-
example: false
1516+
information about the resources in your AWS account. Required for `cloud_security_posture_management_collection`.
1517+
example: true
14951518
type: boolean
14961519
type: object
14971520
AWSTracesConfig:
@@ -27338,6 +27361,7 @@ components:
2733827361
nullable: true
2733927362
properties:
2734027363
include_only:
27364+
default: []
2734127365
description: Include only these services
2734227366
example:
2734327367
- AWS/AppSync
@@ -32464,7 +32488,8 @@ paths:
3246432488
description: Get a list of AWS Account Integration Configs.
3246532489
operationId: ListAWSAccounts
3246632490
parameters:
32467-
- description: Optional query filter accounts by AWS Account ID
32491+
- description: Optional query parameter to filter accounts by AWS Account ID.
32492+
If not provided, all accounts are returned.
3246832493
example: '123456789012'
3246932494
in: query
3247032495
name: aws_account_id
@@ -32489,7 +32514,7 @@ paths:
3248932514
operator: OR
3249032515
permissions:
3249132516
- aws_configuration_read
32492-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32517+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3249332518

3249432519
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3249532520
post:
@@ -32524,12 +32549,12 @@ paths:
3252432549
operator: OR
3252532550
permissions:
3252632551
- aws_configurations_manage
32527-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32552+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3252832553

3252932554
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3253032555
/api/v2/integration/aws/accounts/{aws_account_config_id}:
3253132556
delete:
32532-
description: Delete an AWS Account Integration Config
32557+
description: Delete an AWS Account Integration Config by config ID.
3253332558
operationId: DeleteAWSAccount
3253432559
parameters:
3253532560
- $ref: '#/components/parameters/AWSAccountConfigIDPathParameter'
@@ -32551,11 +32576,11 @@ paths:
3255132576
operator: OR
3255232577
permissions:
3255332578
- aws_configurations_manage
32554-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32579+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3255532580

3255632581
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3255732582
get:
32558-
description: Get an AWS Account Integration Config
32583+
description: Get an AWS Account Integration Config by config ID.
3255932584
operationId: GetAWSAccount
3256032585
parameters:
3256132586
- $ref: '#/components/parameters/AWSAccountConfigIDPathParameter'
@@ -32581,11 +32606,11 @@ paths:
3258132606
operator: OR
3258232607
permissions:
3258332608
- aws_configuration_read
32584-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32609+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3258532610

3258632611
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3258732612
patch:
32588-
description: Update an AWS Account Integration Config
32613+
description: Update an AWS Account Integration Config by config ID.
3258932614
operationId: UpdateAWSAccount
3259032615
parameters:
3259132616
- $ref: '#/components/parameters/AWSAccountConfigIDPathParameter'
@@ -32618,7 +32643,7 @@ paths:
3261832643
operator: OR
3261932644
permissions:
3262032645
- aws_configuration_edit
32621-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32646+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3262232647

3262332648
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3262432649
/api/v2/integration/aws/available_namespaces:
@@ -32644,7 +32669,7 @@ paths:
3264432669
operator: OR
3264532670
permissions:
3264632671
- aws_configuration_read
32647-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32672+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3264832673

3264932674
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3265032675
/api/v2/integration/aws/generate_new_external_id:
@@ -32669,7 +32694,7 @@ paths:
3266932694
operator: OR
3267032695
permissions:
3267132696
- aws_configuration_edit
32672-
x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
32697+
x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
3267332698

3267432699
contact [Datadog support](https://docs.datadoghq.com/help/).**'
3267532700
/api/v2/integration/aws/logs/services:

‎lib/datadog_api_client/v2/api/aws_integration_api.rb‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ def delete_aws_account(aws_account_config_id, opts = {})
172172

173173
# Delete an AWS integration.
174174
#
175-
# Delete an AWS Account Integration Config
175+
# Delete an AWS Account Integration Config by config ID.
176176
#
177-
# @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config
177+
# @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.
178178
# @param opts [Hash] the optional parameters
179179
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
180180
def delete_aws_account_with_http_info(aws_account_config_id, opts = {})
@@ -243,9 +243,9 @@ def get_aws_account(aws_account_config_id, opts = {})
243243

244244
# Get an AWS integration by config ID.
245245
#
246-
# Get an AWS Account Integration Config
246+
# Get an AWS Account Integration Config by config ID.
247247
#
248-
# @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config
248+
# @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.
249249
# @param opts [Hash] the optional parameters
250250
# @return [Array<(AWSAccountResponse, Integer, Hash)>] AWSAccountResponse data, response status code and response headers
251251
def get_aws_account_with_http_info(aws_account_config_id, opts = {})
@@ -317,7 +317,7 @@ def list_aws_accounts(opts = {})
317317
# Get a list of AWS Account Integration Configs.
318318
#
319319
# @param opts [Hash] the optional parameters
320-
# @option opts [String] :aws_account_id Optional query filter accounts by AWS Account ID
320+
# @option opts [String] :aws_account_id Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.
321321
# @return [Array<(AWSAccountsResponse, Integer, Hash)>] AWSAccountsResponse data, response status code and response headers
322322
def list_aws_accounts_with_http_info(opts = {})
323323
unstable_enabled = @api_client.config.unstable_operations["v2.list_aws_accounts".to_sym]
@@ -448,9 +448,9 @@ def update_aws_account(aws_account_config_id, body, opts = {})
448448

449449
# Update an AWS integration.
450450
#
451-
# Update an AWS Account Integration Config
451+
# Update an AWS Account Integration Config by config ID.
452452
#
453-
# @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config
453+
# @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.
454454
# @param body [AWSAccountUpdateRequest]
455455
# @param opts [Hash] the optional parameters
456456
# @return [Array<(AWSAccountResponse, Integer, Hash)>] AWSAccountResponse data, response status code and response headers

‎lib/datadog_api_client/v2/models/aws_account_response_data.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class AWSAccountResponseData
2424
# The AWS Account Integration Config
2525
attr_accessor :attributes
2626

27-
# Unique Datadog ID of the AWS Account Integration Config
27+
# Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.
2828
attr_reader :id
2929

3030
# AWS Account resource type.

‎lib/datadog_api_client/v2/models/aws_account_update_request_data.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class AWSAccountUpdateRequestData
2424
# The AWS Account Integration Config to be updated
2525
attr_reader :attributes
2626

27-
# Unique Datadog ID of the AWS Account Integration Config
27+
# Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.
2828
attr_accessor :id
2929

3030
# AWS Account resource type.

‎lib/datadog_api_client/v2/models/aws_namespace_filters_exclude_only.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# Exclude only these namespaces
20+
# Exclude only these namespaces from metrics collection. `AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch costs from `GetMetricData` API calls.
2121
class AWSNamespaceFiltersExcludeOnly
2222
include BaseGenericModel
2323

24-
# Exclude only these namespaces
24+
# Exclude only these namespaces from metrics collection. `AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch costs from `GetMetricData` API calls.
2525
attr_reader :exclude_only
2626

2727
attr_accessor :additional_properties

‎lib/datadog_api_client/v2/models/aws_resources_config.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module DatadogAPIClient::V2
2121
class AWSResourcesConfig
2222
include BaseGenericModel
2323

24-
# Whether Datadog collects cloud security posture management resources from your AWS account.
24+
# Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Requires `extended_collection` to be set to `true`.
2525
attr_accessor :cloud_security_posture_management_collection
2626

27-
# Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.
27+
# Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cloud_security_posture_management_collection`.
2828
attr_accessor :extended_collection
2929

3030
attr_accessor :additional_properties

0 commit comments

Comments
 (0)