AWS credentials API - GET credentials

Gets the configuration of the specified AWS credentials.

The request produces an application/json payload.

GET	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}

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.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the specified AWS credentials configuration.	path	required

Response format

Response parameters JSON model

The AwsCredentialsConfig object

Configuration of an AWS credentials.

Element	Type	Description
metadata	ConfigurationMetadata
id	string	The unique ID of the credentials.
connectionStatus	string	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 connectionStatus element can hold these values.
label	string	The name of the credentials.
partitionType	string	The type of the AWS partition. The partitionType element can hold these values.
authenticationData	AwsAuthenticationData
taggedOnly	boolean	Monitor only resources which have specified AWS tags (`true`) or all resources (`false`).
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`.
supportingServicesToMonitor	AwsSupportingServiceConfig[]	A list of supporting services to be monitored.

The AwsSupportingServiceConfig object

A supporting service to be monitored.

Element	Type	Description
name	string	The name of the supporting service.
monitoredMetrics	AwsSupportingServiceMetric[]	A list of metrics to be monitored for this service.

The AwsSupportingServiceMetric object

A metric of supporting service to be monitored.

Element	Type	Description
name	string	The name of the metric of the supporting service.
statistic	string	The statistic (aggregation) to be used for the metric. AVG_MIN_MAX value is 3 statistics at once: AVERAGE, MINIMUM and MAXIMUM The statistic element can hold these values.
dimensions	string[]	A list of metric's dimensions names.

The AwsConfigTag object

An AWS tag of the resource to be monitored.

Element	Type	Description
name	string	The key of the AWS tag.
value	string	The value of the AWS tag.

The AwsAuthenticationData object

A credentials for the AWS authentication.

Element	Type	Description
type	string	The type of the authentication: role-based or key-based. The type element can hold these values.
keyBasedAuthentication	KeyBasedAuthentication
roleBasedAuthentication	RoleBasedAuthentication

The RoleBasedAuthentication object

The credentials for the role-based authentication.

Element Type Description

iamRole

string

Element	Type	Description
iamRole	string	The IAM role to be used by Dynatrace to get monitoring data.
accountId	string	The ID of the Amazon account.
externalId	string	The external ID token for setting an IAM role. You can obtain it with the `GET /aws/iamExternalId` request.

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

accountId

string

The ID of the Amazon account.

externalId

string

The external ID token for setting an IAM role.

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

The KeyBasedAuthentication object

The credentials for the key-based authentication.

Element	Type	Description
accessKey	string	The ID of the access key.
secretKey	string	The secret access key.

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.
currentConfigurationVersions	string[]	A Sorted list of string version numbers of the configuration.
clusterVersion	string	Dynatrace server version.

    
{
  "metadata": {
    "configurationVersions": [
      "integer"
    ],
    "currentConfigurationVersions": [
      "string"
    ],
    "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"
          ]
        }
      ]
    }
  ]
}

Possible values

Possible values for the statistic element in the AwsSupportingServiceMetric object:

AVERAGE
AVG_MIN_MAX
MAXIMUM
MINIMUM
SAMPLE_COUNT
SUM

Possible values for the type element in the AwsAuthenticationData object:

KEYS
ROLE

Possible values for the partitionType element in the AwsCredentialsConfig object:

AWS_CN
AWS_DEFAULT
AWS_US_GOV

Possible values for the connectionStatus element in the AwsCredentialsConfig object:

CONNECTED
DISCONNECTED
UNINITIALIZED