Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data ExportTableToPointInTime = ExportTableToPointInTime' {}
- newExportTableToPointInTime :: Text -> Text -> ExportTableToPointInTime
- exportTableToPointInTime_clientToken :: Lens' ExportTableToPointInTime (Maybe Text)
- exportTableToPointInTime_exportFormat :: Lens' ExportTableToPointInTime (Maybe ExportFormat)
- exportTableToPointInTime_exportTime :: Lens' ExportTableToPointInTime (Maybe UTCTime)
- exportTableToPointInTime_s3BucketOwner :: Lens' ExportTableToPointInTime (Maybe Text)
- exportTableToPointInTime_s3Prefix :: Lens' ExportTableToPointInTime (Maybe Text)
- exportTableToPointInTime_s3SseAlgorithm :: Lens' ExportTableToPointInTime (Maybe S3SseAlgorithm)
- exportTableToPointInTime_s3SseKmsKeyId :: Lens' ExportTableToPointInTime (Maybe Text)
- exportTableToPointInTime_tableArn :: Lens' ExportTableToPointInTime Text
- exportTableToPointInTime_s3Bucket :: Lens' ExportTableToPointInTime Text
- data ExportTableToPointInTimeResponse = ExportTableToPointInTimeResponse' {}
- newExportTableToPointInTimeResponse :: Int -> ExportTableToPointInTimeResponse
- exportTableToPointInTimeResponse_exportDescription :: Lens' ExportTableToPointInTimeResponse (Maybe ExportDescription)
- exportTableToPointInTimeResponse_httpStatus :: Lens' ExportTableToPointInTimeResponse Int
Creating a Request
data ExportTableToPointInTime Source #
See: newExportTableToPointInTime
smart constructor.
ExportTableToPointInTime' | |
|
Instances
newExportTableToPointInTime Source #
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 keysKMS
- 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 keysKMS
- 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.
ExportTableToPointInTimeResponse' | |
|
Instances
Generic ExportTableToPointInTimeResponse Source # | |
Read ExportTableToPointInTimeResponse Source # | |
Show ExportTableToPointInTimeResponse Source # | |
NFData ExportTableToPointInTimeResponse Source # | |
Defined in Amazonka.DynamoDB.ExportTableToPointInTime rnf :: ExportTableToPointInTimeResponse -> () # | |
Eq ExportTableToPointInTimeResponse Source # | |
type Rep ExportTableToPointInTimeResponse Source # | |
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 #
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.