Macie2 / Client / update_allow_list

update_allow_list#

Macie2.Client.update_allow_list(**kwargs)#

Updates the settings for an allow list.

See also: AWS API Documentation

Request Syntax

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

  • 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 that defines a text pattern to ignore (regex).

    You can change a list’s underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can’t change the type from s3WordsList to regex or the other way around.

    • 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.

  • id (string) –

    [REQUIRED]

    The unique identifier for the Amazon Macie resource that the request applies to.

  • name (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    The request succeeded. The settings for the allow list were updated.

    • arn (string) –

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

    • id (string) –

      The unique identifier for the allow list.

Exceptions