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

GetDataExportConfiguration

Gets data export configuration details.

Request Syntax


GET /v2/domains/domainIdentifier/data-export-configuration HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain where you want to get the data export configuration details.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "encryptionConfiguration": { 
      "kmsKeyArn": "string",
      "sseAlgorithm": "string"
   },
   "isExportEnabled": boolean,
   "s3TableBucketArn": "string",
   "status": "string",
   "updatedAt": number
}

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.

createdAt

The timestamp at which the data export configuration report was created.

Type: Timestamp

encryptionConfiguration

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

Type: EncryptionConfiguration object

isExportEnabled

Specifies whether the export is enabled.

Type: Boolean

s3TableBucketArn

The Amazon S3 table bucket ARN as part of the data export configuration details.

Type: String

status

The status of the data export configuration.

Type: String

Valid Values: COMPLETED | FAILED

updatedAt

The timestamp at which the data export configuration report was updated.

Type: Timestamp

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

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

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

Get data export configuration:

Sample Request



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

Sample Response



{
    "isExportEnabled": true,
    "status": "COMPLETED",
    "s3TableBucketArn": "arn:aws:s3tables:us-east-2:651393673886:bucket/aws-sagemaker-catalog",
    "createdAt": "2025-11-26T06:17:32.580000+05:30",
    "updatedAt": "2025-11-26T06:17:32.580000+05:30"
}

Example

When export is disabled:

Sample Response



{
    "isExportEnabled": false,
    "status": "COMPLETED",
    "createdAt": "2025-11-26T06:17:32.580000+05:30",
    "updatedAt": "2025-11-26T06:17:32.580000+05:30"
}

Example

When export is enabled with KMS key provided:

Sample Response



{
    "isExportEnabled": true,
    "status": "COMPLETED",
    "encryptionConfiguration": {
        "kmsKeyArn": "arn:aws:kms:us-east-2:651393343886:key/292fedfe-c4b6-40fa-961b-87393584195c",
        "sseAlgorithm": "aws:kms"
    },
    "s3TableBucketArn": "arn:aws:s3tables:us-east-2:651393343886:bucket/aws-sagemaker-catalog",
    "createdAt": "2025-11-26T06:17:32.580000+05:30",
    "updatedAt": "2025-11-26T06:17:32.580000+05:30"
}