Macie2 / Client / get_sensitivity_inspection_template

get_sensitivity_inspection_template#

Macie2.Client.get_sensitivity_inspection_template(**kwargs)#

Retrieves the settings for the sensitivity inspection template for an account.

See also: AWS API Documentation

Request Syntax

response = client.get_sensitivity_inspection_template(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'excludes': {
        'managedDataIdentifierIds': [
            'string',
        ]
    },
    'includes': {
        'allowListIds': [
            'string',
        ],
        'customDataIdentifierIds': [
            'string',
        ],
        'managedDataIdentifierIds': [
            'string',
        ]
    },
    'name': 'string',
    'sensitivityInspectionTemplateId': 'string'
}

Response Structure

  • (dict) –

    The request succeeded.

    • description (string) –

      The custom description of the template.

    • excludes (dict) –

      The managed data identifiers that are explicitly excluded (not used) when analyzing data.

      • managedDataIdentifierIds (list) –

        An array of unique identifiers, one for each managed data identifier to exclude. To retrieve a list of valid values, use the ListManagedDataIdentifiers operation.

        • (string) –

    • includes (dict) –

      The allow lists, custom data identifiers, and managed data identifiers that are included (used) when analyzing data.

      • allowListIds (list) –

        An array of unique identifiers, one for each allow list to include.

        • (string) –

      • customDataIdentifierIds (list) –

        An array of unique identifiers, one for each custom data identifier to include.

        • (string) –

      • managedDataIdentifierIds (list) –

        An array of unique identifiers, one for each managed data identifier to include.

        Amazon Macie uses these managed data identifiers in addition to managed data identifiers that are subsequently released and recommended for automated sensitive data discovery. To retrieve a list of valid values for the managed data identifiers that are currently available, use the ListManagedDataIdentifiers operation.

        • (string) –

    • name (string) –

      The name of the template: automated-sensitive-data-discovery.

    • sensitivityInspectionTemplateId (string) –

      The unique identifier for the template.

Exceptions

  • Macie2.Client.exceptions.ResourceNotFoundException

  • Macie2.Client.exceptions.ThrottlingException

  • Macie2.Client.exceptions.ValidationException

  • Macie2.Client.exceptions.InternalServerException

  • Macie2.Client.exceptions.AccessDeniedException