Regenerate client from commit 0f4fd9de of spec repo

DataDog · Nov 25, 2024 · 18136b5 · 18136b5
1 parent 45e5376
commit 18136b5
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 38 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-25 17:55:58.983551",
-            "spec_repo_commit": "3cfd102e"
+            "regenerated": "2024-11-25 20:30:31.345973",
+            "spec_repo_commit": "0f4fd9de"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-25 17:55:59.002287",
-            "spec_repo_commit": "3cfd102e"
+            "regenerated": "2024-11-25 20:30:31.366723",
+            "spec_repo_commit": "0f4fd9de"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.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:
@@ -1112,10 +1116,11 @@ components:
       - type
       type: object
     AWSAccountTags:
+      default: []
       description: Tags to apply to all metrics in the account
       items:
         description: Tag to apply to all metrics in the account
-        example: key:value
+        example: env:prod
         type: string
       nullable: true
       type: array
@@ -1224,12 +1229,14 @@ components:
       description: AWS Lambda forwarder
       properties:
         lambdas:
+          default: []
           description: List of Datadog Lambda Log Forwarder ARNs
           items:
             example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder
             type: string
           type: array
         sources:
+          default: []
           description: List of AWS services that will send logs to the Datadog Lambda
             Log Forwarder
           items:
@@ -1294,18 +1301,22 @@ components:
       description: AWS Metrics config
       properties:
         automute_enabled:
+          default: true
           description: Enable EC2 automute for AWS metrics
           example: true
           type: boolean
         collect_cloudwatch_alarms:
+          default: false
           description: Enable CloudWatch alarms collection
           example: true
           type: boolean
         collect_custom_metrics:
+          default: false
           description: Enable custom metrics collection
           example: true
           type: boolean
         enabled:
+          default: true
           description: Enable AWS metrics collection
           example: true
           type: boolean
@@ -1323,12 +1334,20 @@ components:
       - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly'
       - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly'
     AWSNamespaceFiltersExcludeOnly:
-      description: Exclude only these namespaces
+      description: Exclude only these namespaces from metrics collection. `AWS/SQS`
+        and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch costs
+        from `GetMetricData` API calls.
       properties:
         exclude_only:
-          description: Exclude only these namespaces
+          default:
+          - AWS/SQS
+          - AWS/ElasticMapReduce
+          description: Exclude only these namespaces from metrics collection. `AWS/SQS`
+            and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch
+            costs from `GetMetricData` API calls.
           example:
-          - AWS/EC2
+          - AWS/SQS
+          - AWS/ElasticMapReduce
           items:
             example: AWS/EC2
             type: string
@@ -1462,6 +1481,7 @@ components:
       description: Include all regions
       properties:
         include_all:
+          default: true
           description: Include all regions
           example: false
           type: boolean
@@ -1484,14 +1504,17 @@ components:
       description: AWS Resources config
       properties:
         cloud_security_posture_management_collection:
-          description: Whether Datadog collects cloud security posture management
-            resources from your AWS account.
+          default: false
+          description: Enable Cloud Security Management to scan AWS resources for
+            vulnerabilities, misconfigurations, identity risks, and compliance violations.
+            Requires `extended_collection` to be set to `true`.
           example: false
           type: boolean
         extended_collection:
+          default: true
           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. Required for `cloud_security_posture_management_collection`.
+          example: true
           type: boolean
       type: object
     AWSTracesConfig:
@@ -27338,6 +27361,7 @@ components:
       nullable: true
       properties:
         include_only:
+          default: []
           description: Include only these services
           example:
           - AWS/AppSync
@@ -32464,7 +32488,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
@@ -32489,7 +32514,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:
@@ -32524,12 +32549,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'
@@ -32551,11 +32576,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'
@@ -32581,11 +32606,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'
@@ -32618,7 +32643,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:
@@ -32644,7 +32669,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:
@@ -32669,7 +32694,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:

diff --git a/packages/datadog-api-client-v2/apis/AWSIntegrationApi.ts b/packages/datadog-api-client-v2/apis/AWSIntegrationApi.ts
@@ -736,31 +736,31 @@ export interface AWSIntegrationApiCreateAWSAccountRequest {
 
 export interface AWSIntegrationApiDeleteAWSAccountRequest {
   /**
-   * 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.
    * @type string
    */
   awsAccountConfigId: string;
 }
 
 export interface AWSIntegrationApiGetAWSAccountRequest {
   /**
-   * 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.
    * @type string
    */
   awsAccountConfigId: string;
 }
 
 export interface AWSIntegrationApiListAWSAccountsRequest {
   /**
-   * Optional query filter accounts by AWS Account ID
+   * Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.
    * @type string
    */
   awsAccountId?: string;
 }
 
 export interface AWSIntegrationApiUpdateAWSAccountRequest {
   /**
-   * 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.
    * @type string
    */
   awsAccountConfigId: string;
@@ -827,7 +827,7 @@ export class AWSIntegrationApi {
   }
 
   /**
-   * Delete an AWS Account Integration Config
+   * Delete an AWS Account Integration Config by config ID.
    * @param param The request object
    */
   public deleteAWSAccount(
@@ -848,7 +848,7 @@ export class AWSIntegrationApi {
   }
 
   /**
-   * Get an AWS Account Integration Config
+   * Get an AWS Account Integration Config by config ID.
    * @param param The request object
    */
   public getAWSAccount(
@@ -908,7 +908,7 @@ export class AWSIntegrationApi {
   }
 
   /**
-   * Update an AWS Account Integration Config
+   * Update an AWS Account Integration Config by config ID.
    * @param param The request object
    */
   public updateAWSAccount(

diff --git a/packages/datadog-api-client-v2/models/AWSAccountResponseData.ts b/packages/datadog-api-client-v2/models/AWSAccountResponseData.ts
@@ -17,7 +17,7 @@ export class AWSAccountResponseData {
    */
   "attributes"?: AWSAccountResponseAttributes;
   /**
-   * 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.
    */
   "id": string;
   /**

diff --git a/packages/datadog-api-client-v2/models/AWSAccountUpdateRequestData.ts b/packages/datadog-api-client-v2/models/AWSAccountUpdateRequestData.ts
@@ -17,7 +17,7 @@ export class AWSAccountUpdateRequestData {
    */
   "attributes": AWSAccountUpdateRequestAttributes;
   /**
-   * 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.
    */
   "id"?: string;
   /**

diff --git a/packages/datadog-api-client-v2/models/AWSNamespaceFiltersExcludeOnly.ts b/packages/datadog-api-client-v2/models/AWSNamespaceFiltersExcludeOnly.ts
@@ -7,11 +7,11 @@
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * Exclude only these namespaces
+ * Exclude only these namespaces from metrics collection. `AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch costs from `GetMetricData` API calls.
  */
 export class AWSNamespaceFiltersExcludeOnly {
   /**
-   * Exclude only these namespaces
+   * Exclude only these namespaces from metrics collection. `AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce CloudWatch costs from `GetMetricData` API calls.
    */
   "excludeOnly": Array<string>;
 

diff --git a/packages/datadog-api-client-v2/models/AWSResourcesConfig.ts b/packages/datadog-api-client-v2/models/AWSResourcesConfig.ts
@@ -11,11 +11,11 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  */
 export class AWSResourcesConfig {
   /**
-   * Whether Datadog collects cloud security posture management resources from your AWS account.
+   * Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Requires `extended_collection` to be set to `true`.
    */
   "cloudSecurityPostureManagementCollection"?: boolean;
   /**
-   * Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.
+   * Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cloud_security_posture_management_collection`.
    */
   "extendedCollection"?: boolean;