Macie2 / Paginator / ListAllowLists

ListAllowLists

class Macie2.Paginator.ListAllowLists

paginator = client.get_paginator('list_allow_lists')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Macie2.Client.list_allow_lists().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'allowLists': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The request succeeded.

  • allowLists (list) –

    An array of objects, one for each allow list.

    • (dict) –

      Provides a subset of information about an allow list.

      • arn (string) –

        The Amazon Resource Name (ARN) of the allow list.

      • createdAt (datetime) –

        The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

      • description (string) –

        The custom description of the allow list.

      • id (string) –

        The unique identifier for the allow list.

      • name (string) –

        The custom name of the allow list.

      • updatedAt (datetime) –

        The date and time, in UTC and extended ISO 8601 format, when the allow list’s settings were most recently changed in Amazon Macie.

  • NextToken (string) –

    A token to resume pagination.