Skip to content

StartDomainExportRequest

Source code in docs_src/capo_simpledbv2/types/start_domain_export_request.py
class StartDomainExportRequest(TypedDict, closed=True):
    client_token: NotRequired[
        "capo_simpledbv2.types.idempotency_token.IdempotencyToken"
    ]
    """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."""
    domain_name: "capo_simpledbv2.types.domain_name.DomainName"
    """The name of the domain to export."""
    s3_bucket: "capo_simpledbv2.types.s3_bucket_name.S3BucketName"
    """The name of the S3 bucket where the domain data will be exported."""
    s3_key_prefix: NotRequired["capo_simpledbv2.types.s3_key_prefix.S3KeyPrefix"]
    """The prefix string to be used to generate the S3 object keys for export artifacts."""
    s3_sse_algorithm: NotRequired[
        "capo_simpledbv2.types.s3_sse_algorithm.S3SseAlgorithm"
    ]
    """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."""
    s3_sse_kms_key_id: NotRequired[
        "capo_simpledbv2.types.s3_sse_kms_key_id.S3SseKmsKeyId"
    ]
    """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."""
    s3_bucket_owner: NotRequired["capo_simpledbv2.types.aws_account_id.AwsAccountId"]
    """The ID of the AWS account that owns the bucket the export will be stored in."""

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

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.

domain_name instance-attribute

domain_name: DomainName

The name of the domain to export.

s3_bucket instance-attribute

s3_bucket: S3BucketName

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

s3_bucket_owner instance-attribute

s3_bucket_owner: NotRequired[AwsAccountId]

The ID of the AWS account that owns the bucket the export will be stored in.

s3_key_prefix instance-attribute

s3_key_prefix: NotRequired[S3KeyPrefix]

The prefix string to be used to generate the S3 object keys for export artifacts.

s3_sse_algorithm instance-attribute

s3_sse_algorithm: NotRequired[S3SseAlgorithm]

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.

s3_sse_kms_key_id instance-attribute

s3_sse_kms_key_id: NotRequired[S3SseKmsKeyId]

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.