list_allow_lists

list_allow_lists(**kwargs)

Retrieves a subset of information about all the allow lists for an account.

See also: AWS API Documentation

Request Syntax

response = client.list_allow_lists(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of items to include in each page of a paginated response.
• nextToken (string) -- The nextToken string that specifies which page of results to return in a paginated 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) --

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Exceptions

• Macie2.Client.exceptions.ThrottlingException
• Macie2.Client.exceptions.ValidationException
• Macie2.Client.exceptions.InternalServerException
• Macie2.Client.exceptions.AccessDeniedException