AWS credentials API - GET monitored services

Lists AWS services that are monitored by an AWS configuration.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials/{id}/services
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/aws/credentials/{id}/services

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
200

Success

Response body objects

The AwsMonitoredServicesDto object

Element
Type
Description
metadata

Metadata useful for debugging

services

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. For built-in services, adjusting the list of metrics is not supported, therefore it needs to be null.

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

Response body JSON model

{
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ]
  },
  "services": [
    {
      "monitoredMetrics": [
        {
          "dimensions": [
            "string"
          ],
          "name": "string",
          "statistic": "AVERAGE"
        }
      ],
      "name": "string"
    }
  ]
}

Related topics