Regenerate client from commit 63e04569 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-02 14:34:49.046316",
-            "spec_repo_commit": "48a734bf"
+            "regenerated": "2024-12-02 15:50:54.147081",
+            "spec_repo_commit": "63e04569"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-02 14:34:49.065976",
-            "spec_repo_commit": "48a734bf"
+            "regenerated": "2024-12-02 15:50:54.166167",
+            "spec_repo_commit": "63e04569"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -85,7 +85,9 @@ components:
       schema:
         $ref: '#/components/schemas/APIKeysSort'
     AWSAccountConfigIDPathParameter:
-      description: Unique Datadog ID of the AWS Account Integration Config
+      description: 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.
       in: path
       name: aws_account_config_id
       required: true
@@ -991,7 +993,9 @@ components:
       x-enum-varnames:
       - API_KEYS
     AWSAccountConfigID:
-      description: Unique Datadog ID of the AWS Account Integration Config
+      description: 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.
       example: 00000000-abcd-0001-0000-000000000000
       type: string
     AWSAccountCreateRequest:
@@ -1044,8 +1048,9 @@ components:
       example: '123456789012'
       type: string
     AWSAccountPartition:
-      default: aws
-      description: AWS Account partition
+      description: AWS partition your AWS account is scoped to. Defaults to `aws`.
+        See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html)
+        in the AWS documentation for more information.
       enum:
       - aws
       - aws-cn
@@ -1112,10 +1117,10 @@ components:
       - type
       type: object
     AWSAccountTags:
-      description: Tags to apply to all metrics in the account
+      description: Tags to apply to all metrics in the account. Defaults to `[]`.
       items:
         description: Tag to apply to all metrics in the account
-        example: key:value
+        example: env:prod
         type: string
       nullable: true
       type: array
@@ -1224,14 +1229,14 @@ components:
       description: AWS Lambda forwarder
       properties:
         lambdas:
-          description: List of Datadog Lambda Log Forwarder ARNs
+          description: List of Datadog Lambda Log Forwarder ARNs. Defaults to `[]`.
           items:
             example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder
             type: string
           type: array
         sources:
           description: List of AWS services that will send logs to the Datadog Lambda
-            Log Forwarder
+            Log Forwarder. Defaults to `[]`.
           items:
             example: s3
             type: string
@@ -1294,19 +1299,19 @@ components:
       description: AWS Metrics config
       properties:
         automute_enabled:
-          description: Enable EC2 automute for AWS metrics
+          description: Enable EC2 automute for AWS metrics. Defaults to `true`.
           example: true
           type: boolean
         collect_cloudwatch_alarms:
-          description: Enable CloudWatch alarms collection
-          example: true
+          description: Enable CloudWatch alarms collection. Defaults to `false`.
+          example: false
           type: boolean
         collect_custom_metrics:
-          description: Enable custom metrics collection
-          example: true
+          description: Enable custom metrics collection. Defaults to `false`.
+          example: false
           type: boolean
         enabled:
-          description: Enable AWS metrics collection
+          description: Enable AWS metrics collection. Defaults to `true`.
           example: true
           type: boolean
         namespace_filters:
@@ -1318,19 +1323,26 @@ components:
           type: array
       type: object
     AWSNamespaceFilters:
-      description: AWS Metrics namespace filters
+      description: AWS Metrics namespace filters. Defaults to `exclude_only`.
       oneOf:
       - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly'
       - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly'
     AWSNamespaceFiltersExcludeOnly:
-      description: Exclude only these namespaces
+      description: Exclude only these namespaces from metrics collection. Defaults
+        to `["AWS/SQS", "AWS/ElasticMapReduce"]`. `AWS/SQS` and `AWS/ElasticMapReduce`
+        are excluded by default to reduce your CloudWatch costs from `GetMetricData`
+        API calls.
       properties:
         exclude_only:
-          description: Exclude only these namespaces
+          description: Exclude only these namespaces from metrics collection. Defaults
+            to `["AWS/SQS", "AWS/ElasticMapReduce"]`. `AWS/SQS` and `AWS/ElasticMapReduce`
+            are excluded by default to reduce your CloudWatch costs from `GetMetricData`
+            API calls.
           example:
-          - AWS/EC2
+          - AWS/SQS
+          - AWS/ElasticMapReduce
           items:
