amazonka-dynamodb-2.0: Amazon DynamoDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DynamoDB.ExportTableToPointInTime

Description

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

Synopsis

Creating a Request

data ExportTableToPointInTime Source #

See: newExportTableToPointInTime smart constructor.

Constructors

ExportTableToPointInTime' 

Fields

  • clientToken :: Maybe Text

    Providing a ClientToken makes the call to ExportTableToPointInTimeInput 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, DynamoDB returns an ImportConflictException.

  • exportFormat :: Maybe ExportFormat

    The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

  • exportTime :: Maybe POSIX

    Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

  • s3BucketOwner :: Maybe Text

    The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

  • s3Prefix :: Maybe Text

    The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

  • s3SseAlgorithm :: Maybe S3SseAlgorithm

    Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

    • AES256 - server-side encryption with Amazon S3 managed keys
    • KMS - server-side encryption with KMS managed keys
  • s3SseKmsKeyId :: Maybe Text

    The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

  • tableArn :: Text

    The Amazon Resource Name (ARN) associated with the table to export.

  • s3Bucket :: Text

    The name of the Amazon S3 bucket to export the snapshot to.

Instances

Instances details
ToJSON ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

toJSON :: ExportTableToPointInTime -> Value #

toEncoding :: ExportTableToPointInTime -> Encoding #

toJSONList :: [ExportTableToPointInTime] -> Value #

toEncodingList :: [ExportTableToPointInTime] -> Encoding #

ToHeaders ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

toHeaders :: ExportTableToPointInTime -> [Header] #

ToPath ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

toPath :: ExportTableToPointInTime -> ByteString #

ToQuery ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

toQuery :: ExportTableToPointInTime -> QueryString #

AWSRequest ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Associated Types

type AWSResponse ExportTableToPointInTime #

Methods

request :: (Service -> Service) -> ExportTableToPointInTime -> Request ExportTableToPointInTime #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExportTableToPointInTime -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExportTableToPointInTime))) #

Generic ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Associated Types

type Rep ExportTableToPointInTime :: Type -> Type #

Methods

from :: ExportTableToPointInTime -> Rep ExportTableToPointInTime x #

to :: Rep ExportTableToPointInTime x -> ExportTableToPointInTime #

Read ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

readsPrec :: Int -> ReadS ExportTableToPointInTime #

readList :: ReadS [ExportTableToPointInTime] #

readPrec :: ReadPrec ExportTableToPointInTime #

readListPrec :: ReadPrec [ExportTableToPointInTime] #

Show ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

showsPrec :: Int -> ExportTableToPointInTime -> ShowS #

show :: ExportTableToPointInTime -> String #

showList :: [ExportTableToPointInTime] -> ShowS #

NFData ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

rnf :: ExportTableToPointInTime -> () #

Eq ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

(==) :: ExportTableToPointInTime -> ExportTableToPointInTime -> Bool #

(/=) :: ExportTableToPointInTime -> ExportTableToPointInTime -> Bool #

Hashable ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

hashWithSalt :: Int -> ExportTableToPointInTime -> Int #

hash :: ExportTableToPointInTime -> Int #

type AWSResponse ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

type AWSResponse ExportTableToPointInTime = ExportTableToPointInTimeResponse
type Rep ExportTableToPointInTime Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

