Skip to content

/AWS1/IF_SD2=>STARTDOMAINEXPORT()

About StartDomainExport

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

Method Signature

METHODS /AWS1/IF_SD2~STARTDOMAINEXPORT
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/SD2IDEMPOTENCYTOKEN OPTIONAL
    !IV_DOMAINNAME TYPE /AWS1/SD2DOMAINNAME OPTIONAL
    !IV_S3BUCKET TYPE /AWS1/SD2S3BUCKETNAME OPTIONAL
    !IV_S3KEYPREFIX TYPE /AWS1/SD2S3KEYPREFIX OPTIONAL
    !IV_S3SSEALGORITHM TYPE /AWS1/SD2S3SSEALGORITHM OPTIONAL
    !IV_S3SSEKMSKEYID TYPE /AWS1/SD2S3SSEKMSKEYID OPTIONAL
    !IV_S3BUCKETOWNER TYPE /AWS1/SD2AWSACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sd2startdomainexprsp
  RAISING
    /AWS1/CX_SD2CONFLICTEXCEPTION
    /AWS1/CX_SD2INVPARAMCOMBNEX
    /AWS1/CX_SD2INVPARAMVALUEEX
    /AWS1/CX_SD2NOSUCHDOMAINEX
    /AWS1/CX_SD2NUMBEREXPLIMITEXCD
    /AWS1/CX_SD2CLIENTEXC
    /AWS1/CX_SD2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/SD2DOMAINNAME /AWS1/SD2DOMAINNAME

The name of the domain to export.

iv_s3bucket TYPE /AWS1/SD2S3BUCKETNAME /AWS1/SD2S3BUCKETNAME

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

Optional arguments:

iv_clienttoken TYPE /AWS1/SD2IDEMPOTENCYTOKEN /AWS1/SD2IDEMPOTENCYTOKEN

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.

iv_s3keyprefix TYPE /AWS1/SD2S3KEYPREFIX /AWS1/SD2S3KEYPREFIX

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

iv_s3ssealgorithm TYPE /AWS1/SD2S3SSEALGORITHM /AWS1/SD2S3SSEALGORITHM

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.

iv_s3ssekmskeyid TYPE /AWS1/SD2S3SSEKMSKEYID /AWS1/SD2S3SSEKMSKEYID

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.

iv_s3bucketowner TYPE /AWS1/SD2AWSACCOUNTID /AWS1/SD2AWSACCOUNTID

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

RETURNING

oo_output TYPE REF TO /aws1/cl_sd2startdomainexprsp /AWS1/CL_SD2STARTDOMAINEXPRSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startdomainexport(
  iv_clienttoken = |string|
  iv_domainname = |string|
  iv_s3bucket = |string|
  iv_s3bucketowner = |string|
  iv_s3keyprefix = |string|
  iv_s3ssealgorithm = |string|
  iv_s3ssekmskeyid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_idempotencytoken = lo_result->get_clienttoken( ).
  lv_exportarn = lo_result->get_exportarn( ).
  lv_requestedat = lo_result->get_requestedat( ).
ENDIF.

Start a domain export

Start a domain export

DATA(lo_result) = lo_client->startdomainexport(
  iv_domainname = |my-domain|
  iv_s3bucket = |my-export-bucket|
).