-            example: AWS/EC2
+            example: AWS/SQS
             type: string
           type: array
       required:
@@ -1454,16 +1466,16 @@ components:
       x-enum-varnames:
       - EXTERNAL_ID
     AWSRegions:
-      description: AWS Regions to collect data from
+      description: AWS Regions to collect data from. Defaults to `include_all`.
       oneOf:
       - $ref: '#/components/schemas/AWSRegionsIncludeAll'
       - $ref: '#/components/schemas/AWSRegionsIncludeOnly'
     AWSRegionsIncludeAll:
-      description: Include all regions
+      description: Include all regions. Defaults to `true`.
       properties:
         include_all:
           description: Include all regions
-          example: false
+          example: true
           type: boolean
       required:
       - include_all
@@ -1484,14 +1496,16 @@ components:
       description: AWS Resources config
       properties:
         cloud_security_posture_management_collection:
-          description: Whether Datadog collects cloud security posture management
-            resources from your AWS account.
+          description: Enable Cloud Security Management to scan AWS resources for
+            vulnerabilities, misconfigurations, identity risks, and compliance violations.
+            Defaults to `false`. Requires `extended_collection` to be set to `true`.
           example: false
           type: boolean
         extended_collection:
           description: Whether Datadog collects additional attributes and configuration
-            information about the resources in your AWS account. Required for `cspm_resource_collection`.
-          example: false
+            information about the resources in your AWS account. Defaults to `true`.
+            Required for `cloud_security_posture_management_collection`.
+          example: true
           type: boolean
       type: object
     AWSTracesConfig:
@@ -27334,7 +27348,7 @@ components:
       required:
       - include_all
     XRayServicesIncludeOnly:
-      description: Include only these services
+      description: Include only these services. Defaults to `[]`.
       nullable: true
       properties:
         include_only:
@@ -27348,7 +27362,7 @@ components:
       required:
       - include_only
     XRayServicesList:
-      description: AWS X-Ray services to collect traces from
+      description: AWS X-Ray services to collect traces from. Defaults to `include_only`.
       oneOf:
       - $ref: '#/components/schemas/XRayServicesIncludeAll'
       - $ref: '#/components/schemas/XRayServicesIncludeOnly'
@@ -32465,7 +32479,8 @@ paths:
       description: Get a list of AWS Account Integration Configs.
       operationId: ListAWSAccounts
       parameters:
-      - description: Optional query filter accounts by AWS Account ID
+      - description: Optional query parameter to filter accounts by AWS Account ID.
+          If not provided, all accounts are returned.
         example: '123456789012'
         in: query
         name: aws_account_id
@@ -32490,7 +32505,7 @@ paths:
         operator: OR
         permissions:
         - aws_configuration_read
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
     post:
@@ -32525,12 +32540,12 @@ paths:
         operator: OR
         permissions:
         - aws_configurations_manage
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
   /api/v2/integration/aws/accounts/{aws_account_config_id}:
     delete:
-      description: Delete an AWS Account Integration Config
+      description: Delete an AWS Account Integration Config by config ID.
       operationId: DeleteAWSAccount
       parameters:
       - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter'
@@ -32552,11 +32567,11 @@ paths:
         operator: OR
         permissions:
         - aws_configurations_manage
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
     get:
-      description: Get an AWS Account Integration Config
+      description: Get an AWS Account Integration Config by config ID.
       operationId: GetAWSAccount
       parameters:
       - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter'
@@ -32582,11 +32597,11 @@ paths:
         operator: OR
         permissions:
         - aws_configuration_read
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
     patch:
-      description: Update an AWS Account Integration Config
+      description: Update an AWS Account Integration Config by config ID.
       operationId: UpdateAWSAccount
       parameters:
       - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter'
@@ -32619,7 +32634,7 @@ paths:
         operator: OR
         permissions:
         - aws_configuration_edit
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
   /api/v2/integration/aws/available_namespaces:
@@ -32645,7 +32660,7 @@ paths:
         operator: OR
         permissions:
         - aws_configuration_read
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
   /api/v2/integration/aws/generate_new_external_id:
@@ -32670,7 +32685,7 @@ paths:
         operator: OR
         permissions:
         - aws_configuration_edit
