Amazon SimpleDB v2

Lists all exports that were created. The results are paginated and can be filtered by domain name.

See also: AWS API Documentation

Request Syntax

client.list_exports(
    domainName='string',
    maxResults=123,
    nextToken='string'
)

type domainName:

string

param domainName:

The name of the domain to filter exports. If not provided, exports for all the domains will be listed.

type maxResults:

integer

param maxResults:

The maximum number of exports to return in a single response.

type nextToken:

string

param nextToken:

A pagination token used to retrieve the next page of results. This token is obtained from the nextToken field in the previous ListExportsResponse. Leave empty for the first request.

rtype:

dict

returns:

Response Syntax

{
    'exportSummaries': [
        {
            'exportArn': 'string',
            'exportStatus': 'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
            'requestedAt': datetime(2015, 1, 1),
            'domainName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • exportSummaries (list) --

    List of export summaries containing export ARN, status, request timestamp, and associated domain name.

    • (dict) --

      Summary information about an export, including its unique identifier, current status, creation time, and the domain being exported.

      • exportArn (string) --

        Unique ARN identifier of the export.

      • exportStatus (string) --

        The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.

      • requestedAt (datetime) --

        Timestamp when the export request was received by the service

      • domainName (string) --

        The name of the domain for which the export was created.

  • nextToken (string) --

    A pagination token indicating that more results are available. To retrieve the next page of results, provide this token in a subsequent ListExports request. If null or empty, there are no more results to retrieve.

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

See also: AWS API Documentation

Request Syntax

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

type clientToken:

string

param clientToken:

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.

type domainName:

string

param domainName:

[REQUIRED]

The name of the domain to export.

type s3Bucket:

string

param s3Bucket:

[REQUIRED]

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

type s3KeyPrefix:

string

param s3KeyPrefix:

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

type s3SseAlgorithm:

string

param 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.

type s3SseKmsKeyId:

string

param 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.

type s3BucketOwner:

string

param s3BucketOwner:

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

rtype:

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.

Returns information for an existing domain export.

See also: AWS API Documentation

Request Syntax

client.get_export(
    exportArn='string'
)

type exportArn:

string

param exportArn:

[REQUIRED]

Unique ARN identifier of the export.

rtype:

dict

returns:

Response Syntax

{
    'exportArn': 'string',
    'clientToken': 'string',
    'exportStatus': 'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'domainName': 'string',
    'requestedAt': datetime(2015, 1, 1),
    's3Bucket': 'string',
    's3KeyPrefix': 'string',
    's3SseAlgorithm': 'AES256'|'KMS',
    's3SseKmsKeyId': 'string',
    's3BucketOwner': 'string',
    'failureCode': 'string',
    'failureMessage': 'string',
    'exportManifest': 'string',
    'itemsCount': 123,
    'exportDataCutoffTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • exportArn (string) --

    Unique ARN identifier of the export.

  • clientToken (string) --

    The client token provided for this export.

  • exportStatus (string) --

    The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.

  • domainName (string) --

    The name of the domain that was exported.

  • requestedAt (datetime) --

    Timestamp when the export request was received by the service.

  • s3Bucket (string) --

    The name of the S3 bucket for this export.

  • s3KeyPrefix (string) --

    The S3 key prefix provided in the corresponding StartDomainExport request.

  • s3SseAlgorithm (string) --

    The S3 SSE encryption algorithm for this export.

  • s3SseKmsKeyId (string) --

    The KMS key ID for this export.

  • s3BucketOwner (string) --

    The S3 bucket owner account ID for this export.

  • failureCode (string) --

    Failure code for the result of the failed export.

  • failureMessage (string) --

    Export failure reason description.

  • exportManifest (string) --

    The name of the manifest summary file for the export.

  • itemsCount (integer) --

    Total number of exported items.

  • exportDataCutoffTime (datetime) --

    The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.