AWS credentials API - PUT credentials

Updates an existing AWS credentials configuration. Check the connection status for these credentials after 10 minutes with the GET credentials request.

If a credentials configuration with the specified ID doesn’t exist, a new configuration is created.

The request consumes and produces an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials/{id}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the AWS credentials configuration to be updated.

 path required
body AwsCredentialsConfig

The JSON body of the request. Contains updated parameters of the AWS credentials configuration.

 body optional

Body format

The AwsCredentialsConfig object

Configuration of an AWS credentials.

Element Type Description Required
label string

The name of the credentials.

 required
partitionType string

The type of the AWS partition.

 required
authenticationData AwsAuthenticationData required
taggedOnly boolean

Monitor only resources which have specified AWS tags (true) or all resources (false).

 required
tagsToMonitor AwsConfigTag[]

A list of AWS tags to be monitored.

You can specify up to 10 tags.

Only applicable when the taggedOnly parameter is set to true.

 required
supportingServicesToMonitor AwsSupportingServiceConfig[]

A list of supporting services to be monitored.

 optional

The AwsSupportingServiceConfig object

A supporting service to be monitored.

Element Type Description Required
name string

The name of the supporting service.

 required
monitoredMetrics AwsSupportingServiceMetric[]

A list of metrics to be monitored for this service.

 required

The AwsSupportingServiceMetric object

A metric of supporting service to be monitored.

Element Type Description Required
name string

The name of the metric of the supporting service.

 required
statistic string

The statistic (aggregation) to be used for the metric. AVG_MIN_MAX value is 3 statistics at once: AVERAGE, MINIMUM and MAXIMUM

 required
dimensions string[]

A list of metric's dimensions names.

 required

The AwsConfigTag object

An AWS tag of the resource to be monitored.

Element Type Description Required
name string

The key of the AWS tag.

 required
value string

The value of the AWS tag.

 required

The AwsAuthenticationData object

A credentials for the AWS authentication.

Element Type Description Required
type string

The type of the authentication: role-based or key-based.

 required
keyBasedAuthentication KeyBasedAuthentication optional
roleBasedAuthentication RoleBasedAuthentication optional

The RoleBasedAuthentication object

The credentials for the role-based authentication.

Element Type Description Required
iamRole string

The IAM role to be used by Dynatrace to get monitoring data.

 required
accountId string

The ID of the Amazon account.

 required

The KeyBasedAuthentication object

The credentials for the key-based authentication.

Element Type Description Required
accessKey string

The ID of the access key.

 required
secretKey string

The secret access key.

 required

Response

Response codes

Code Description
201

Success. The new AWS credentials configuration has been created. The response body contains the ID of the configuration.

Check the connection status for these credentials after 10 minutes with the GET /aws/credentials/{id} request.
204

Success. The AWS credentials configuration has been updated. Response doesn't have a body.

Check the connection status for these credentials after 10 minutes with the GET /aws/credentials/{id} request.
400

Failed. The input is invalid.

Response body

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.
name string

The name of the Dynatrace entity.
description string

A short description of the Dynatrace entity.

GET the external ID token

Gets the external ID token for setting an IAM role.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/iamExternalId
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
200

Success

Response body

The AwsIamToken object

The external ID token for setting IAM Role in AWS.

Element Type Description
token string

The external ID token for setting IAM Role in AWS.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials/{id}/validator
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

Validated. The submitted configuration is valid. Response doesn't have a body.
400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.