-      x-unstable: '**Note: This endpoint is in public beta. If you have any feedback,
+      x-unstable: '**Note: This endpoint is in Preview. If you have any feedback,
 
         contact [Datadog support](https://docs.datadoghq.com/help/).**'
   /api/v2/integration/aws/logs/services:

lib/datadog_api_client/v2/api/aws_integration_api.rb

@@ -172,9 +172,9 @@ def delete_aws_account(aws_account_config_id, opts = {})
 
     # Delete an AWS integration.
     #
-    # Delete an AWS Account Integration Config
+    # Delete an AWS Account Integration Config by config ID.
     #
-    # @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config
+    # @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.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     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 = {})
 
     # Get an AWS integration by config ID.
     #
-    # Get an AWS Account Integration Config
+    # Get an AWS Account Integration Config by config ID.
     #
-    # @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config
+    # @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.
     # @param opts [Hash] the optional parameters
     # @return [Array<(AWSAccountResponse, Integer, Hash)>] AWSAccountResponse data, response status code and response headers
     def get_aws_account_with_http_info(aws_account_config_id, opts = {})
@@ -317,7 +317,7 @@ def list_aws_accounts(opts = {})
     # Get a list of AWS Account Integration Configs.
     #
     # @param opts [Hash] the optional parameters
-    # @option opts [String] :aws_account_id Optional query filter accounts by AWS Account ID
+    # @option opts [String] :aws_account_id Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.
     # @return [Array<(AWSAccountsResponse, Integer, Hash)>] AWSAccountsResponse data, response status code and response headers
     def list_aws_accounts_with_http_info(opts = {})
       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 = {})
 
     # Update an AWS integration.
     #
-    # Update an AWS Account Integration Config
+    # Update an AWS Account Integration Config by config ID.
     #
-    # @param aws_account_config_id [String] Unique Datadog ID of the AWS Account Integration Config
+    # @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.
     # @param body [AWSAccountUpdateRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(AWSAccountResponse, Integer, Hash)>] AWSAccountResponse data, response status code and response headers

lib/datadog_api_client/v2/models/aws_account_create_request_attributes.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class AWSAccountCreateRequestAttributes
     include BaseGenericModel
 
-    # Tags to apply to all metrics in the account
+    # Tags to apply to all metrics in the account. Defaults to `[]`.
     attr_accessor :account_tags
 
     # AWS Authentication config
@@ -30,10 +30,10 @@ class AWSAccountCreateRequestAttributes
     # AWS Account ID
     attr_reader :aws_account_id
 
-    # AWS Account partition
+    # AWS partition your AWS account is scoped to. Defaults to `aws`. See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.
     attr_reader :aws_partition
 
-    # AWS Regions to collect data from
+    # AWS Regions to collect data from. Defaults to `include_all`.
     attr_accessor :aws_regions
 
     # AWS Logs config

lib/datadog_api_client/v2/models/aws_account_partition.rb

@@ -17,7 +17,7 @@
 require 'time'
 
 module DatadogAPIClient::V2
-  # AWS Account partition
+  # AWS partition your AWS account is scoped to. Defaults to `aws`. See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.
   class AWSAccountPartition
     include BaseEnumModel
 

lib/datadog_api_client/v2/models/aws_account_response_attributes.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class AWSAccountResponseAttributes
     include BaseGenericModel
 
-    # Tags to apply to all metrics in the account
+    # Tags to apply to all metrics in the account. Defaults to `[]`.
     attr_accessor :account_tags
 
     # AWS Authentication config
@@ -30,10 +30,10 @@ class AWSAccountResponseAttributes
     # AWS Account ID
     attr_reader :aws_account_id
 
-    # AWS Account partition
+    # AWS partition your AWS account is scoped to. Defaults to `aws`. See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.
     attr_accessor :aws_partition
 
-    # AWS Regions to collect data from
+    # AWS Regions to collect data from. Defaults to `include_all`.
     attr_accessor :aws_regions
 
     # Timestamp of when the account integration was created

lib/datadog_api_client/v2/models/aws_account_response_data.rb

@@ -24,7 +24,7 @@ class AWSAccountResponseData
     # The AWS Account Integration Config
     attr_accessor :attributes
 
-    # Unique Datadog ID of the AWS Account Integration Config
+    # 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.
     attr_reader :id
 
     # AWS Account resource type.