DataExchange / Paginator / ListEventActions

ListEventActions

class DataExchange.Paginator.ListEventActions

paginator = client.get_paginator('list_event_actions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataExchange.Client.list_event_actions().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• EventSourceId (string) – The unique identifier for the event source.

• 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

{
    'EventActions': [
        {
            'Action': {
                'ExportRevisionToS3': {
                    'Encryption': {
                        'KmsKeyArn': 'string',
                        'Type': 'aws:kms'|'AES256'
                    },
                    'RevisionDestination': {
                        'Bucket': 'string',
                        'KeyPattern': 'string'
                    }
                }
            },
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Event': {
                'RevisionPublished': {
                    'DataSetId': 'string'
                }
            },
            'Id': 'string',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • EventActions (list) –

    The event action objects listed by the request.

    • (dict) –

      An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.

      • Action (dict) –

        What occurs after a certain event.

        • ExportRevisionToS3 (dict) –

          Details for the export revision to Amazon S3 action.

          • Encryption (dict) –

            Encryption configuration for the auto export job.

            • KmsKeyArn (string) –

              The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

            • Type (string) –

              The type of server side encryption used for encrypting the objects in Amazon S3.

          • RevisionDestination (dict) –

            A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.

            • Bucket (string) –

              The Amazon S3 bucket that is the destination for the event action.

            • KeyPattern (string) –

              A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions.

      • Arn (string) –

        The Amazon Resource Name (ARN) for the event action.

      • CreatedAt (datetime) –

        The date and time that the event action was created, in ISO 8601 format.

      • Event (dict) –

        What occurs to start an action.

        • RevisionPublished (dict) –

          What occurs to start the revision publish action.

          • DataSetId (string) –

            The data set ID of the published revision.

      • Id (string) –

        The unique identifier for the event action.

      • UpdatedAt (datetime) –

        The date and time that the event action was last updated, in ISO 8601 format.