Macie2 / Client / list_resource_profile_detections

list_resource_profile_detections#

Macie2.Client.list_resource_profile_detections(**kwargs)#

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_profile_detections(
    maxResults=123,
    nextToken='string',
    resourceArn='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.

  • resourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

Return type:

dict

Returns:

Response Syntax

{
    'detections': [
        {
            'arn': 'string',
            'count': 123,
            'id': 'string',
            'name': 'string',
            'suppressed': True|False,
            'type': 'CUSTOM'|'MANAGED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    The request succeeded.

    • detections (list) –

      An array of objects, one for each type of sensitive data that Amazon Macie found in the bucket. Each object reports the number of occurrences of the specified type and provides information about the custom data identifier or managed data identifier that detected the data.

      • (dict) –

        Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for an account. The information also specifies the custom or managed data identifier that detected the data. This information is available only if automated sensitive data discovery has been enabled for the account.

        • arn (string) –

          If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

        • count (integer) –

          The total number of occurrences of the sensitive data.

        • id (string) –

          The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

        • name (string) –

          The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

        • suppressed (boolean) –

          Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket’s sensitivity score.

        • type (string) –

          The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

    • 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