Macie2 / Client / batch_get_custom_data_identifiers

batch_get_custom_data_identifiers

Macie2.Client.batch_get_custom_data_identifiers(**kwargs)

Retrieves information about one or more custom data identifiers.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_custom_data_identifiers(
    ids=[
        'string',
    ]
)
Parameters:

ids (list) –

An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'customDataIdentifiers': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deleted': True|False,
            'description': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    'notFoundIdentifierIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    The request succeeded.

    • customDataIdentifiers (list) –

      An array of objects, one for each custom data identifier that matches the criteria specified in the request.

      • (dict) –

        Provides information about a custom data identifier.

        • arn (string) –

          The Amazon Resource Name (ARN) of the custom data identifier.

        • createdAt (datetime) –

          The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

        • deleted (boolean) –

          Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn’t delete it permanently. Instead, it soft deletes the identifier.

        • description (string) –

          The custom description of the custom data identifier.

        • id (string) –

          The unique identifier for the custom data identifier.

        • name (string) –

          The custom name of the custom data identifier.

    • notFoundIdentifierIds (list) –

      An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn’t correlate to an existing custom data identifier.

      • (string) –

Exceptions