AWS credentials API - GET credentials

Gets the configuration of the specified AWS credentials.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

Parameter
Type
Description
In
Required
id
string

The ID of the specified AWS credentials configuration.

path
required

Response

Response codes

Code
Type
Description

Response body objects

The AwsCredentialsConfig object

Configuration of an AWS credentials.

Element
Type
Description
authenticationData

A credentials for the AWS authentication.

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.
  • CONNECTED
  • DISCONNECTED
  • UNINITIALIZED
credentialsEnabled
boolean

Enable monitoring of credentials.

id
string

The unique ID of the credentials.

label
string

The name of the credentials.

metadata

Metadata useful for debugging

The AwsAuthenticationData object

A credentials for the AWS authentication.

Element
Type
Description
keyBasedAuthentication

Deprecated. The credentials for the key-based authentication.

roleBasedAuthentication

The credentials for the role-based authentication.

type
string

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

  • KEYS
  • ROLE

The KeyBasedAuthentication object

Deprecated. 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 RoleBasedAuthentication object

The credentials for the role-based authentication.

Element
Type
Description
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.

iamRole
string

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

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
clusterVersion
string

Dynatrace version.

configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

The AwsSupportingServiceConfig object

A service to be monitored.

Element
Type
Description
monitoredMetrics

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.

name
string

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.

Element
Type
Description
dimensions
string[]

A list of metric's dimensions names.

name
string

The name of the metric of the 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

  • AVERAGE
  • AVG_MIN_MAX
  • MAXIMUM
  • MINIMUM
  • SAMPLE_COUNT
  • SUM

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.

Response body JSON model

{
  "authenticationData": {
    "keyBasedAuthentication": {
      "accessKey": "string",
      "secretKey": "string"
    },
    "roleBasedAuthentication": {
      "accountId": "string",
      "externalId": "string",
      "iamRole": "string"
    },
    "type": "KEYS"
  },
  "connectionStatus": "CONNECTED",
  "credentialsEnabled": true,
  "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": false,
  "tagsToMonitor": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Related topics