Skip to content

Commit fd9e312

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
fix(aws): mark v1 endpoints which have v2 replacement as deprecated (#977)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 30cb747 commit fd9e312

File tree

4 files changed

+49
-33
lines changed

4 files changed

+49
-33
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,20 @@ components:
6464
additionalProperties:
6565
description: A list of additional properties.
6666
type: boolean
67-
description: 'An object, (in the form `{"namespace1":true/false, "namespace2":true/false}`),
67+
description: 'An object (in the form `{"namespace1":true/false, "namespace2":true/false}`)
68+
containing user-supplied overrides
6869

69-
that enables or disables metric collection for specific AWS namespaces
70-
for this
70+
for AWS namespace metric collection. **Important**: This field only contains
71+
namespaces explicitly configured through API calls,
7172

72-
AWS account only.'
73+
not the comprehensive enabled or disabled status of all namespaces. If
74+
a namespace is absent from this field, it uses Datadog''s
75+
76+
internal defaults (all namespaces enabled by default, except `AWS/SQS`,
77+
`AWS/ElasticMapReduce`, and `AWS/Usage`).
78+
79+
For a complete view of all namespace statuses, use the V2 AWS Integration
80+
API instead.'
7381
example:
7482
auto_scaling: false
7583
opswork: false
@@ -28067,8 +28075,9 @@ paths:
2806728075
/api/v1/integration/aws:
2806828076
delete:
2806928077
deprecated: true
28070-
description: Delete a Datadog-AWS integration matching the specified `account_id`
28071-
and `role_name parameters`.
28078+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28079+
Delete a Datadog-AWS integration matching the specified `account_id` and `role_name
28080+
parameters`.'
2807228081
operationId: DeleteAWSAccount
2807328082
requestBody:
2807428083
content:
@@ -28114,7 +28123,8 @@ paths:
2811428123
- aws_configurations_manage
2811528124
get:
2811628125
deprecated: true
28117-
description: List all Datadog-AWS integrations available in your Datadog organization.
28126+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28127+
List all Datadog-AWS integrations available in your Datadog organization.'
2811828128
operationId: ListAWSAccounts
2811928129
parameters:
2812028130
- description: Only return AWS accounts that matches this `account_id`.
@@ -28165,7 +28175,8 @@ paths:
2816528175
- aws_configuration_read
2816628176
post:
2816728177
deprecated: true
28168-
description: 'Create a Datadog-Amazon Web Services integration.
28178+
description: '"**This endpoint is deprecated - use the V2 endpoints instead.**
28179+
Create a Datadog-Amazon Web Services integration.
2816928180

2817028181
Using the `POST` method updates your integration configuration
2817128182

@@ -28217,7 +28228,8 @@ paths:
2821728228
- aws_configurations_manage
2821828229
put:
2821928230
deprecated: true
28220-
description: Update a Datadog-Amazon Web Services integration.
28231+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28232+
Update a Datadog-Amazon Web Services integration.'
2822128233
operationId: UpdateAWSAccount
2822228234
parameters:
2822328235
- description: Only return AWS accounts that matches this `account_id`.
@@ -28287,8 +28299,9 @@ paths:
2828728299
/api/v1/integration/aws/available_namespace_rules:
2828828300
get:
2828928301
deprecated: true
28290-
description: List all namespace rules for a given Datadog-AWS integration. This
28291-
endpoint takes no arguments.
28302+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28303+
List all namespace rules for a given Datadog-AWS integration. This endpoint
28304+
takes no arguments.'
2829228305
operationId: ListAvailableAWSNamespaces
2829328306
responses:
2829428307
'200':
@@ -28563,8 +28576,8 @@ paths:
2856328576
/api/v1/integration/aws/generate_new_external_id:
2856428577
put:
2856528578
deprecated: true
28566-
description: Generate a new AWS external ID for a given AWS account ID and role
28567-
name pair.
28579+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28580+
Generate a new AWS external ID for a given AWS account ID and role name pair.'
2856828581
operationId: CreateNewAWSExternalID
2856928582
requestBody:
2857028583
content:
@@ -28791,9 +28804,10 @@ paths:
2879128804
/api/v1/integration/aws/logs/services:
2879228805
get:
2879328806
deprecated: true
28794-
description: Get the list of current AWS services that Datadog offers automatic
28795-
log collection. Use returned service IDs with the services parameter for the
28796-
Enable an AWS service log collection API endpoint.
28807+
description: '**This endpoint is deprecated - use the V2 endpoint instead.**
28808+
Get the list of current AWS services that Datadog offers automatic log collection.
28809+
Use returned service IDs with the services parameter for the Enable an AWS
28810+
service log collection API endpoint.'
2879728811
operationId: ListAWSLogsServices
2879828812
responses:
2879928813
'200':

src/datadogV1/api/api_aws_integration.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ impl AWSIntegrationAPI {
236236
Self { config, client }
237237
}
238238

239-
/// Create a Datadog-Amazon Web Services integration.
239+
/// "**This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration.
240240
/// Using the `POST` method updates your integration configuration
241241
/// by adding your new configuration to the existing one in your Datadog organization.
242242
/// A unique AWS Account ID for role based authentication.
@@ -261,7 +261,7 @@ impl AWSIntegrationAPI {
261261
}
262262
}
263263

