Macie2 / Client / create_allow_list

create_allow_list#

Macie2.Client.create_allow_list(**kwargs)#

Creates and defines the settings for an allow list.

See also: AWS API Documentation

Request Syntax

response = client.create_allow_list(
    clientToken='string',
    criteria={
        'regex': 'string',
        's3WordsList': {
            'bucketName': 'string',
            'objectKey': 'string'
        }
    },
    description='string',
    name='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientToken (string) –

    [REQUIRED]

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • criteria (dict) –

    [REQUIRED]

    The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

    • regex (string) –

      The regular expression (regex) that defines the text pattern to ignore. The expression can contain as many as 512 characters.

    • s3WordsList (dict) –

      The location and name of the S3 object that lists specific text to ignore.

      • bucketName (string) – [REQUIRED]

        The full name of the S3 bucket that contains the object.

      • objectKey (string) – [REQUIRED]

        The full name (key) of the object.

  • description (string) – A custom description of the allow list. The description can contain as many as 512 characters.

  • name (string) –

    [REQUIRED]

    A custom name for the allow list. The name can contain as many as 128 characters.

  • tags (dict) –

    A map of key-value pairs that specifies the tags to associate with the allow list.

    An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string'
}

Response Structure

  • (dict) –

    The request succeeded. The specified allow list was created.

    • arn (string) –

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

    • id (string) –

      The unique identifier for the allow list.

Exceptions