Class ExportDescription

    • Method Detail

      • exportArn

        public final String exportArn()

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

        Returns:
        The Amazon Resource Name (ARN) of the table export.
      • exportStatus

        public final ExportStatus exportStatus()

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

        If the service returns an enum value that is not available in the current SDK version, exportStatus will return ExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportStatusAsString().

        Returns:
        Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
        See Also:
        ExportStatus
      • exportStatusAsString

        public final String exportStatusAsString()

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

        If the service returns an enum value that is not available in the current SDK version, exportStatus will return ExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportStatusAsString().

        Returns:
        Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
        See Also:
        ExportStatus
      • startTime

        public final Instant startTime()

        The time at which the export task began.

        Returns:
        The time at which the export task began.
      • endTime

        public final Instant endTime()

        The time at which the export task completed.

        Returns:
        The time at which the export task completed.
      • exportManifest

        public final String exportManifest()

        The name of the manifest file for the export task.

        Returns:
        The name of the manifest file for the export task.
      • tableArn

        public final String tableArn()

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

        Returns:
        The Amazon Resource Name (ARN) of the table that was exported.
      • tableId

        public final String tableId()

        Unique ID of the table that was exported.

        Returns:
        Unique ID of the table that was exported.
      • exportTime

        public final Instant exportTime()

        Point in time from which table data was exported.

        Returns:
        Point in time from which table data was exported.
      • clientToken

        public final String 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.

        Returns:
        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.
      • s3Bucket

        public final String s3Bucket()

        The name of the Amazon S3 bucket containing the export.

        Returns:
        The name of the Amazon S3 bucket containing the export.
      • s3BucketOwner

        public final String s3BucketOwner()

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

        Returns:
        The ID of the Amazon Web Services account that owns the bucket containing the export.
      • s3Prefix

        public final String s3Prefix()

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

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

        public final S3SseAlgorithm 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

        If the service returns an enum value that is not available in the current SDK version, s3SseAlgorithm will return S3SseAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3SseAlgorithmAsString().

        Returns:
        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

        See Also:
        S3SseAlgorithm
      • s3SseAlgorithmAsString

        public final String s3SseAlgorithmAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, s3SseAlgorithm will return S3SseAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3SseAlgorithmAsString().

        Returns:
        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

        See Also:
        S3SseAlgorithm
      • s3SseKmsKeyId

        public final String s3SseKmsKeyId()

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

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

        public final String failureCode()

        Status code for the result of the failed export.

        Returns:
        Status code for the result of the failed export.
      • failureMessage

        public final String failureMessage()

        Export failure reason description.

        Returns:
        Export failure reason description.
      • exportFormat

        public final ExportFormat exportFormat()

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

        If the service returns an enum value that is not available in the current SDK version, exportFormat will return ExportFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportFormatAsString().

        Returns:
        The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
        See Also:
        ExportFormat
      • exportFormatAsString

        public final String exportFormatAsString()

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

        If the service returns an enum value that is not available in the current SDK version, exportFormat will return ExportFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportFormatAsString().

        Returns:
        The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
        See Also:
        ExportFormat
      • billedSizeBytes

        public final Long billedSizeBytes()

        The billable size of the table export.

        Returns:
        The billable size of the table export.
      • itemCount

        public final Long itemCount()

        The number of items exported.

        Returns:
        The number of items exported.
      • exportType

        public final ExportType exportType()

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

        If the service returns an enum value that is not available in the current SDK version, exportType will return ExportType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportTypeAsString().

        Returns:
        The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
        See Also:
        ExportType
      • exportTypeAsString

        public final String exportTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, exportType will return ExportType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportTypeAsString().

        Returns:
        The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
        See Also:
        ExportType
      • incrementalExportSpecification

        public final IncrementalExportSpecification incrementalExportSpecification()

        Optional object containing the parameters specific to an incremental export.

        Returns:
        Optional object containing the parameters specific to an incremental export.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)