MediaLive / Client / list_cloud_watch_alarm_templates

list_cloud_watch_alarm_templates#

MediaLive.Client.list_cloud_watch_alarm_templates(**kwargs)#

Lists cloudwatch alarm templates.

See also: AWS API Documentation

Request Syntax

response = client.list_cloud_watch_alarm_templates(
    GroupIdentifier='string',
    MaxResults=123,
    NextToken='string',
    Scope='string',
    SignalMapIdentifier='string'
)
Parameters:

  • GroupIdentifier (string) – A cloudwatch alarm template group’s identifier. Can be either be its id or current name.

  • MaxResults (integer) – Placeholder documentation for MaxResults

  • NextToken (string) – A token used to retrieve the next set of results in paginated list responses.

  • Scope (string) – Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.

  • SignalMapIdentifier (string) – A signal map’s identifier. Can be either be its id or current name.

Return type:

dict

Returns:

Response Syntax

{
    'CloudWatchAlarmTemplates': [
        {
            'Arn': 'string',
            'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'CreatedAt': datetime(2015, 1, 1),
            'DatapointsToAlarm': 123,
            'Description': 'string',
            'EvaluationPeriods': 123,
            'GroupId': 'string',
            'Id': 'string',
            'MetricName': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'Name': 'string',
            'Period': 123,
            'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
            'Tags': {
                'string': 'string'
            },
            'TargetResourceType': 'CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
            'Threshold': 123.0,
            'TreatMissingData': 'notBreaching'|'breaching'|'ignore'|'missing'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) – ListCloudWatchAlarmTemplates 200 response

    • CloudWatchAlarmTemplates (list) – Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary

      • (dict) – Placeholder documentation for CloudWatchAlarmTemplateSummary

        • Arn (string) – A cloudwatch alarm template’s ARN (Amazon Resource Name)

        • ComparisonOperator (string) – The comparison operator used to compare the specified statistic and the threshold.

        • CreatedAt (datetime) – Placeholder documentation for __timestampIso8601

        • DatapointsToAlarm (integer) – The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

        • Description (string) – A resource’s optional description.

        • EvaluationPeriods (integer) – The number of periods over which data is compared to the specified threshold.

        • GroupId (string) – A cloudwatch alarm template group’s id. AWS provided template groups have ids that start with aws-

        • Id (string) – A cloudwatch alarm template’s id. AWS provided templates have ids that start with aws-

        • MetricName (string) – The name of the metric associated with the alarm. Must be compatible with targetResourceType.

        • ModifiedAt (datetime) – Placeholder documentation for __timestampIso8601

        • Name (string) – A resource’s name. Names must be unique within the scope of a resource type in a specific region.

        • Period (integer) – The period, in seconds, over which the specified statistic is applied.

        • Statistic (string) – The statistic to apply to the alarm’s metric data.

        • Tags (dict) – Represents the tags associated with a resource.

          • (string) – Placeholder documentation for __string

            • (string) – Placeholder documentation for __string

        • TargetResourceType (string) – The resource type this template should dynamically generate cloudwatch metric alarms for.

        • Threshold (float) – The threshold value to compare with the specified statistic.

        • TreatMissingData (string) – Specifies how missing data points are treated when evaluating the alarm’s condition.

    • NextToken (string) – A token used to retrieve the next set of results in paginated list responses.

Exceptions