Macie2 / Client / list_resource_profile_artifacts

list_resource_profile_artifacts#

Macie2.Client.list_resource_profile_artifacts(**kwargs)#

Retrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_profile_artifacts(
    nextToken='string',
    resourceArn='string'
)
Parameters:

  • 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

{
    'artifacts': [
        {
            'arn': 'string',
            'classificationResultStatus': 'string',
            'sensitive': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    The request succeeded.

    • artifacts (list) –

      An array of objects, one for each of 1-100 S3 objects that Amazon Macie selected for analysis.

      If Macie has analyzed more than 100 objects in the bucket, Macie populates the array based on the value for the ResourceProfileArtifact.sensitive field for an object: true (sensitive), followed by false (not sensitive). Macie then populates any remaining items in the array with information about objects where the value for the ResourceProfileArtifact.classificationResultStatus field is SKIPPED.

      • (dict) –

        Provides information about an S3 object that Amazon Macie selected for analysis while performing automated sensitive data discovery for an account, and the status and results of the analysis. This information is available only if automated sensitive data discovery has been enabled for the account.

        • arn (string) –

          The Amazon Resource Name (ARN) of the object.

        • classificationResultStatus (string) –

          The status of the analysis. Possible values are:

          • COMPLETE - Amazon Macie successfully completed its analysis of the object.

          • PARTIAL - Macie analyzed only a subset of data in the object. For example, the object is an archive file that contains files in an unsupported format.

          • SKIPPED - Macie wasn’t able to analyze the object. For example, the object is a malformed file.

        • sensitive (boolean) –

          Specifies whether Amazon Macie found sensitive data in the object.

    • 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