Amazonka.DynamoDB.Types.ExportDescription

Documentation

data ExportDescription

Represents the properties of the exported table.

See: newExportDescription smart constructor.

Constructors

ExportDescription'

Fields

• billedSizeBytes :: Maybe Natural

  The billable size of the table export.

• clientToken :: Maybe Text

  The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

• endTime :: Maybe POSIX

  The time at which the export task completed.

• exportArn :: Maybe Text

  The Amazon Resource Name (ARN) of the table export.

• exportFormat :: Maybe ExportFormat

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

• exportManifest :: Maybe Text

  The name of the manifest file for the export task.

• exportStatus :: Maybe ExportStatus

  Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

• exportTime :: Maybe POSIX

  Point in time from which table data was exported.

• failureCode :: Maybe Text

  Status code for the result of the failed export.

• failureMessage :: Maybe Text

  Export failure reason description.

• itemCount :: Maybe Natural

  The number of items exported.

• s3Bucket :: Maybe Text

  The name of the Amazon S3 bucket containing the export.

• s3BucketOwner :: Maybe Text

  The ID of the Amazon Web Services account that owns the bucket containing the export.

• s3Prefix :: Maybe Text

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

• s3SseAlgorithm :: Maybe S3SseAlgorithm

  Type of encryption used on the bucket where export data is 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 is stored (if applicable).

• startTime :: Maybe POSIX

  The time at which the export task began.

• tableArn :: Maybe Text

  The Amazon Resource Name (ARN) of the table that was exported.

• tableId :: Maybe Text

  Unique ID of the table that was exported.

Instances

FromJSON ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Methods

parseJSON :: Value -> Parser ExportDescription

parseJSONList :: Value -> Parser [ExportDescription]

Generic ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Associated Types

type Rep ExportDescription :: Type -> Type

Methods

from :: ExportDescription -> Rep ExportDescription x

to :: Rep ExportDescription x -> ExportDescription

Read ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Methods

readsPrec :: Int -> ReadS ExportDescription

readList :: ReadS [ExportDescription]

readPrec :: ReadPrec ExportDescription

readListPrec :: ReadPrec [ExportDescription]

Show ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Methods

showsPrec :: Int -> ExportDescription -> ShowS

show :: ExportDescription -> String

showList :: [ExportDescription] -> ShowS

NFData ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Methods

rnf :: ExportDescription -> ()

Eq ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Methods

(==) :: ExportDescription -> ExportDescription -> Bool

(/=) :: ExportDescription -> ExportDescription -> Bool

Hashable ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

Methods

hashWithSalt :: Int -> ExportDescription -> Int

hash :: ExportDescription -> Int

type Rep ExportDescription

Defined in Amazonka.DynamoDB.Types.ExportDescription

type Rep ExportDescription = D1 ('MetaData "ExportDescription" "Amazonka.DynamoDB.Types.ExportDescription" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ExportDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "billedSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "exportArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "exportFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportFormat)) :*: S1 ('MetaSel ('Just "exportManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "exportStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportStatus)) :*: (S1 ('MetaSel ('Just "exportTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "failureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (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 "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "tableArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newExportDescription :: ExportDescription

Create a value of ExportDescription 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:billedSizeBytes:ExportDescription', exportDescription_billedSizeBytes - The billable size of the table export.

$sel:clientToken:ExportDescription', exportDescription_clientToken - The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

$sel:endTime:ExportDescription', exportDescription_endTime - The time at which the export task completed.

$sel:exportArn:ExportDescription', exportDescription_exportArn - The Amazon Resource Name (ARN) of the table export.

$sel:exportFormat:ExportDescription', exportDescription_exportFormat - The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

$sel:exportManifest:ExportDescription', exportDescription_exportManifest - The name of the manifest file for the export task.

$sel:exportStatus:ExportDescription', exportDescription_exportStatus - Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

$sel:exportTime:ExportDescription', exportDescription_exportTime - Point in time from which table data was exported.

$sel:failureCode:ExportDescription', exportDescription_failureCode - Status code for the result of the failed export.

$sel:failureMessage:ExportDescription', exportDescription_failureMessage - Export failure reason description.

$sel:itemCount:ExportDescription', exportDescription_itemCount - The number of items exported.

$sel:s3Bucket:ExportDescription', exportDescription_s3Bucket - The name of the Amazon S3 bucket containing the export.

$sel:s3BucketOwner:ExportDescription', exportDescription_s3BucketOwner - The ID of the Amazon Web Services account that owns the bucket containing the export.

$sel:s3Prefix:ExportDescription', exportDescription_s3Prefix - The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.

$sel:s3SseAlgorithm:ExportDescription', exportDescription_s3SseAlgorithm - Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:

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

$sel:s3SseKmsKeyId:ExportDescription', exportDescription_s3SseKmsKeyId - The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).

$sel:startTime:ExportDescription', exportDescription_startTime - The time at which the export task began.

$sel:tableArn:ExportDescription', exportDescription_tableArn - The Amazon Resource Name (ARN) of the table that was exported.

$sel:tableId:ExportDescription', exportDescription_tableId - Unique ID of the table that was exported.

exportDescription_billedSizeBytes :: Lens' ExportDescription (Maybe Natural)

The billable size of the table export.

exportDescription_clientToken :: Lens' ExportDescription (Maybe Text)

The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

exportDescription_endTime :: Lens' ExportDescription (Maybe UTCTime)

The time at which the export task completed.

exportDescription_exportArn :: Lens' ExportDescription (Maybe Text)

The Amazon Resource Name (ARN) of the table export.

exportDescription_exportFormat :: Lens' ExportDescription (Maybe ExportFormat)

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

exportDescription_exportManifest :: Lens' ExportDescription (Maybe Text)

The name of the manifest file for the export task.

exportDescription_exportStatus :: Lens' ExportDescription (Maybe ExportStatus)

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

exportDescription_exportTime :: Lens' ExportDescription (Maybe UTCTime)

Point in time from which table data was exported.

exportDescription_failureCode :: Lens' ExportDescription (Maybe Text)

Status code for the result of the failed export.

exportDescription_failureMessage :: Lens' ExportDescription (Maybe Text)

Export failure reason description.

exportDescription_itemCount :: Lens' ExportDescription (Maybe Natural)

The number of items exported.

exportDescription_s3Bucket :: Lens' ExportDescription (Maybe Text)

The name of the Amazon S3 bucket containing the export.

exportDescription_s3BucketOwner :: Lens' ExportDescription (Maybe Text)

The ID of the Amazon Web Services account that owns the bucket containing the export.

exportDescription_s3Prefix :: Lens' ExportDescription (Maybe Text)

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

exportDescription_s3SseAlgorithm :: Lens' ExportDescription (Maybe S3SseAlgorithm)

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

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

exportDescription_s3SseKmsKeyId :: Lens' ExportDescription (Maybe Text)

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

exportDescription_startTime :: Lens' ExportDescription (Maybe UTCTime)

The time at which the export task began.

exportDescription_tableArn :: Lens' ExportDescription (Maybe Text)

The Amazon Resource Name (ARN) of the table that was exported.

exportDescription_tableId :: Lens' ExportDescription (Maybe Text)

Unique ID of the table that was exported.