ListResourceProfileArtifactsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Macie2Client, ListResourceProfileArtifactsCommand } from "@aws-sdk/client-macie2"; // ES Modules import
// const { Macie2Client, ListResourceProfileArtifactsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import
const client = new Macie2Client(config);
const input = { // ListResourceProfileArtifactsRequest
  nextToken: "STRING_VALUE",
  resourceArn: "STRING_VALUE", // required
};
const command = new ListResourceProfileArtifactsCommand(input);
const response = await client.send(command);
// { // ListResourceProfileArtifactsResponse
//   artifacts: [ // __listOfResourceProfileArtifact
//     { // ResourceProfileArtifact
//       arn: "STRING_VALUE", // required
//       classificationResultStatus: "STRING_VALUE", // required
//       sensitive: true || false,
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListResourceProfileArtifactsCommand Input

See ListResourceProfileArtifactsCommandInput for more details

Parameter
Type
Description
resourceArn
Required
string | undefined

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

nextToken
string | undefined

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

ListResourceProfileArtifactsCommand Output

See ListResourceProfileArtifactsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
artifacts
ResourceProfileArtifact[] | undefined

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 | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

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

InternalServerException
server

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

ResourceNotFoundException
client

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

ThrottlingException
client

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

ValidationException
client

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

Macie2ServiceException
Base exception class for all service exceptions from Macie2 service.