MediaTailor / Paginator / ListAlerts

ListAlerts

class MediaTailor.Paginator.ListAlerts

paginator = client.get_paginator('list_alerts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaTailor.Client.list_alerts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the resource.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'AlertCode': 'string',
            'AlertMessage': 'string',
            'Category': 'SCHEDULING_ERROR'|'PLAYBACK_WARNING'|'INFO',
            'LastModifiedTime': datetime(2015, 1, 1),
            'RelatedResourceArns': [
                'string',
            ],
            'ResourceArn': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Items (list) –

    A list of alerts that are associated with this resource.

    • (dict) –

      Alert configuration parameters.

      • AlertCode (string) –

        The code for the alert. For example, NOT_PROCESSED.

      • AlertMessage (string) –

        If an alert is generated for a resource, an explanation of the reason for the alert.

      • Category (string) –

        The category that MediaTailor assigns to the alert.

      • LastModifiedTime (datetime) –

        The timestamp when the alert was last modified.

      • RelatedResourceArns (list) –

        The Amazon Resource Names (ARNs) related to this alert.

        • (string) –

      • ResourceArn (string) –

        The Amazon Resource Name (ARN) of the resource.