• Home
  • Dynatrace API
  • Configuration
  • AWS credentials
  • GET credentials

AWS credentials API - GET credentials

Gets the configuration of the specified AWS credentials.

The request produces an application/json payload.

GETManaged 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 Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the specified AWS credentials configuration.

pathoptional

Response

Response codes

CodeTypeDescription
200AwsCredentialsConfig

Success

Response body objects

The AwsCredentialsConfig object

Configuration of an AWS credentials.

ElementTypeDescriptionRequired
metadataConfigurationMetadata

Metadata useful for debugging

optional
idstring

The unique ID of the credentials.

optional
connectionStatusstring

The status of the connection to the AWS environment.

  • CONNECTED: There was a connection within last 10 minutes.
  • DISCONNECTED: A problem occurred with establishing connection using these credentials. Check whether the data is correct.
  • UNINITIALIZED: The successful connection has never been established for these credentials.
The element can hold these values
  • CONNECTED
  • DISCONNECTED
  • UNINITIALIZED
optional
labelstring

The name of the credentials.

required
partitionTypestring

The type of the AWS partition.

The element can hold these values
  • AWS_CN
  • AWS_DEFAULT
  • AWS_US_GOV
required
authenticationDataAwsAuthenticationData

A credentials for the AWS authentication.

required
taggedOnlyboolean

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

required
tagsToMonitorAwsConfigTag[]

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
supportingServicesToMonitorAwsSupportingServiceConfig[]

A list of supporting services to be monitored.

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional
clusterVersionstring

Dynatrace version.

optional

The AwsAuthenticationData object

A credentials for the AWS authentication.

ElementTypeDescriptionRequired
typestring

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

The element can hold these values
  • KEYS
  • ROLE
required
keyBasedAuthenticationKeyBasedAuthentication

The credentials for the key-based authentication.

optional
roleBasedAuthenticationRoleBasedAuthentication

The credentials for the role-based authentication.

optional

The KeyBasedAuthentication object

The credentials for the key-based authentication.

ElementTypeDescriptionRequired
accessKeystring

The ID of the access key.

required
secretKeystring

The secret access key.

required

The RoleBasedAuthentication object

The credentials for the role-based authentication.

ElementTypeDescriptionRequired
iamRolestring

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

required
accountIdstring

The ID of the Amazon account.

required
externalIdstring

The external ID token for setting an IAM role.

You can obtain it with the GET /aws/iamExternalId request.

optional

The AwsConfigTag object

An AWS tag of the resource to be monitored.

ElementTypeDescriptionRequired
namestring

The key of the AWS tag.

required
valuestring

The value of the AWS tag.

required

The AwsSupportingServiceConfig object

A supporting service to be monitored.

ElementTypeDescriptionRequired
namestring

The name of the supporting service.

required
monitoredMetricsAwsSupportingServiceMetric[]

A list of metrics to be monitored for this service. If the list is null then recommended list of metrics for this service will be monitored.

optional

The AwsSupportingServiceMetric object

A metric of supporting service to be monitored.

ElementTypeDescriptionRequired
namestring

The name of the metric of the supporting service.

required
statisticstring

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

The element can hold these values
  • AVERAGE
  • AVG_MIN_MAX
  • MAXIMUM
  • MINIMUM
  • SAMPLE_COUNT
  • SUM
required
dimensionsstring[]

A list of metric's dimensions names.

required

Response body JSON model

json
{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1"
  },
  "id": "string",
  "connectionStatus": "CONNECTED",
  "label": "string",
  "partitionType": "AWS_CN",
  "authenticationData": {
    "type": "KEYS",
    "keyBasedAuthentication": {
      "accessKey": "string",
      "secretKey": "string"
    },
    "roleBasedAuthentication": {
      "iamRole": "string",
      "accountId": "string",
      "externalId": "string"
    }
  },
  "taggedOnly": true,
  "tagsToMonitor": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "supportingServicesToMonitor": [
    {
      "name": "string",
      "monitoredMetrics": [
        {
          "name": "string",
          "statistic": "AVERAGE",
          "dimensions": [
            "string"
          ]
        }
      ]
    }
  ]
}
Related topics
  • Set up Dynatrace on Amazon Web Services

    Learn how to set up and configure Dynatrace on AWS.