type Rep ExportTableToPointInTime = D1 ('MetaData "ExportTableToPointInTime" "Amazonka.DynamoDB.ExportTableToPointInTime" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ExportTableToPointInTime'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "exportFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportFormat))) :*: (S1 ('MetaSel ('Just "exportTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "s3BucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "s3Prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3SseAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3SseAlgorithm))) :*: (S1 ('MetaSel ('Just "s3SseKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tableArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newExportTableToPointInTime Source #

Arguments

:: Text

ExportTableToPointInTime

-> Text

ExportTableToPointInTime

-> ExportTableToPointInTime 

Create a value of ExportTableToPointInTime with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ExportTableToPointInTime, exportTableToPointInTime_clientToken - Providing a ClientToken makes the call to ExportTableToPointInTimeInput 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, DynamoDB returns an ImportConflictException.

ExportTableToPointInTime, exportTableToPointInTime_exportFormat - The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

ExportTableToPointInTime, exportTableToPointInTime_exportTime - Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

ExportTableToPointInTime, exportTableToPointInTime_s3BucketOwner - The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

ExportTableToPointInTime, exportTableToPointInTime_s3Prefix - The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

ExportTableToPointInTime, exportTableToPointInTime_s3SseAlgorithm - Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys
  • KMS - server-side encryption with KMS managed keys

ExportTableToPointInTime, exportTableToPointInTime_s3SseKmsKeyId - The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

ExportTableToPointInTime, exportTableToPointInTime_tableArn - The Amazon Resource Name (ARN) associated with the table to export.

ExportTableToPointInTime, exportTableToPointInTime_s3Bucket - The name of the Amazon S3 bucket to export the snapshot to.

Request Lenses

exportTableToPointInTime_clientToken :: Lens' ExportTableToPointInTime (Maybe Text) Source #

Providing a ClientToken makes the call to ExportTableToPointInTimeInput 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, DynamoDB returns an ImportConflictException.

exportTableToPointInTime_exportFormat :: Lens' ExportTableToPointInTime (Maybe ExportFormat) Source #

The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

exportTableToPointInTime_exportTime :: Lens' ExportTableToPointInTime (Maybe UTCTime) Source #

Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

exportTableToPointInTime_s3BucketOwner :: Lens' ExportTableToPointInTime (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

exportTableToPointInTime_s3Prefix :: Lens' ExportTableToPointInTime (Maybe Text) Source #

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

exportTableToPointInTime_s3SseAlgorithm :: Lens' ExportTableToPointInTime (Maybe S3SseAlgorithm) Source #

Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys
  • KMS - server-side encryption with KMS managed keys

exportTableToPointInTime_s3SseKmsKeyId :: Lens' ExportTableToPointInTime (Maybe Text) Source #

The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

exportTableToPointInTime_tableArn :: Lens' ExportTableToPointInTime Text Source #

The Amazon Resource Name (ARN) associated with the table to export.

exportTableToPointInTime_s3Bucket :: Lens' ExportTableToPointInTime Text Source #

The name of the Amazon S3 bucket to export the snapshot to.

Destructuring the Response

data ExportTableToPointInTimeResponse Source #

See: newExportTableToPointInTimeResponse smart constructor.

Constructors

ExportTableToPointInTimeResponse' 

Fields

Instances

Instances details
Generic ExportTableToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Associated Types

type Rep ExportTableToPointInTimeResponse :: Type -> Type #

Methods

from :: ExportTableToPointInTimeResponse -> Rep ExportTableToPointInTimeResponse x #

to :: Rep ExportTableToPointInTimeResponse x -> ExportTableToPointInTimeResponse #

Read ExportTableToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

readsPrec :: Int -> ReadS ExportTableToPointInTimeResponse #

readList :: ReadS [ExportTableToPointInTimeResponse] #

readPrec :: ReadPrec ExportTableToPointInTimeResponse #

readListPrec :: ReadPrec [ExportTableToPointInTimeResponse] #

Show ExportTableToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

showsPrec :: Int -> ExportTableToPointInTimeResponse -> ShowS #

show :: ExportTableToPointInTimeResponse -> String #

showList :: [ExportTableToPointInTimeResponse] -> ShowS #

NFData ExportTableToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

rnf :: ExportTableToPointInTimeResponse -> () #

Eq ExportTableToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

Methods

(==) :: ExportTableToPointInTimeResponse -> ExportTableToPointInTimeResponse -> Bool #

(/=) :: ExportTableToPointInTimeResponse -> ExportTableToPointInTimeResponse -> Bool #

type Rep ExportTableToPointInTimeResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.ExportTableToPointInTime

type Rep ExportTableToPointInTimeResponse = D1 ('MetaData "ExportTableToPointInTimeResponse" "Amazonka.DynamoDB.ExportTableToPointInTime" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ExportTableToPointInTimeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exportDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newExportTableToPointInTimeResponse Source #

Arguments

:: Int

$sel:httpStatus:ExportTableToPointInTimeResponse'

-> ExportTableToPointInTimeResponse 

Create a value of ExportTableToPointInTimeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exportDescription:ExportTableToPointInTimeResponse', exportTableToPointInTimeResponse_exportDescription - Contains a description of the table export.

$sel:httpStatus:ExportTableToPointInTimeResponse', exportTableToPointInTimeResponse_httpStatus - The response's http status code.

Response Lenses

exportTableToPointInTimeResponse_exportDescription :: Lens' ExportTableToPointInTimeResponse (Maybe ExportDescription) Source #

Contains a description of the table export.

exportTableToPointInTimeResponse_httpStatus :: Lens' ExportTableToPointInTimeResponse Int Source #

The response's http status code.