dynamodb/aws.sdk.kotlin.services.dynamodb.model/ExportDescription

ExportDescription

class ExportDescription

Represents the properties of the exported table.

Types

Builder

class Builder

Companion

object Companion

Properties

billedSizeBytes

val billedSizeBytes: Long?

The billable size of the table export.

clientToken

val clientToken: String?

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

val endTime: Instant?

The time at which the export task completed.

exportArn

val exportArn: String?

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

exportFormat

val exportFormat: ExportFormat?

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

exportManifest

val exportManifest: String?

The name of the manifest file for the export task.

exportStatus

val exportStatus: ExportStatus?

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

exportTime

val exportTime: Instant?

Point in time from which table data was exported.

exportType

val exportType: ExportType?

The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.

failureCode

val failureCode: String?

Status code for the result of the failed export.

failureMessage

val failureMessage: String?

Export failure reason description.

incrementalExportSpecification

val incrementalExportSpecification: IncrementalExportSpecification?

Optional object containing the parameters specific to an incremental export.

itemCount

val itemCount: Long?

The number of items exported.

s3Bucket

val s3Bucket: String?

The name of the Amazon S3 bucket containing the export.

s3BucketOwner

val s3BucketOwner: String?

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

s3Prefix

val s3Prefix: String?

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

s3SseAlgorithm

val s3SseAlgorithm: S3SseAlgorithm?

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

s3SseKmsKeyId

val s3SseKmsKeyId: String?

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

startTime

val startTime: Instant?

The time at which the export task began.

tableArn

val tableArn: String?

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

tableId

val tableId: String?

Unique ID of the table that was exported.

Functions

copy

inline fun copy(block: ExportDescription.Builder.() -> Unit = {}): ExportDescription

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String