From 5fed1ba1d2cc291ff6a1060d175a8407e7a79242 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Thu, 12 Dec 2024 07:45:54 +0000 Subject: [PATCH] Regenerate client from commit 4df5e8c3 of spec repo --- .apigentools-info | 8 +- .generator/schemas/v1/openapi.yaml | 2 +- .generator/schemas/v2/openapi.yaml | 223 +++++++++++------- api/datadogV2/api_aws_integration.go | 6 +- .../model_aws_account_create_request.go | 4 +- ...l_aws_account_create_request_attributes.go | 23 +- .../model_aws_account_create_request_data.go | 4 +- api/datadogV2/model_aws_account_partition.go | 3 +- api/datadogV2/model_aws_account_response.go | 4 +- .../model_aws_account_response_attributes.go | 29 +-- .../model_aws_account_response_data.go | 8 +- .../model_aws_account_update_request.go | 4 +- ...l_aws_account_update_request_attributes.go | 25 +- .../model_aws_account_update_request_data.go | 8 +- api/datadogV2/model_aws_accounts_response.go | 4 +- api/datadogV2/model_aws_auth_config.go | 2 +- api/datadogV2/model_aws_auth_config_keys.go | 6 +- api/datadogV2/model_aws_auth_config_role.go | 6 +- .../model_aws_lambda_forwarder_config.go | 8 +- api/datadogV2/model_aws_logs_config.go | 5 +- api/datadogV2/model_aws_metrics_config.go | 14 +- api/datadogV2/model_aws_namespace_filters.go | 2 +- ...odel_aws_namespace_filters_exclude_only.go | 6 +- ...odel_aws_namespace_filters_include_only.go | 4 +- .../model_aws_namespace_tag_filter.go | 10 +- .../model_aws_namespaces_response.go | 4 +- ...odel_aws_namespaces_response_attributes.go | 4 +- .../model_aws_namespaces_response_data.go | 4 +- .../model_aws_new_external_id_response.go | 4 +- ...aws_new_external_id_response_attributes.go | 4 +- ...model_aws_new_external_id_response_data.go | 4 +- api/datadogV2/model_aws_regions.go | 2 +- .../model_aws_regions_include_all.go | 4 +- .../model_aws_regions_include_only.go | 4 +- api/datadogV2/model_aws_resources_config.go | 6 +- api/datadogV2/model_aws_traces_config.go | 4 +- .../model_x_ray_services_include_all.go | 4 +- .../model_x_ray_services_include_only.go | 4 +- api/datadogV2/model_x_ray_services_list.go | 2 +- 39 files changed, 263 insertions(+), 209 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 54d59e1bfee..3c3b210d20a 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-11 14:25:01.665030", - "spec_repo_commit": "7a9d0200" + "regenerated": "2024-12-12 07:44:13.640707", + "spec_repo_commit": "4df5e8c3" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-11 14:25:01.686317", - "spec_repo_commit": "7a9d0200" + "regenerated": "2024-12-12 07:44:13.659880", + "spec_repo_commit": "4df5e8c3" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 6537e03408d..57b09647e59 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -5969,7 +5969,7 @@ components: - name type: object LogsPipelineList: - description: Array of pipeline ID strings. + description: Array of all log pipeline objects configured for the organization. items: $ref: '#/components/schemas/LogsPipeline' type: array diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 8b55ec7ed38..c2b7a7ae016 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -85,7 +85,11 @@ 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 @@ -1005,11 +1009,15 @@ 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: - description: AWS Account Create Request body + description: AWS Account Create Request body. properties: data: $ref: '#/components/schemas/AWSAccountCreateRequestData' @@ -1017,7 +1025,7 @@ components: - data type: object AWSAccountCreateRequestAttributes: - description: The AWS Account Integration Config to be created + description: The AWS Account Integration Config to be created. properties: account_tags: $ref: '#/components/schemas/AWSAccountTags' @@ -1043,7 +1051,7 @@ components: - auth_config type: object AWSAccountCreateRequestData: - description: AWS Account Create Request data + description: AWS Account Create Request data. properties: attributes: $ref: '#/components/schemas/AWSAccountCreateRequestAttributes' @@ -1054,12 +1062,14 @@ components: - type type: object AWSAccountID: - description: AWS Account ID + description: AWS Account ID. 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 @@ -1071,7 +1081,7 @@ components: - AWS_CN - AWS_US_GOV AWSAccountResponse: - description: AWS Account response body + description: AWS Account response body. properties: data: $ref: '#/components/schemas/AWSAccountResponseData' @@ -1079,7 +1089,7 @@ components: - data type: object AWSAccountResponseAttributes: - description: The AWS Account Integration Config + description: AWS Account response attributes. properties: account_tags: $ref: '#/components/schemas/AWSAccountTags' @@ -1092,7 +1102,7 @@ components: aws_regions: $ref: '#/components/schemas/AWSRegions' created_at: - description: Timestamp of when the account integration was created + description: Timestamp of when the account integration was created. format: date-time readOnly: true type: string @@ -1101,7 +1111,7 @@ components: metrics_config: $ref: '#/components/schemas/AWSMetricsConfig' modified_at: - description: Timestamp of when the account integration was updated + description: Timestamp of when the account integration was updated. format: date-time readOnly: true type: string @@ -1113,7 +1123,7 @@ components: - aws_account_id type: object AWSAccountResponseData: - description: AWS Account Response body + description: AWS Account response data. properties: attributes: $ref: '#/components/schemas/AWSAccountResponseAttributes' @@ -1126,10 +1136,11 @@ components: - type type: object AWSAccountTags: - description: Tags to apply to all metrics in the account + description: Tags to apply to all hosts and metrics reporting for this account. + Defaults to `[]`. items: - description: Tag to apply to all metrics in the account - example: key:value + description: Tag in the form `key:value`. + example: env:prod type: string nullable: true type: array @@ -1143,7 +1154,7 @@ components: x-enum-varnames: - ACCOUNT AWSAccountUpdateRequest: - description: AWS Account Update Request body + description: AWS Account Update Request body. properties: data: $ref: '#/components/schemas/AWSAccountUpdateRequestData' @@ -1151,7 +1162,7 @@ components: - data type: object AWSAccountUpdateRequestAttributes: - description: The AWS Account Integration Config to be updated + description: The AWS Account Integration Config to be updated. properties: account_tags: $ref: '#/components/schemas/AWSAccountTags' @@ -1175,7 +1186,7 @@ components: - aws_account_id type: object AWSAccountUpdateRequestData: - description: AWS Account Update Request data + description: AWS Account Update Request data. properties: attributes: $ref: '#/components/schemas/AWSAccountUpdateRequestAttributes' @@ -1188,10 +1199,10 @@ components: - type type: object AWSAccountsResponse: - description: AWS Accounts response body + description: AWS Accounts response body. properties: data: - description: List of AWS Account Integration Configs + description: List of AWS Account Integration Configs. items: $ref: '#/components/schemas/AWSAccountResponseData' type: array @@ -1199,19 +1210,20 @@ components: - data type: object AWSAuthConfig: - description: AWS Authentication config + description: AWS Authentication config. oneOf: - $ref: '#/components/schemas/AWSAuthConfigKeys' - $ref: '#/components/schemas/AWSAuthConfigRole' AWSAuthConfigKeys: - description: AWS Authentication config for key-based account + description: AWS Authentication config to integrate your account using an access + key pair. properties: access_key_id: - description: AWS Access Key ID + description: AWS Access Key ID. example: AKIAIOSFODNN7EXAMPLE type: string secret_access_key: - description: AWS Secret Access Key + description: AWS Secret Access Key. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY minLength: 1 type: string @@ -1220,13 +1232,14 @@ components: - access_key_id type: object AWSAuthConfigRole: - description: AWS Authentication config for role-based account + description: AWS Authentication config to integrate your account using an IAM + role. properties: external_id: - description: AWS IAM External ID for associated role + description: AWS IAM External ID for associated role. type: string role_name: - description: AWS IAM Role name + description: AWS IAM Role name. example: DatadogIntegrationRole maxLength: 576 minLength: 1 @@ -1235,24 +1248,32 @@ components: - role_name type: object AWSLambdaForwarderConfig: - description: AWS Lambda forwarder + description: 'Log Autosubscription configuration for Datadog Forwarder Lambda + functions. Automatically set up triggers for existing + + and new logs for some services, ensuring no logs from new resources are missed + and saving time spent on manual configuration.' properties: lambdas: - description: List of Datadog Lambda Log Forwarder ARNs + description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. + 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 + description: 'List of service IDs set to enable automatic log collection. + Discover the list of available services with the + + [Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) + endpoint.' items: example: s3 type: string type: array type: object AWSLogsConfig: - description: AWS Logs config + description: AWS Logs Collection config. properties: lambda_forwarder: $ref: '#/components/schemas/AWSLambdaForwarderConfig' @@ -1305,55 +1326,64 @@ components: x-enum-varnames: - LOGS_SERVICES AWSMetricsConfig: - description: AWS Metrics config + description: AWS Metrics Collection 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: $ref: '#/components/schemas/AWSNamespaceFilters' tag_filters: - description: AWS Metrics tag filters list + description: AWS Metrics collection tag filters list. Defaults to `[]`. items: $ref: '#/components/schemas/AWSNamespaceTagFilter' 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 + AWS 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 AWS 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: - exclude_only AWSNamespaceFiltersIncludeOnly: - description: Include only these namespaces + description: Include only these namespaces. properties: include_only: - description: Include only these namespaces + description: Include only these namespaces. example: - AWS/EC2 items: @@ -1363,22 +1393,36 @@ components: required: - include_only AWSNamespaceTagFilter: - description: AWS Metrics tag filters + description: 'AWS Metrics Collection tag filters list. Defaults to `[]`. + + The array of custom AWS resource tags (in the form `key:value`) defines a + filter that Datadog uses when collecting metrics from a specified service. + + Wildcards, such as `?` (match a single character) and `*` (match multiple + characters), and exclusion using `!` before the tag are supported. + + For EC2, only hosts that match one of the defined tags will be imported into + Datadog. The rest will be ignored. + + For example, `env:production,instance-type:c?.*,!region:us-east-1`.' properties: namespace: - description: The AWS Namespace to apply the tag filters against + description: The AWS service for which the tag filters defined in `tags` + will be applied. example: AWS/EC2 type: string tags: - description: The tags to filter based on + description: The AWS resource tags to filter on for the service specified + by `namespace`. items: - example: key:value + description: Tag in the form `key:value`. + example: datadog:true type: string nullable: true type: array type: object AWSNamespacesResponse: - description: AWS Namespaces response body + description: AWS Namespaces response body. properties: data: $ref: '#/components/schemas/AWSNamespacesResponseData' @@ -1386,10 +1430,10 @@ components: - data type: object AWSNamespacesResponseAttributes: - description: AWS Namespaces response body + description: AWS Namespaces response attributes. properties: namespaces: - description: AWS CloudWatch namespace + description: AWS CloudWatch namespace. example: - AWS/ApiGateway items: @@ -1400,7 +1444,7 @@ components: - namespaces type: object AWSNamespacesResponseData: - description: AWS Namespaces response body + description: AWS Namespaces response data. properties: attributes: $ref: '#/components/schemas/AWSNamespacesResponseAttributes' @@ -1425,7 +1469,7 @@ components: x-enum-varnames: - NAMESPACES AWSNewExternalIDResponse: - description: AWS External ID response body + description: AWS External ID response body. properties: data: $ref: '#/components/schemas/AWSNewExternalIDResponseData' @@ -1433,17 +1477,17 @@ components: - data type: object AWSNewExternalIDResponseAttributes: - description: AWS External ID response body + description: AWS External ID response body. properties: external_id: - description: AWS IAM External ID for associated role + description: AWS IAM External ID for associated role. example: acb8f6b8a844443dbb726d07dcb1a870 type: string required: - external_id type: object AWSNewExternalIDResponseData: - description: AWS External ID response body + description: AWS External ID response body. properties: attributes: $ref: '#/components/schemas/AWSNewExternalIDResponseAttributes' @@ -1468,24 +1512,24 @@ 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 + description: Include all regions. + example: true type: boolean required: - include_all AWSRegionsIncludeOnly: - description: Include only these regions + description: Include only these regions. properties: include_only: - description: Include only these regions + description: Include only these regions. example: - us-east-1 items: @@ -1495,21 +1539,23 @@ components: required: - include_only AWSResourcesConfig: - description: AWS Resources config + description: AWS Resources Collection 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: - description: AWS Traces config + description: AWS Traces Collection config. properties: xray_services: $ref: '#/components/schemas/XRayServicesList' @@ -27619,20 +27665,20 @@ components: type: string type: object XRayServicesIncludeAll: - description: Include all services + description: Include all services. properties: include_all: - description: Include all services + description: Include all services. example: false type: boolean required: - include_all XRayServicesIncludeOnly: - description: Include only these services + description: Include only these services. Defaults to `[]`. nullable: true properties: include_only: - description: Include only these services + description: Include only these services. example: - AWS/AppSync items: @@ -27642,7 +27688,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' @@ -32911,7 +32957,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 @@ -32936,7 +32983,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: @@ -32971,12 +33018,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' @@ -32998,11 +33045,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' @@ -33028,11 +33075,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' @@ -33065,7 +33112,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: @@ -33091,7 +33138,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: @@ -33116,7 +33163,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/api/datadogV2/api_aws_integration.go b/api/datadogV2/api_aws_integration.go index 0a7cb8c6be0..554babae290 100644 --- a/api/datadogV2/api_aws_integration.go +++ b/api/datadogV2/api_aws_integration.go @@ -180,7 +180,7 @@ func (a *AWSIntegrationApi) CreateNewAWSExternalID(ctx _context.Context) (AWSNew } // DeleteAWSAccount Delete an AWS integration. -// Delete an AWS Account Integration Config +// Delete an AWS Account Integration Config by config ID. func (a *AWSIntegrationApi) DeleteAWSAccount(ctx _context.Context, awsAccountConfigId string) (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodDelete @@ -250,7 +250,7 @@ func (a *AWSIntegrationApi) DeleteAWSAccount(ctx _context.Context, awsAccountCon } // GetAWSAccount Get an AWS integration by config ID. -// Get an AWS Account Integration Config +// Get an AWS Account Integration Config by config ID. func (a *AWSIntegrationApi) GetAWSAccount(ctx _context.Context, awsAccountConfigId string) (AWSAccountResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet @@ -516,7 +516,7 @@ func (a *AWSIntegrationApi) ListAWSNamespaces(ctx _context.Context) (AWSNamespac } // UpdateAWSAccount Update an AWS integration. -// Update an AWS Account Integration Config +// Update an AWS Account Integration Config by config ID. func (a *AWSIntegrationApi) UpdateAWSAccount(ctx _context.Context, awsAccountConfigId string, body AWSAccountUpdateRequest) (AWSAccountResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPatch diff --git a/api/datadogV2/model_aws_account_create_request.go b/api/datadogV2/model_aws_account_create_request.go index 27e7ba8cc47..33697023137 100644 --- a/api/datadogV2/model_aws_account_create_request.go +++ b/api/datadogV2/model_aws_account_create_request.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountCreateRequest AWS Account Create Request body +// AWSAccountCreateRequest AWS Account Create Request body. type AWSAccountCreateRequest struct { - // AWS Account Create Request data + // AWS Account Create Request data. Data AWSAccountCreateRequestData `json:"data"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_account_create_request_attributes.go b/api/datadogV2/model_aws_account_create_request_attributes.go index 8a31606de0a..dec6b2a8fe8 100644 --- a/api/datadogV2/model_aws_account_create_request_attributes.go +++ b/api/datadogV2/model_aws_account_create_request_attributes.go @@ -10,25 +10,26 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountCreateRequestAttributes The AWS Account Integration Config to be created +// AWSAccountCreateRequestAttributes The AWS Account Integration Config to be created. type AWSAccountCreateRequestAttributes struct { - // Tags to apply to all metrics in the account + // Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`. AccountTags datadog.NullableList[string] `json:"account_tags,omitempty"` - // AWS Authentication config + // AWS Authentication config. AuthConfig AWSAuthConfig `json:"auth_config"` - // AWS Account ID + // AWS Account ID. AwsAccountId string `json:"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. AwsPartition AWSAccountPartition `json:"aws_partition"` - // AWS Regions to collect data from + // AWS Regions to collect data from. Defaults to `include_all`. AwsRegions *AWSRegions `json:"aws_regions,omitempty"` - // AWS Logs config + // AWS Logs Collection config. LogsConfig *AWSLogsConfig `json:"logs_config,omitempty"` - // AWS Metrics config + // AWS Metrics Collection config. MetricsConfig *AWSMetricsConfig `json:"metrics_config,omitempty"` - // AWS Resources config + // AWS Resources Collection config. ResourcesConfig *AWSResourcesConfig `json:"resources_config,omitempty"` - // AWS Traces config + // AWS Traces Collection config. TracesConfig *AWSTracesConfig `json:"traces_config,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` @@ -52,8 +53,6 @@ func NewAWSAccountCreateRequestAttributes(authConfig AWSAuthConfig, awsAccountId // but it doesn't guarantee that properties required by API are set. func NewAWSAccountCreateRequestAttributesWithDefaults() *AWSAccountCreateRequestAttributes { this := AWSAccountCreateRequestAttributes{} - var awsPartition AWSAccountPartition = AWSACCOUNTPARTITION_AWS - this.AwsPartition = awsPartition return &this } diff --git a/api/datadogV2/model_aws_account_create_request_data.go b/api/datadogV2/model_aws_account_create_request_data.go index 5e46f1c6439..6f4c0e1274d 100644 --- a/api/datadogV2/model_aws_account_create_request_data.go +++ b/api/datadogV2/model_aws_account_create_request_data.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountCreateRequestData AWS Account Create Request data +// AWSAccountCreateRequestData AWS Account Create Request data. type AWSAccountCreateRequestData struct { - // The AWS Account Integration Config to be created + // The AWS Account Integration Config to be created. Attributes AWSAccountCreateRequestAttributes `json:"attributes"` // AWS Account resource type. Type AWSAccountType `json:"type"` diff --git a/api/datadogV2/model_aws_account_partition.go b/api/datadogV2/model_aws_account_partition.go index 3bcc7beb3fc..c21d1287b34 100644 --- a/api/datadogV2/model_aws_account_partition.go +++ b/api/datadogV2/model_aws_account_partition.go @@ -10,7 +10,8 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountPartition AWS Account partition +// AWSAccountPartition 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. type AWSAccountPartition string // List of AWSAccountPartition. diff --git a/api/datadogV2/model_aws_account_response.go b/api/datadogV2/model_aws_account_response.go index 46efba9befc..6df232437fd 100644 --- a/api/datadogV2/model_aws_account_response.go +++ b/api/datadogV2/model_aws_account_response.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountResponse AWS Account response body +// AWSAccountResponse AWS Account response body. type AWSAccountResponse struct { - // AWS Account Response body + // AWS Account response data. Data AWSAccountResponseData `json:"data"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_account_response_attributes.go b/api/datadogV2/model_aws_account_response_attributes.go index b18d4873d8a..14df1938a44 100644 --- a/api/datadogV2/model_aws_account_response_attributes.go +++ b/api/datadogV2/model_aws_account_response_attributes.go @@ -11,29 +11,30 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountResponseAttributes The AWS Account Integration Config +// AWSAccountResponseAttributes AWS Account response attributes. type AWSAccountResponseAttributes struct { - // Tags to apply to all metrics in the account + // Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`. AccountTags datadog.NullableList[string] `json:"account_tags,omitempty"` - // AWS Authentication config + // AWS Authentication config. AuthConfig *AWSAuthConfig `json:"auth_config,omitempty"` - // AWS Account ID + // AWS Account ID. AwsAccountId string `json:"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. AwsPartition *AWSAccountPartition `json:"aws_partition,omitempty"` - // AWS Regions to collect data from + // AWS Regions to collect data from. Defaults to `include_all`. AwsRegions *AWSRegions `json:"aws_regions,omitempty"` - // Timestamp of when the account integration was created + // Timestamp of when the account integration was created. CreatedAt *time.Time `json:"created_at,omitempty"` - // AWS Logs config + // AWS Logs Collection config. LogsConfig *AWSLogsConfig `json:"logs_config,omitempty"` - // AWS Metrics config + // AWS Metrics Collection config. MetricsConfig *AWSMetricsConfig `json:"metrics_config,omitempty"` - // Timestamp of when the account integration was updated + // Timestamp of when the account integration was updated. ModifiedAt *time.Time `json:"modified_at,omitempty"` - // AWS Resources config + // AWS Resources Collection config. ResourcesConfig *AWSResourcesConfig `json:"resources_config,omitempty"` - // AWS Traces config + // AWS Traces Collection config. TracesConfig *AWSTracesConfig `json:"traces_config,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` @@ -47,8 +48,6 @@ type AWSAccountResponseAttributes struct { func NewAWSAccountResponseAttributes(awsAccountId string) *AWSAccountResponseAttributes { this := AWSAccountResponseAttributes{} this.AwsAccountId = awsAccountId - var awsPartition AWSAccountPartition = AWSACCOUNTPARTITION_AWS - this.AwsPartition = &awsPartition return &this } @@ -57,8 +56,6 @@ func NewAWSAccountResponseAttributes(awsAccountId string) *AWSAccountResponseAtt // but it doesn't guarantee that properties required by API are set. func NewAWSAccountResponseAttributesWithDefaults() *AWSAccountResponseAttributes { this := AWSAccountResponseAttributes{} - var awsPartition AWSAccountPartition = AWSACCOUNTPARTITION_AWS - this.AwsPartition = &awsPartition return &this } diff --git a/api/datadogV2/model_aws_account_response_data.go b/api/datadogV2/model_aws_account_response_data.go index de39dd08393..0b998fba517 100644 --- a/api/datadogV2/model_aws_account_response_data.go +++ b/api/datadogV2/model_aws_account_response_data.go @@ -10,11 +10,13 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountResponseData AWS Account Response body +// AWSAccountResponseData AWS Account response data. type AWSAccountResponseData struct { - // The AWS Account Integration Config + // AWS Account response attributes. Attributes *AWSAccountResponseAttributes `json:"attributes,omitempty"` - // 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 `json:"id"` // AWS Account resource type. Type AWSAccountType `json:"type"` diff --git a/api/datadogV2/model_aws_account_update_request.go b/api/datadogV2/model_aws_account_update_request.go index 44453ca1366..55e411ed331 100644 --- a/api/datadogV2/model_aws_account_update_request.go +++ b/api/datadogV2/model_aws_account_update_request.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountUpdateRequest AWS Account Update Request body +// AWSAccountUpdateRequest AWS Account Update Request body. type AWSAccountUpdateRequest struct { - // AWS Account Update Request data + // AWS Account Update Request data. Data AWSAccountUpdateRequestData `json:"data"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_account_update_request_attributes.go b/api/datadogV2/model_aws_account_update_request_attributes.go index 1246928fdf0..b66deae2db7 100644 --- a/api/datadogV2/model_aws_account_update_request_attributes.go +++ b/api/datadogV2/model_aws_account_update_request_attributes.go @@ -10,25 +10,26 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountUpdateRequestAttributes The AWS Account Integration Config to be updated +// AWSAccountUpdateRequestAttributes The AWS Account Integration Config to be updated. type AWSAccountUpdateRequestAttributes struct { - // Tags to apply to all metrics in the account + // Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`. AccountTags datadog.NullableList[string] `json:"account_tags,omitempty"` - // AWS Authentication config + // AWS Authentication config. AuthConfig *AWSAuthConfig `json:"auth_config,omitempty"` - // AWS Account ID + // AWS Account ID. AwsAccountId string `json:"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. AwsPartition *AWSAccountPartition `json:"aws_partition,omitempty"` - // AWS Regions to collect data from + // AWS Regions to collect data from. Defaults to `include_all`. AwsRegions *AWSRegions `json:"aws_regions,omitempty"` - // AWS Logs config + // AWS Logs Collection config. LogsConfig *AWSLogsConfig `json:"logs_config,omitempty"` - // AWS Metrics config + // AWS Metrics Collection config. MetricsConfig *AWSMetricsConfig `json:"metrics_config,omitempty"` - // AWS Resources config + // AWS Resources Collection config. ResourcesConfig *AWSResourcesConfig `json:"resources_config,omitempty"` - // AWS Traces config + // AWS Traces Collection config. TracesConfig *AWSTracesConfig `json:"traces_config,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` @@ -42,8 +43,6 @@ type AWSAccountUpdateRequestAttributes struct { func NewAWSAccountUpdateRequestAttributes(awsAccountId string) *AWSAccountUpdateRequestAttributes { this := AWSAccountUpdateRequestAttributes{} this.AwsAccountId = awsAccountId - var awsPartition AWSAccountPartition = AWSACCOUNTPARTITION_AWS - this.AwsPartition = &awsPartition return &this } @@ -52,8 +51,6 @@ func NewAWSAccountUpdateRequestAttributes(awsAccountId string) *AWSAccountUpdate // but it doesn't guarantee that properties required by API are set. func NewAWSAccountUpdateRequestAttributesWithDefaults() *AWSAccountUpdateRequestAttributes { this := AWSAccountUpdateRequestAttributes{} - var awsPartition AWSAccountPartition = AWSACCOUNTPARTITION_AWS - this.AwsPartition = &awsPartition return &this } diff --git a/api/datadogV2/model_aws_account_update_request_data.go b/api/datadogV2/model_aws_account_update_request_data.go index 2d30efcdcc1..05a37880307 100644 --- a/api/datadogV2/model_aws_account_update_request_data.go +++ b/api/datadogV2/model_aws_account_update_request_data.go @@ -10,11 +10,13 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountUpdateRequestData AWS Account Update Request data +// AWSAccountUpdateRequestData AWS Account Update Request data. type AWSAccountUpdateRequestData struct { - // The AWS Account Integration Config to be updated + // The AWS Account Integration Config to be updated. Attributes AWSAccountUpdateRequestAttributes `json:"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. Id *string `json:"id,omitempty"` // AWS Account resource type. Type AWSAccountType `json:"type"` diff --git a/api/datadogV2/model_aws_accounts_response.go b/api/datadogV2/model_aws_accounts_response.go index db9ada82aa5..3eba88d43c1 100644 --- a/api/datadogV2/model_aws_accounts_response.go +++ b/api/datadogV2/model_aws_accounts_response.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAccountsResponse AWS Accounts response body +// AWSAccountsResponse AWS Accounts response body. type AWSAccountsResponse struct { - // List of AWS Account Integration Configs + // List of AWS Account Integration Configs. Data []AWSAccountResponseData `json:"data"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_auth_config.go b/api/datadogV2/model_aws_auth_config.go index 37187c14616..9993441418d 100644 --- a/api/datadogV2/model_aws_auth_config.go +++ b/api/datadogV2/model_aws_auth_config.go @@ -8,7 +8,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAuthConfig - AWS Authentication config +// AWSAuthConfig - AWS Authentication config. type AWSAuthConfig struct { AWSAuthConfigKeys *AWSAuthConfigKeys AWSAuthConfigRole *AWSAuthConfigRole diff --git a/api/datadogV2/model_aws_auth_config_keys.go b/api/datadogV2/model_aws_auth_config_keys.go index 7de951222a4..04c62f4fcda 100644 --- a/api/datadogV2/model_aws_auth_config_keys.go +++ b/api/datadogV2/model_aws_auth_config_keys.go @@ -10,11 +10,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAuthConfigKeys AWS Authentication config for key-based account +// AWSAuthConfigKeys AWS Authentication config to integrate your account using an access key pair. type AWSAuthConfigKeys struct { - // AWS Access Key ID + // AWS Access Key ID. AccessKeyId string `json:"access_key_id"` - // AWS Secret Access Key + // AWS Secret Access Key. SecretAccessKey *string `json:"secret_access_key,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_auth_config_role.go b/api/datadogV2/model_aws_auth_config_role.go index c465b7e85b5..b9f0b58e674 100644 --- a/api/datadogV2/model_aws_auth_config_role.go +++ b/api/datadogV2/model_aws_auth_config_role.go @@ -10,11 +10,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSAuthConfigRole AWS Authentication config for role-based account +// AWSAuthConfigRole AWS Authentication config to integrate your account using an IAM role. type AWSAuthConfigRole struct { - // AWS IAM External ID for associated role + // AWS IAM External ID for associated role. ExternalId *string `json:"external_id,omitempty"` - // AWS IAM Role name + // AWS IAM Role name. RoleName string `json:"role_name"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_lambda_forwarder_config.go b/api/datadogV2/model_aws_lambda_forwarder_config.go index 634d728fdce..912f4cdc103 100644 --- a/api/datadogV2/model_aws_lambda_forwarder_config.go +++ b/api/datadogV2/model_aws_lambda_forwarder_config.go @@ -8,11 +8,13 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSLambdaForwarderConfig AWS Lambda forwarder +// AWSLambdaForwarderConfig Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing +// and new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration. type AWSLambdaForwarderConfig struct { - // List of Datadog Lambda Log Forwarder ARNs + // List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`. Lambdas []string `json:"lambdas,omitempty"` - // List of AWS services that will send logs to the Datadog Lambda Log Forwarder + // List of service IDs set to enable automatic log collection. Discover the list of available services with the + // [Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint. Sources []string `json:"sources,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_logs_config.go b/api/datadogV2/model_aws_logs_config.go index d323364340e..6cbb92d907a 100644 --- a/api/datadogV2/model_aws_logs_config.go +++ b/api/datadogV2/model_aws_logs_config.go @@ -8,9 +8,10 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSLogsConfig AWS Logs config +// AWSLogsConfig AWS Logs Collection config. type AWSLogsConfig struct { - // AWS Lambda forwarder + // Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing + // and new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration. LambdaForwarder *AWSLambdaForwarderConfig `json:"lambda_forwarder,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_metrics_config.go b/api/datadogV2/model_aws_metrics_config.go index 13cbe121a5e..ada2fd3851e 100644 --- a/api/datadogV2/model_aws_metrics_config.go +++ b/api/datadogV2/model_aws_metrics_config.go @@ -8,19 +8,19 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSMetricsConfig AWS Metrics config +// AWSMetricsConfig AWS Metrics Collection config. type AWSMetricsConfig struct { - // Enable EC2 automute for AWS metrics + // Enable EC2 automute for AWS metrics. Defaults to `true`. AutomuteEnabled *bool `json:"automute_enabled,omitempty"` - // Enable CloudWatch alarms collection + // Enable CloudWatch alarms collection. Defaults to `false`. CollectCloudwatchAlarms *bool `json:"collect_cloudwatch_alarms,omitempty"` - // Enable custom metrics collection + // Enable custom metrics collection. Defaults to `false`. CollectCustomMetrics *bool `json:"collect_custom_metrics,omitempty"` - // Enable AWS metrics collection + // Enable AWS metrics collection. Defaults to `true`. Enabled *bool `json:"enabled,omitempty"` - // AWS Metrics namespace filters + // AWS Metrics namespace filters. Defaults to `exclude_only`. NamespaceFilters *AWSNamespaceFilters `json:"namespace_filters,omitempty"` - // AWS Metrics tag filters list + // AWS Metrics collection tag filters list. Defaults to `[]`. TagFilters []AWSNamespaceTagFilter `json:"tag_filters,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_namespace_filters.go b/api/datadogV2/model_aws_namespace_filters.go index 1af49596957..9bb2551a690 100644 --- a/api/datadogV2/model_aws_namespace_filters.go +++ b/api/datadogV2/model_aws_namespace_filters.go @@ -8,7 +8,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespaceFilters - AWS Metrics namespace filters +// AWSNamespaceFilters - AWS Metrics namespace filters. Defaults to `exclude_only`. type AWSNamespaceFilters struct { AWSNamespaceFiltersExcludeOnly *AWSNamespaceFiltersExcludeOnly AWSNamespaceFiltersIncludeOnly *AWSNamespaceFiltersIncludeOnly diff --git a/api/datadogV2/model_aws_namespace_filters_exclude_only.go b/api/datadogV2/model_aws_namespace_filters_exclude_only.go index 72dda110d38..c25e23d2814 100644 --- a/api/datadogV2/model_aws_namespace_filters_exclude_only.go +++ b/api/datadogV2/model_aws_namespace_filters_exclude_only.go @@ -10,9 +10,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespaceFiltersExcludeOnly Exclude only these namespaces +// AWSNamespaceFiltersExcludeOnly 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 AWS CloudWatch costs from `GetMetricData` API calls. type AWSNamespaceFiltersExcludeOnly struct { - // Exclude only these namespaces + // 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 AWS CloudWatch costs from `GetMetricData` API calls. ExcludeOnly []string `json:"exclude_only"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_namespace_filters_include_only.go b/api/datadogV2/model_aws_namespace_filters_include_only.go index 0c7d8c99712..aecdd9d6d2f 100644 --- a/api/datadogV2/model_aws_namespace_filters_include_only.go +++ b/api/datadogV2/model_aws_namespace_filters_include_only.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespaceFiltersIncludeOnly Include only these namespaces +// AWSNamespaceFiltersIncludeOnly Include only these namespaces. type AWSNamespaceFiltersIncludeOnly struct { - // Include only these namespaces + // Include only these namespaces. IncludeOnly []string `json:"include_only"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_namespace_tag_filter.go b/api/datadogV2/model_aws_namespace_tag_filter.go index e4a81d19688..5faf5261faf 100644 --- a/api/datadogV2/model_aws_namespace_tag_filter.go +++ b/api/datadogV2/model_aws_namespace_tag_filter.go @@ -8,11 +8,15 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespaceTagFilter AWS Metrics tag filters +// AWSNamespaceTagFilter AWS Metrics Collection tag filters list. Defaults to `[]`. +// The array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service. +// Wildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported. +// For EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. +// For example, `env:production,instance-type:c?.*,!region:us-east-1`. type AWSNamespaceTagFilter struct { - // The AWS Namespace to apply the tag filters against + // The AWS service for which the tag filters defined in `tags` will be applied. Namespace *string `json:"namespace,omitempty"` - // The tags to filter based on + // The AWS resource tags to filter on for the service specified by `namespace`. Tags datadog.NullableList[string] `json:"tags,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_namespaces_response.go b/api/datadogV2/model_aws_namespaces_response.go index 98814a7e913..64fe50f1a91 100644 --- a/api/datadogV2/model_aws_namespaces_response.go +++ b/api/datadogV2/model_aws_namespaces_response.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespacesResponse AWS Namespaces response body +// AWSNamespacesResponse AWS Namespaces response body. type AWSNamespacesResponse struct { - // AWS Namespaces response body + // AWS Namespaces response data. Data AWSNamespacesResponseData `json:"data"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_namespaces_response_attributes.go b/api/datadogV2/model_aws_namespaces_response_attributes.go index eb57533bf02..79094f1616e 100644 --- a/api/datadogV2/model_aws_namespaces_response_attributes.go +++ b/api/datadogV2/model_aws_namespaces_response_attributes.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespacesResponseAttributes AWS Namespaces response body +// AWSNamespacesResponseAttributes AWS Namespaces response attributes. type AWSNamespacesResponseAttributes struct { - // AWS CloudWatch namespace + // AWS CloudWatch namespace. Namespaces []string `json:"namespaces"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_namespaces_response_data.go b/api/datadogV2/model_aws_namespaces_response_data.go index 20d2a55652d..29eb3fbe745 100644 --- a/api/datadogV2/model_aws_namespaces_response_data.go +++ b/api/datadogV2/model_aws_namespaces_response_data.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNamespacesResponseData AWS Namespaces response body +// AWSNamespacesResponseData AWS Namespaces response data. type AWSNamespacesResponseData struct { - // AWS Namespaces response body + // AWS Namespaces response attributes. Attributes *AWSNamespacesResponseAttributes `json:"attributes,omitempty"` // The `AWSNamespacesResponseData` `id`. Id string `json:"id"` diff --git a/api/datadogV2/model_aws_new_external_id_response.go b/api/datadogV2/model_aws_new_external_id_response.go index 1f7624cc97a..5df576f8fb9 100644 --- a/api/datadogV2/model_aws_new_external_id_response.go +++ b/api/datadogV2/model_aws_new_external_id_response.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNewExternalIDResponse AWS External ID response body +// AWSNewExternalIDResponse AWS External ID response body. type AWSNewExternalIDResponse struct { - // AWS External ID response body + // AWS External ID response body. Data AWSNewExternalIDResponseData `json:"data"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_new_external_id_response_attributes.go b/api/datadogV2/model_aws_new_external_id_response_attributes.go index 5c3c44f266c..89756747f69 100644 --- a/api/datadogV2/model_aws_new_external_id_response_attributes.go +++ b/api/datadogV2/model_aws_new_external_id_response_attributes.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNewExternalIDResponseAttributes AWS External ID response body +// AWSNewExternalIDResponseAttributes AWS External ID response body. type AWSNewExternalIDResponseAttributes struct { - // AWS IAM External ID for associated role + // AWS IAM External ID for associated role. ExternalId string `json:"external_id"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_new_external_id_response_data.go b/api/datadogV2/model_aws_new_external_id_response_data.go index 9a97ea6b4c0..a8ce9dadbbd 100644 --- a/api/datadogV2/model_aws_new_external_id_response_data.go +++ b/api/datadogV2/model_aws_new_external_id_response_data.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSNewExternalIDResponseData AWS External ID response body +// AWSNewExternalIDResponseData AWS External ID response body. type AWSNewExternalIDResponseData struct { - // AWS External ID response body + // AWS External ID response body. Attributes *AWSNewExternalIDResponseAttributes `json:"attributes,omitempty"` // The `AWSNewExternalIDResponseData` `id`. Id string `json:"id"` diff --git a/api/datadogV2/model_aws_regions.go b/api/datadogV2/model_aws_regions.go index 192f771388a..ec8052b097c 100644 --- a/api/datadogV2/model_aws_regions.go +++ b/api/datadogV2/model_aws_regions.go @@ -8,7 +8,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSRegions - AWS Regions to collect data from +// AWSRegions - AWS Regions to collect data from. Defaults to `include_all`. type AWSRegions struct { AWSRegionsIncludeAll *AWSRegionsIncludeAll AWSRegionsIncludeOnly *AWSRegionsIncludeOnly diff --git a/api/datadogV2/model_aws_regions_include_all.go b/api/datadogV2/model_aws_regions_include_all.go index f135e379766..6bd30cdb418 100644 --- a/api/datadogV2/model_aws_regions_include_all.go +++ b/api/datadogV2/model_aws_regions_include_all.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSRegionsIncludeAll Include all regions +// AWSRegionsIncludeAll Include all regions. Defaults to `true`. type AWSRegionsIncludeAll struct { - // Include all regions + // Include all regions. IncludeAll bool `json:"include_all"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_regions_include_only.go b/api/datadogV2/model_aws_regions_include_only.go index 48086b79986..2dda9f3ae01 100644 --- a/api/datadogV2/model_aws_regions_include_only.go +++ b/api/datadogV2/model_aws_regions_include_only.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSRegionsIncludeOnly Include only these regions +// AWSRegionsIncludeOnly Include only these regions. type AWSRegionsIncludeOnly struct { - // Include only these regions + // Include only these regions. IncludeOnly []string `json:"include_only"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_resources_config.go b/api/datadogV2/model_aws_resources_config.go index 1fccf6099ff..3a4d322e2f7 100644 --- a/api/datadogV2/model_aws_resources_config.go +++ b/api/datadogV2/model_aws_resources_config.go @@ -8,11 +8,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSResourcesConfig AWS Resources config +// AWSResourcesConfig AWS Resources Collection config. type AWSResourcesConfig struct { - // 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. Defaults to `false`. Requires `extended_collection` to be set to `true`. CloudSecurityPostureManagementCollection *bool `json:"cloud_security_posture_management_collection,omitempty"` - // 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. Defaults to `true`. Required for `cloud_security_posture_management_collection`. ExtendedCollection *bool `json:"extended_collection,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_aws_traces_config.go b/api/datadogV2/model_aws_traces_config.go index 319cb1a4363..8dbca4b8eb4 100644 --- a/api/datadogV2/model_aws_traces_config.go +++ b/api/datadogV2/model_aws_traces_config.go @@ -8,9 +8,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// AWSTracesConfig AWS Traces config +// AWSTracesConfig AWS Traces Collection config. type AWSTracesConfig struct { - // AWS X-Ray services to collect traces from + // AWS X-Ray services to collect traces from. Defaults to `include_only`. XrayServices *XRayServicesList `json:"xray_services,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_x_ray_services_include_all.go b/api/datadogV2/model_x_ray_services_include_all.go index 89dbdaf70a2..992deb31e26 100644 --- a/api/datadogV2/model_x_ray_services_include_all.go +++ b/api/datadogV2/model_x_ray_services_include_all.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// XRayServicesIncludeAll Include all services +// XRayServicesIncludeAll Include all services. type XRayServicesIncludeAll struct { - // Include all services + // Include all services. IncludeAll bool `json:"include_all"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_x_ray_services_include_only.go b/api/datadogV2/model_x_ray_services_include_only.go index 47fc8e80fed..0665b9bbf8b 100644 --- a/api/datadogV2/model_x_ray_services_include_only.go +++ b/api/datadogV2/model_x_ray_services_include_only.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// XRayServicesIncludeOnly Include only these services +// XRayServicesIncludeOnly Include only these services. Defaults to `[]`. type XRayServicesIncludeOnly struct { - // Include only these services + // Include only these services. IncludeOnly []string `json:"include_only"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_x_ray_services_list.go b/api/datadogV2/model_x_ray_services_list.go index 3063c4ab99f..2f29c301586 100644 --- a/api/datadogV2/model_x_ray_services_list.go +++ b/api/datadogV2/model_x_ray_services_list.go @@ -8,7 +8,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// XRayServicesList - AWS X-Ray services to collect traces from +// XRayServicesList - AWS X-Ray services to collect traces from. Defaults to `include_only`. type XRayServicesList struct { XRayServicesIncludeAll *XRayServicesIncludeAll XRayServicesIncludeOnly *XRayServicesIncludeOnly