Classification Results - Export Configuration

The Export Configuration resource for classification results provides access to settings for storing data classification results in an Amazon Simple Storage Service (Amazon S3) bucket. A data classification result, also referred to as a sensitive data discovery result, is a record that logs details about the analysis that Amazon Macie performed on an Amazon S3 object to determine whether the object contains sensitive data.

When you run a classification job or Macie performs automated sensitive data discovery, Macie automatically creates a data classification result for each S3 object that's included in the scope of the analysis. This includes objects that Macie doesn't find sensitive data in, and therefore don't produce findings, and objects that Macie can't analyze due to issues such as permissions settings. Data classification results provide you with analysis records that can be helpful for data privacy and protection audits or investigations. You can configure Macie to store these records in an S3 general purpose bucket and encrypt them with an AWS Key Management Service (AWS KMS) key. For more information, see Storing and retaining sensitive data discovery results in the Amazon Macie User Guide.

If you use Macie in multiple AWS Regions, configure these settings for each Region in which you use Macie. You can optionally store data classification results for multiple Regions in the same S3 bucket. However, note the following requirements:

To determine whether a Region is enabled by default, see Enable or disable AWS Regions in your account in the AWS Account Management Reference Guide. In addition to the preceding requirements, also consider whether you want to retrieve samples of sensitive data that Macie reports in individual findings. To retrieve sensitive data samples from an affected S3 object, all of the following resources and data must be stored in the same Region: the affected object, the applicable finding, and the corresponding sensitive data discovery result.

You can use the Export Configuration resource to specify or retrieve information about your configuration settings for storing data classification results in an S3 bucket.

URI

/classification-export-configuration

HTTP methods

GET

Operation ID: GetClassificationExportConfiguration

Retrieves the configuration settings for storing data classification results.

PUT

Operation ID: PutClassificationExportConfiguration

Adds or updates the configuration settings for storing data classification results.

Schemas

Request bodies

{
  "configuration": {
    "s3Destination": {
      "bucketName": "string",
      "keyPrefix": "string",
      "kmsKeyArn": "string"
    }
  }
}

Response bodies

{
  "configuration": {
    "s3Destination": {
      "bucketName": "string",
      "keyPrefix": "string",
      "kmsKeyArn": "string"
    }
  }
}

{
  "configuration": {
    "s3Destination": {
      "bucketName": "string",
      "keyPrefix": "string",
      "kmsKeyArn": "string"
    }
  }
}

{
  "message": "string"
}

{
  "message": "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.

ClassificationExportConfiguration

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. The location must be an S3 general purpose bucket.

ConflictException

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetClassificationExportConfigurationResponse

Provides information about the current configuration settings for storing data classification results.

InternalServerException

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

PutClassificationExportConfigurationRequest

Specifies where to store data classification results, and the encryption settings to use when storing results in that location.

PutClassificationExportConfigurationResponse

Provides information about updated settings for storing data classification results.

ResourceNotFoundException

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

S3Destination

Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

ServiceQuotaExceededException

Provides information about an error that occurred due to one or more service quotas for an account.

ThrottlingException

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

ValidationException

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

See also

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

GetClassificationExportConfiguration

PutClassificationExportConfiguration