Amazon Macie
API Reference (API Version 2017-12-19)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListS3Resources

Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account.

Request Syntax

{ "maxResults": number, "memberAccountId": "string", "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

Type: Integer

Valid Range: Maximum value of 250.

Required: No

memberAccountId

The Amazon Macie member account ID whose associated S3 resources you want to list.

Type: String

Pattern: [0-9]{12}

Required: No

nextToken

Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Response Syntax

{ "nextToken": "string", "s3Resources": [ { "bucketName": "string", "classificationType": { "continuous": "string", "oneTime": "string" }, "prefix": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

Type: String

Length Constraints: Maximum length of 500.

s3Resources

A list of the associated S3 resources returned by the action.

Type: Array of S3ResourceClassification objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have required permissions to access the requested resource.

HTTP Status Code: 400

InternalException

Internal server error.

HTTP Status Code: 500

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

See Also

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