AWS credentials API - PUT monitored services

Updates the list of AWS services that are monitored by an AWS configuration. Note that the request overwrites an existing configuration. Any services that you want to continue monitoring must be presented in the payload.

The request consumes an application/json payload.

PUTSaaShttps://{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 WriteConfig 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 AWS credentials to be updated with new monitored services configuration.

path
required
body

The JSON body of the request. Contains updated monitored services configuration for AWS credentials.

body
optional

Request body objects

The AwsMonitoredServicesDto object

Element
Type
Description
Required
metadata

Metadata useful for debugging

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

required

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

optional

The AwsSupportingServiceConfig object

A service to be monitored.

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

optional
name
string

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

required

The AwsSupportingServiceMetric object

A metric of service to be monitored.

Element
Type
Description
Required
dimensions
string[]

A list of metric's dimensions names.

required
name
string

The name of the metric of the service.

required
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
required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

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

Response

Response codes

Code
Type
Description
204
-

Success. The AWS credentials configuration has been updated. Response doesn't have a body.

400

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

The request consumes an application/json payload.

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

Authentication

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

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

Response

Response codes

Code
Type
Description
204
-

Validated. The submitted configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid.

Related topics