CloudWatch / Client / describe_alarm_contributors

describe_alarm_contributors

CloudWatch.Client.describe_alarm_contributors(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_alarm_contributors(
    AlarmName='string',
    NextToken='string'
)
Parameters:

  • AlarmName (string) –

    [REQUIRED]

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

  • NextToken (string) – The token returned by a previous call to indicate that there is more data available.

Return type:

dict

Returns:

Response Syntax

{
    'AlarmContributors': [
        {
            'ContributorId': 'string',
            'ContributorAttributes': {
                'string': 'string'
            },
            'StateReason': 'string',
            'StateTransitionedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AlarmContributors (list) –

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

      • (dict) –

        Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm’s state.

        • ContributorId (string) –

          The unique identifier for this alarm contributor.

        • ContributorAttributes (dict) –

          A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.

          • (string) –

            • (string) –

        • StateReason (string) –

          An explanation for the contributor’s current state, providing context about why it is in its current condition.

        • StateTransitionedTimestamp (datetime) –

          The timestamp when the contributor last transitioned to its current state.

    • NextToken (string) –

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

Exceptions

  • CloudWatch.Client.exceptions.InvalidNextToken

  • CloudWatch.Client.exceptions.ResourceNotFoundException