Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

PutDataExportConfiguration

Creates data export configuration details.

If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table.

Note

You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps:

Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation.
Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion.
Call the PutDataExportConfiguration API to enable export for the new domain.

Request Syntax


PUT /v2/domains/domainIdentifier/data-export-configuration HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "enableExport": boolean,
   "encryptionConfiguration": { 
      "kmsKeyArn": "string",
      "sseAlgorithm": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The domain ID for which you want to create data export configuration details.

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7E]+

Required: No

enableExport

Specifies that the export is to be enabled as part of creating data export configuration details.

Type: Boolean

Required: Yes

encryptionConfiguration

The encryption configuration as part of creating data export configuration details.

The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio.

Type: EncryptionConfiguration object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

Examples

Example

Enable data export:

Sample Request



aws datazone put-data-export-configuration  --domain-identifier dzd-440699i00ezy21 --region us-east-2 --enable-export

Example

Disable data export:

Sample Request



aws datazone put-data-export-configuration --domain-identifier dzd-440699i00ezy21 --region us-east-2 --no-enable-export

Example

With KMS key encryption configuration:

Sample Request



aws datazone put-data-export-configuration --encryption-configuration kmsKeyArn=arn:aws:kms:us-east-2:651673343886:key/292fedfe-c9h6-40fa-961b-87393584195c,sseAlgorithm=aws:kms --enable-export --region us-east-2 --domain-identifier dzd-440699i00ezy21

Example

With KMS key encryption configuration when KMS key is disabled:

Sample Response



An error occurred (ValidationException) when calling the PutDataExportConfiguration operation: The specified KMS key ARN is disabled. (Service: S3Tables, Status Code: 400, Request ID: 07bdfab7-6336-4145-b5ec-277a6a77a4e0) (SDK Attempt Count: 1)

Example

With KMS key encryption configuration when KMS key is missing permission for systemtables.sagemaker-catalog.amazonaws.com service principal:

Sample Response



An error occurred (AccessDeniedException) when calling the PutDataExportConfiguration operation: User: arn:aws:sts::750784792897:assumed-role/SageMakerCatalogDataSetPublisherRole/AWSSageMakerCatalog-S3TablesRole-651393378886 is not authorized to perform: kms:DescribeKey on this resource because the resource does not exist in this Region, no resource-based policies allow access, or a resource-based policy explicitly denies access (Service: S3Tables, Status Code: 403, Request ID: 86f5d9f9-62a6-4af9-8177-69edbb2992f4) (SDK Attempt Count: 1)

Example

With KMS key encryption configuration when SSE algorithm is not provided along with KMS key:

Sample Response



An error occurred (ValidationException) when calling the PutDataExportConfiguration operation: The specified SSE algorithm is invalid. (Service: S3Tables, Status Code: 400, Request ID: 678df137-aa8e-47aa-b485-a8971a3f2f3c) (SDK Attempt Count: 1)

Example

Enable export failing with conflict exception. Provide --client-token parameter with a different client token to resolve this error.

Sample Response



An error occurred (ConflictException) when calling the PutDataExportConfiguration operation: Conflict exception occurred while putting data export configuration for domain:dzd-cslg7hs0m6k4fd

Example

When configuration already exists for another domain:

Sample Response



An error occurred (ConflictException) when calling the PutDataExportConfiguration operation: Data Export Configuration exists for another domain with id: dzd-cslg7hs0m6k4fd