DataZone / Client / put_data_export_configuration

put_data_export_configuration

DataZone.Client.put_data_export_configuration(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.put_data_export_configuration(
    domainIdentifier='string',
    enableExport=True|False,
    encryptionConfiguration={
        'kmsKeyArn': 'string',
        'sseAlgorithm': 'string'
    },
    clientToken='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

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

  • enableExport (boolean) –

    [REQUIRED]

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

  • encryptionConfiguration (dict) –

    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.

    • kmsKeyArn (string) –

      The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.

    • sseAlgorithm (string) –

      The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions