SimpleDBv2 / Client / start_domain_export

start_domain_export

SimpleDBv2.Client.start_domain_export(**kwargs)

Initiates the export of a SimpleDB domain to an S3 bucket.

See also: AWS API Documentation

Request Syntax

response = client.start_domain_export(
    clientToken='string',
    domainName='string',
    s3Bucket='string',
    s3KeyPrefix='string',
    s3SseAlgorithm='AES256'|'KMS',
    s3SseKmsKeyId='string',
    s3BucketOwner='string'
)
Parameters:

  • clientToken (string) –

    Providing a ClientToken makes the call to StartDomainExport API idempotent, meaning that multiple identical calls have the same effect as one single call. A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent. If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, a ConflictException will be returned.

    This field is autopopulated if not provided.

  • domainName (string) –

    [REQUIRED]

    The name of the domain to export.

  • s3Bucket (string) –

    [REQUIRED]

    The name of the S3 bucket where the domain data will be exported.

  • s3KeyPrefix (string) – The prefix string to be used to generate the S3 object keys for export artifacts.

  • s3SseAlgorithm (string) – The server-side encryption algorithm to use for the exported data in S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not specified, bucket’s default encryption will apply.

  • s3SseKmsKeyId (string) – The KMS key ID to use for server-side encryption with AWS KMS-managed keys (SSE-KMS). This parameter is only expected with KMS as the S3 SSE algorithm.

  • s3BucketOwner (string) – The ID of the AWS account that owns the bucket the export will be stored in.

Return type:

dict

Returns:

Response Syntax

{
    'clientToken': 'string',
    'exportArn': 'string',
    'requestedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • clientToken (string) –

      The client token that was provided in the request.

    • exportArn (string) –

      Unique ARN identifier of the export.

    • requestedAt (datetime) –

      Timestamp when the export request was received by the service.

Exceptions