Classification Scopes - Amazon Macie

Classification Scopes

The Classification Scopes resource provides a subset of information about the classification scope for your account. The classification scope specifies Amazon Simple Storage Service (Amazon S3) buckets that you don't want Amazon Macie to analyze when it performs automated sensitive data discovery for your account. It defines an S3 bucket exclusion list for automated sensitive data discovery. The first time you enable automated sensitive data discovery for your account, Macie automatically creates the classification scope for your account.

If automated sensitive data discovery is currently enabled for your account, you can use this resource to retrieve the unique identifier and name of the classification scope that Macie created for your account. You can then use the unique identifier to retrieve or update the settings for the classification scope by using the Classification Scope resource. To enable automated sensitive data discovery for your account, use the Automated Sensitive Data Discovery Configuration resource.

URI

/classification-scopes

HTTP methods

GET

Operation ID: ListClassificationScopes

Retrieves a subset of information about the classification scope for an account.

Query parameters
NameTypeRequiredDescription
nameStringFalse

The name of the classification scope to retrieve the unique identifier for.

nextTokenStringFalse

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

Responses
Status codeResponse modelDescription
200ListClassificationScopesResponse

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.

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

{ "classificationScopes": [ { "id": "string", "name": "string" } ], "nextToken": "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.

ClassificationScopeSummary

Provides information about the classification scope for an Amazon Macie account. Macie uses the scope's settings when it performs automated sensitive data discovery for the account.

PropertyTypeRequiredDescription
id

string

False

The unique identifier for the classification scope.

name

string

False

The name of the classification scope: automated-sensitive-data-discovery.

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.

ListClassificationScopesResponse

Provides the results of a request for information about the classification scope for an Amazon Macie account. Macie uses the scope's settings when it performs automated sensitive data discovery for the account.

PropertyTypeRequiredDescription
classificationScopes

Array of type ClassificationScopeSummary

False

An array that specifies the unique identifier and name of the classification scope for the account.

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.

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:

ListClassificationScopes