SDK for PHP V3

Amazon SimpleDB v2 2025-09-26

Client: Aws\SimpleDBv2\SimpleDBv2Client
Service ID: simpledbv2
Version: 2025-09-26

This page describes the parameters and results for the operations of the Amazon SimpleDB v2 (2025-09-26), and shows how to use the Aws\SimpleDBv2\SimpleDBv2Client object to call the described operations. This documentation is specific to the 2025-09-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetExport ( array $params = [] )
Returns information for an existing domain export.
ListExports ( array $params = [] )
Lists all exports that were created.
StartDomainExport ( array $params = [] )
Initiates the export of a SimpleDB domain to an S3 bucket.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListExports

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
ExportSucceeded GetExport 30 5

Operations

GetExport 

$result = $client->getExport([/* ... */]);
$promise = $client->getExportAsync([/* ... */]);

Returns information for an existing domain export.

Parameter Syntax

$result = $client->getExport([
    'exportArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
exportArn
Required: Yes
Type: string

Unique ARN identifier of the export.

Result Syntax

[
    'clientToken' => '<string>',
    'domainName' => '<string>',
    'exportArn' => '<string>',
    'exportDataCutoffTime' => <DateTime>,
    'exportManifest' => '<string>',
    'exportStatus' => 'PENDING|IN_PROGRESS|SUCCEEDED|FAILED',
    'failureCode' => '<string>',
    'failureMessage' => '<string>',
    'itemsCount' => <integer>,
    'requestedAt' => <DateTime>,
    's3Bucket' => '<string>',
    's3BucketOwner' => '<string>',
    's3KeyPrefix' => '<string>',
    's3SseAlgorithm' => 'AES256|KMS',
    's3SseKmsKeyId' => '<string>',
]

Result Details

Members
clientToken
Required: Yes
Type: string

The client token provided for this export.

domainName
Required: Yes
Type: string

The name of the domain that was exported.

exportArn
Required: Yes
Type: string

Unique ARN identifier of the export.

exportDataCutoffTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

exportManifest
Type: string

The name of the manifest summary file for the export.

exportStatus
Required: Yes
Type: 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.

failureCode
Type: string

Failure code for the result of the failed export.

failureMessage
Type: string

Export failure reason description.

itemsCount
Type: long (int|float)

Total number of exported items.

requestedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp when the export request was received by the service.

s3Bucket
Required: Yes
Type: string

The name of the S3 bucket for this export.

s3BucketOwner
Type: string

The S3 bucket owner account ID for this export.

s3KeyPrefix
Type: string

The S3 key prefix provided in the corresponding StartDomainExport request.

s3SseAlgorithm
Type: string

The S3 SSE encryption algorithm for this export.

s3SseKmsKeyId
Type: string

The KMS key ID for this export.

Errors

NoSuchExportException:

Export with specified ARN does not exist.

InvalidParameterValueException:

The specified parameter value is not valid.

Examples

Example 1: Get export details 
$result = $client->getExport([
    'exportArn' => 'arn:aws:sdb:us-east-1:123456789012:export/abc123',
]);

Result syntax:

[
    'clientToken' => 'abc123-def456-ghi789',
    'domainName' => 'my-domain',
    'exportArn' => 'arn:aws:sdb:us-east-1:123456789012:export/abc123',
    'exportDataCutoffTime' => ,
    'exportStatus' => 'SUCCEEDED',
    'requestedAt' => ,
    's3Bucket' => 'my-export-bucket',
]

ListExports 

$result = $client->listExports([/* ... */]);
$promise = $client->listExportsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listExports([
    'domainName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
domainName
Type: string

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

maxResults
Type: int

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

nextToken
Type: string

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.

Result Syntax

[
    'exportSummaries' => [
        [
            'domainName' => '<string>',
            'exportArn' => '<string>',
            'exportStatus' => 'PENDING|IN_PROGRESS|SUCCEEDED|FAILED',
            'requestedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
exportSummaries
Required: Yes
Type: Array of ExportSummary structures

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

nextToken
Type: 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.

Errors

InvalidNextTokenException:

The specified next token is not valid.

InvalidParameterValueException:

The specified parameter value is not valid.

NoSuchDomainException:

The specified domain does not exist.

Examples

Example 1: List all exports 
$result = $client->listExports([
]);

Result syntax:

[
    'exportSummaries' => [
        [
            'domainName' => 'my-domain',
            'exportArn' => 'arn:aws:sdb:us-east-1:123456789012:export/abc123',
            'exportStatus' => 'SUCCEEDED',
            'requestedAt' => ,
        ],
    ],
]

StartDomainExport 

$result = $client->startDomainExport([/* ... */]);
$promise = $client->startDomainExportAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startDomainExport([
    'clientToken' => '<string>',
    'domainName' => '<string>', // REQUIRED
    's3Bucket' => '<string>', // REQUIRED
    's3BucketOwner' => '<string>',
    's3KeyPrefix' => '<string>',
    's3SseAlgorithm' => 'AES256|KMS',
    's3SseKmsKeyId' => '<string>',
]);

Parameter Details

Members
clientToken
Type: 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.

domainName
Required: Yes
Type: string

The name of the domain to export.

s3Bucket
Required: Yes
Type: string

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

s3BucketOwner
Type: string

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

s3KeyPrefix
Type: string

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

s3SseAlgorithm
Type: 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
Type: 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.

Result Syntax

[
    'clientToken' => '<string>',
    'exportArn' => '<string>',
    'requestedAt' => <DateTime>,
]

Result Details

Members
clientToken
Required: Yes
Type: string

The client token that was provided in the request.

exportArn
Required: Yes
Type: string

Unique ARN identifier of the export.

requestedAt
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp when the export request was received by the service.

Errors

InvalidParameterCombinationException:

Parameters that must not be used together were used together in the request.

InvalidParameterValueException:

The specified parameter value is not valid.

ConflictException:

Indicates a conflict with one or more parameters of the request.

NumberExportsLimitExceeded:

Cannot start export as export quota limit was exceeded

NoSuchDomainException:

The specified domain does not exist.

Examples

Example 1: Start a domain export 
$result = $client->startDomainExport([
    'domainName' => 'my-domain',
    's3Bucket' => 'my-export-bucket',
]);

Result syntax:

[
    'clientToken' => 'abc123-def456-ghi789',
    'exportArn' => 'arn:aws:sdb:us-east-1:123456789012:export/abc123',
    'requestedAt' => ,
]

Shapes

ConflictException

Description

Indicates a conflict with one or more parameters of the request.

Members
message
Required: Yes
Type: string

ExportSummary

Description

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

Members
domainName
Required: Yes
Type: string

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

exportArn
Required: Yes
Type: string

Unique ARN identifier of the export.

exportStatus
Required: Yes
Type: 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
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp when the export request was received by the service

InvalidNextTokenException

Description

The specified next token is not valid.

Members
message
Required: Yes
Type: string

InvalidParameterCombinationException

Description

Parameters that must not be used together were used together in the request.

Members
message
Required: Yes
Type: string

InvalidParameterValueException

Description

The specified parameter value is not valid.

Members
message
Required: Yes
Type: string

NoSuchDomainException

Description

The specified domain does not exist.

Members
message
Required: Yes
Type: string

NoSuchExportException

Description

Export with specified ARN does not exist.

Members
message
Required: Yes
Type: string

NumberExportsLimitExceeded

Description

Cannot start export as export quota limit was exceeded

Members
message
Required: Yes
Type: string