Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeAlarmContributors

Returns the information of the current alarm contributors that are in ALARM state. This operation returns details about the individual time series that contribute to the alarm's state.

Request Syntax


{
   "AlarmName": "string",
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AlarmName

The name of the alarm for which to retrieve contributor information.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

NextToken

The token returned by a previous call to indicate that there is more data available.

Type: String

Required: No

Response Syntax


{
   "AlarmContributors": [ 
      { 
         "ContributorAttributes": { 
            "string" : "string" 
         },
         "ContributorId": "string",
         "StateReason": "string",
         "StateTransitionedTimestamp": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AlarmContributors

A list of alarm contributors that provide details about the individual time series contributing to the alarm's state.

Type: Array of AlarmContributor objects

NextToken

The token that marks the start of the next batch of returned results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidNextToken

The next token specified is invalid.

message

HTTP Status Code: 400

ResourceNotFoundException

The named resource does not exist.

HTTP Status Code: 404