• Home
  • 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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id}

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the specified AWS credentials configuration.

pathrequired

Response

Response codes

CodeTypeDescription
200AwsCredentialsConfig

Success

Response body objects

The AwsCredentialsConfig object

Configuration of an AWS credentials.

ElementTypeDescription
authenticationDataAwsAuthenticationData

A credentials for the AWS authentication.

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
idstring

The unique ID of the credentials.

labelstring

The name of the credentials.

metadataConfigurationMetadata

Metadata useful for debugging

partitionTypestring

The type of the AWS partition.

The element can hold these values
  • AWS_CN
  • AWS_DEFAULT
  • AWS_US_GOV
supportingServicesToMonitorAwsSupportingServiceConfig[]

Deprecated. To manage services use /aws/credentials/{id}/services operation. Built-in services are not supported here.

A list of AWS services to be monitored. Available services are listed by /aws/supportedServices operation.

For each service, a list of metrics and dimensions can be specified. A list of supported metrics and dimensions for a given service can be checked in documentation.

List of metrics can be skipped (set to null), resulting in recommended (default) set of metrics and dimensions being chosen for monitoring.

taggedOnlyboolean

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

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.

The AwsAuthenticationData object

A credentials for the AWS authentication.

ElementTypeDescription
keyBasedAuthenticationKeyBasedAuthentication

Deprecated. The credentials for the key-based authentication.

roleBasedAuthenticationRoleBasedAuthentication

The credentials for the role-based authentication.

typestring

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

The element can hold these values
  • KEYS
  • ROLE

The KeyBasedAuthentication object

Deprecated. The credentials for the key-based authentication.

ElementTypeDescription
accessKeystring

The ID of the access key.

secretKeystring

The secret access key.

The RoleBasedAuthentication object

The credentials for the role-based authentication.

ElementTypeDescription
accountIdstring

The ID of the Amazon account.

externalIdstring

The external ID token for setting an IAM role.

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

iamRolestring

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

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

The AwsSupportingServiceConfig object

A service to be monitored.

ElementTypeDescription
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.

namestring

The name of the service. Valid supported service names can be discovered using /aws/supportedServices restAPI

The AwsSupportingServiceMetric object

A metric of service to be monitored.

ElementTypeDescription
dimensionsstring[]

A list of metric's dimensions names.

namestring

The name of the metric of the service.

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

The AwsConfigTag object

An AWS tag of the resource to be monitored.

ElementTypeDescription
namestring

The key of the AWS tag.

valuestring

The value of the AWS tag.

Response body JSON model

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

    Integrate Dynatrace on AWS