Resource Sensitivity Profile - Artifacts - Amazon Macie

Resource Sensitivity Profile - Artifacts

The Resource Sensitivity Profile Artifacts resource provides information about the objects that Amazon Macie has selected and analyzed in individual Amazon Simple Storage Service (Amazon S3) buckets for your account, and the status and results of the analyses. For each S3 object, the information includes the Amazon Resource Name (ARN) of the object, whether Macie successfully completed its analysis of the object, and whether Macie found sensitive data in the object. The information captures the results of automated sensitive data discovery activities that Macie has performed for an S3 bucket. For more information, see Performing automated sensitive data discovery in the Amazon Macie User Guide.

If automated sensitive data discovery is currently enabled for your account, you can use this resource to retrieve information about the objects that Macie has selected and analyzed for an S3 bucket, and the status and results of the analyses.

URI

/resource-profiles/artifacts

HTTP methods

GET

Operation ID: ListResourceProfileArtifacts

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

Query parameters
NameTypeRequiredDescription
resourceArnStringTrue

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

nextTokenStringFalse

The nextToken string that specifies which page of results to return in a paginated response.

Responses
Status codeResponse modelDescription
200ListResourceProfileArtifactsResponse

The request succeeded.

400ValidationException

The request failed because the input doesn't satisfy the constraints specified by the service.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

Schemas

Response bodies

{ "artifacts": [ { "arn": "string", "classificationResultStatus": "string", "sensitive": boolean } ], "nextToken": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDeniedException

Provides information about an error that occurred due to insufficient access to a specified resource.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

InternalServerException

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ListResourceProfileArtifactsResponse

Provides the results of a request for information about the S3 objects that Amazon Macie selected for analysis while performing automated sensitive data discovery for an S3 bucket. This information is available only if automated sensitive data discovery is currently enabled for your account.

PropertyTypeRequiredDescription
artifacts

Array of type ResourceProfileArtifact

True

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.

nextToken

string

False

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.

ResourceNotFoundException

Provides information about an error that occurred because a specified resource wasn't found.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ResourceProfileArtifact

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

PropertyTypeRequiredDescription
arn

string

True

The Amazon Resource Name (ARN) of the object.

classificationResultStatus

string

True

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

False

Specifies whether Amazon Macie found sensitive data in the object.

ThrottlingException

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ValidationException

Provides information about an error that occurred due to a syntax error in a request.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListResourceProfileArtifacts