Lambda / Paginator / ListFunctionEventInvokeConfigs

ListFunctionEventInvokeConfigs

class Lambda.Paginator.ListFunctionEventInvokeConfigs

paginator = client.get_paginator('list_function_event_invoke_configs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Lambda.Client.list_function_event_invoke_configs().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• FunctionName (string) –

  [REQUIRED]

  The name or ARN of the Lambda function.

  Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

  The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

• 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

{
    'FunctionEventInvokeConfigs': [
        {
            'LastModified': datetime(2015, 1, 1),
            'FunctionArn': 'string',
            'MaximumRetryAttempts': 123,
            'MaximumEventAgeInSeconds': 123,
            'DestinationConfig': {
                'OnSuccess': {
                    'Destination': 'string'
                },
                'OnFailure': {
                    'Destination': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • FunctionEventInvokeConfigs (list) –

    A list of configurations.

    • (dict) –

      • LastModified (datetime) –

        The date and time that the configuration was last updated.

      • FunctionArn (string) –

        The Amazon Resource Name (ARN) of the function.

      • MaximumRetryAttempts (integer) –

        The maximum number of times to retry when the function returns an error.

      • MaximumEventAgeInSeconds (integer) –

        The maximum age of a request that Lambda sends to a function for processing.

      • DestinationConfig (dict) –

        A destination for events after they have been sent to a function for processing.

        Destinations

        • Function - The Amazon Resource Name (ARN) of a Lambda function.

        • Queue - The ARN of a standard SQS queue.

        • Bucket - The ARN of an Amazon S3 bucket.

        • Topic - The ARN of a standard SNS topic.

        • Event Bus - The ARN of an Amazon EventBridge event bus.

        Note

        S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

        • OnSuccess (dict) –

          The destination configuration for successful invocations. Not supported in CreateEventSourceMapping or UpdateEventSourceMapping.

          • Destination (string) –

            The Amazon Resource Name (ARN) of the destination resource.

            Note

            Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.

        • OnFailure (dict) –

          The destination configuration for failed invocations.

          • Destination (string) –

            The Amazon Resource Name (ARN) of the destination resource.

            To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination.

            Note

            Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.

            To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

  • NextToken (string) –

    A token to resume pagination.