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} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/{id} |
Authentication
To execute this request, you need an access token with Read configuration (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 |
|---|---|---|
| 200 | Aws | Success |
Response body objects
The AwsCredentialsConfig object
Configuration of an AWS credentials.
| Element | Type | Description |
|---|---|---|
| metadata | Configuration | Metadata useful for debugging Can be |
| id | string | The unique ID of the credentials. Can be |
| connectionStatus | string | The status of the connection to the AWS environment.
Can be |
| label | string | The name of the credentials. |
| partitionType | string | The type of the AWS partition. |
| authenticationData | Aws | A credentials for the AWS authentication. |
| taggedOnly | boolean | Monitor only resources which have specified AWS tags ( |
| tagsToMonitor | Aws | A list of AWS tags to be monitored. You can specify up to 10 tags. Only applicable when the taggedOnly parameter is set to |
| supportingServicesToMonitor | Aws | 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 Dynatrace documentation. List of metrics can be skipped (set to null), resulting in recommended (default) set of metrics and dimensions being chosen for monitoring. Can be |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description |
|---|---|---|
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. Can be |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. Can be |
| clusterVersion | string | Dynatrace version. Can be |
The AwsAuthenticationData object
A credentials for the AWS authentication.
| Element | Type | Description |
|---|---|---|
| type | string | The type of the authentication: role-based or key-based. |
| keyBasedAuthentication | Key | The credentials for the key-based authentication. Can be |
| roleBasedAuthentication | Role | The credentials for the role-based authentication. Can be |
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 RoleBasedAuthentication object
The credentials for the role-based authentication.
| 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 Can be |
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 AwsSupportingServiceConfig object
A supporting service to be monitored.
| Element | Type | Description |
|---|---|---|
| name | string | The name of the supporting service. Valid supported service names can be discovered using /aws/supportedServices restAPI |
| monitoredMetrics | Aws | 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. Can be |
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 |
| dimensions | string[] | A list of metric's dimensions names. |
Response body JSON model
{
"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"
]
}
]
}
]
}