264-
/// Create a Datadog-Amazon Web Services integration.
264+
/// "**This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration.
265265
/// Using the `POST` method updates your integration configuration
266266
/// by adding your new configuration to the existing one in your Datadog organization.
267267
/// A unique AWS Account ID for role based authentication.
@@ -707,7 +707,7 @@ impl AWSIntegrationAPI {
707707
}
708708
}
709709

710-
/// Generate a new AWS external ID for a given AWS account ID and role name pair.
710+
/// **This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair.
711711
pub async fn create_new_aws_external_id(
712712
&self,
713713
body: crate::datadogV1::model::AWSAccount,
@@ -729,7 +729,7 @@ impl AWSIntegrationAPI {
729729
}
730730
}
731731

732-
/// Generate a new AWS external ID for a given AWS account ID and role name pair.
732+
/// **This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair.
733733
pub async fn create_new_aws_external_id_with_http_info(
734734
&self,
735735
body: crate::datadogV1::model::AWSAccount,
@@ -861,7 +861,7 @@ impl AWSIntegrationAPI {
861861
}
862862
}
863863

864-
/// Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
864+
/// **This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
865865
pub async fn delete_aws_account(
866866
&self,
867867
body: crate::datadogV1::model::AWSAccountDeleteRequest,
@@ -883,7 +883,7 @@ impl AWSIntegrationAPI {
883883
}
884884
}
885885

886-
/// Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
886+
/// **This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
887887
pub async fn delete_aws_account_with_http_info(
888888
&self,
889889
body: crate::datadogV1::model::AWSAccountDeleteRequest,
@@ -1326,7 +1326,7 @@ impl AWSIntegrationAPI {
13261326
}
13271327
}
13281328

1329-
/// List all Datadog-AWS integrations available in your Datadog organization.
1329+
/// **This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization.
13301330
pub async fn list_aws_accounts(
13311331
&self,
13321332
params: ListAWSAccountsOptionalParams,
@@ -1346,7 +1346,7 @@ impl AWSIntegrationAPI {
13461346
}
13471347
}
13481348

1349-
/// List all Datadog-AWS integrations available in your Datadog organization.
1349+
/// **This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization.
13501350
pub async fn list_aws_accounts_with_http_info(
13511351
&self,
13521352
params: ListAWSAccountsOptionalParams,
@@ -1666,7 +1666,7 @@ impl AWSIntegrationAPI {
16661666
}
16671667
}
16681668

1669-
/// List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
1669+
/// **This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
16701670
pub async fn list_available_aws_namespaces(
16711671
&self,
16721672
) -> Result<Vec<String>, datadog::Error<ListAvailableAWSNamespacesError>> {
@@ -1684,7 +1684,7 @@ impl AWSIntegrationAPI {
16841684
}
16851685
}
16861686

1687-
/// List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
1687+
/// **This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
16881688
pub async fn list_available_aws_namespaces_with_http_info(
16891689
&self,
16901690
) -> Result<
@@ -1767,7 +1767,7 @@ impl AWSIntegrationAPI {
17671767
}
17681768
}
17691769

1770-
/// Update a Datadog-Amazon Web Services integration.
1770+
/// **This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration.
17711771
pub async fn update_aws_account(
17721772
&self,
17731773
body: crate::datadogV1::model::AWSAccount,
@@ -1790,7 +1790,7 @@ impl AWSIntegrationAPI {
17901790
}
17911791
}
17921792

1793-
/// Update a Datadog-Amazon Web Services integration.
1793+
/// **This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration.
17941794
pub async fn update_aws_account_with_http_info(
17951795
&self,
17961796
body: crate::datadogV1::model::AWSAccount,

src/datadogV1/api/api_aws_logs_integration.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1043,7 +1043,7 @@ impl AWSLogsIntegrationAPI {
10431043
}
10441044
}
10451045

1046-
/// Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
1046+
/// **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
10471047
pub async fn list_aws_logs_services(
10481048
&self,
10491049
) -> Result<
@@ -1064,7 +1064,7 @@ impl AWSLogsIntegrationAPI {
10641064
}
10651065
}
10661066

1067-
/// Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
1067+
/// **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
10681068
pub async fn list_aws_logs_services_with_http_info(
10691069
&self,
10701070
) -> Result<

src/datadogV1/model/model_aws_account.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ pub struct AWSAccount {
1717
/// Your AWS Account ID without dashes.
1818
#[serde(rename = "account_id")]
1919
pub account_id: Option<String>,
20-
/// An object, (in the form `{"namespace1":true/false, "namespace2":true/false}`),
21-
/// that enables or disables metric collection for specific AWS namespaces for this
22-
/// AWS account only.
20+
/// An object (in the form `{"namespace1":true/false, "namespace2":true/false}`) containing user-supplied overrides
21+
/// for AWS namespace metric collection. **Important**: This field only contains namespaces explicitly configured through API calls,
22+
/// not the comprehensive enabled or disabled status of all namespaces. If a namespace is absent from this field, it uses Datadog's
23+
/// internal defaults (all namespaces enabled by default, except `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage`).
24+
/// For a complete view of all namespace statuses, use the V2 AWS Integration API instead.
2325
#[serde(rename = "account_specific_namespace_rules")]
2426
pub account_specific_namespace_rules: Option<std::collections::BTreeMap<String, bool>>,
2527
/// Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`.

0 commit comments

Comments
 (0)