Inspector / Paginator / ListEventSubscriptions

ListEventSubscriptions

class Inspector.Paginator.ListEventSubscriptions

paginator = client.get_paginator('list_event_subscriptions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Inspector.Client.list_event_subscriptions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• resourceArn (string) – The ARN of the assessment template for which you want to list the existing event subscriptions.

• 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

{
    'subscriptions': [
        {
            'resourceArn': 'string',
            'topicArn': 'string',
            'eventSubscriptions': [
                {
                    'event': 'ASSESSMENT_RUN_STARTED'|'ASSESSMENT_RUN_COMPLETED'|'ASSESSMENT_RUN_STATE_CHANGED'|'FINDING_REPORTED'|'OTHER',
                    'subscribedAt': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • subscriptions (list) –

    Details of the returned event subscriptions.

    • (dict) –

      This data type is used as a response element in the ListEventSubscriptions action.

      • resourceArn (string) –

        The ARN of the assessment template that is used during the event for which the SNS notification is sent.

      • topicArn (string) –

        The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent.

      • eventSubscriptions (list) –

        The list of existing event subscriptions.

        • (dict) –

          This data type is used in the Subscription data type.

          • event (string) –

            The event for which Amazon Simple Notification Service (SNS) notifications are sent.

          • subscribedAt (datetime) –

            The time at which SubscribeToEvent is called.

  • NextToken (string) –

    A token to resume pagination.