Amazonka.DynamoDB.Types.ImportTableDescription

Documentation

data ImportTableDescription

Represents the properties of the table being imported into.

See: newImportTableDescription smart constructor.

Constructors

ImportTableDescription'

Fields

• clientToken :: Maybe Text

  The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

• cloudWatchLogGroupArn :: Maybe Text

  The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

• endTime :: Maybe POSIX

  The time at which the creation of the table associated with this import task completed.

• errorCount :: Maybe Natural

  The number of errors occurred on importing the source file into the target table.

• failureCode :: Maybe Text

  The error code corresponding to the failure that the import job ran into during execution.

• failureMessage :: Maybe Text

  The error message corresponding to the failure that the import job ran into during execution.

• importArn :: Maybe Text

  The Amazon Resource Number (ARN) corresponding to the import request.

• importStatus :: Maybe ImportStatus

  The status of the import.

• importedItemCount :: Maybe Natural

  The number of items successfully imported into the new table.

• inputCompressionType :: Maybe InputCompressionType

  The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

• inputFormat :: Maybe InputFormat

  The format of the source data going into the target table.

• inputFormatOptions :: Maybe InputFormatOptions

  The format options for the data that was imported into the target table. There is one value, CsvOption.

• processedItemCount :: Maybe Natural

  The total number of items processed from the source file.

• processedSizeBytes :: Maybe Integer

  The total size of data processed from the source file, in Bytes.

• s3BucketSource :: Maybe S3BucketSource

  Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

• startTime :: Maybe POSIX

  The time when this import task started.

• tableArn :: Maybe Text

  The Amazon Resource Number (ARN) of the table being imported into.

• tableCreationParameters :: Maybe TableCreationParameters

  The parameters for the new table that is being imported into.

• tableId :: Maybe Text

  The table id corresponding to the table created by import table process.

Instances

FromJSON ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Methods

parseJSON :: Value -> Parser ImportTableDescription

parseJSONList :: Value -> Parser [ImportTableDescription]

Generic ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Associated Types

type Rep ImportTableDescription :: Type -> Type

Methods

from :: ImportTableDescription -> Rep ImportTableDescription x

to :: Rep ImportTableDescription x -> ImportTableDescription

Read ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Methods

readsPrec :: Int -> ReadS ImportTableDescription

readList :: ReadS [ImportTableDescription]

readPrec :: ReadPrec ImportTableDescription

readListPrec :: ReadPrec [ImportTableDescription]

Show ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Methods

showsPrec :: Int -> ImportTableDescription -> ShowS

show :: ImportTableDescription -> String

showList :: [ImportTableDescription] -> ShowS

NFData ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Methods

rnf :: ImportTableDescription -> ()

Eq ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Methods

(==) :: ImportTableDescription -> ImportTableDescription -> Bool

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

Hashable ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

Methods

hashWithSalt :: Int -> ImportTableDescription -> Int

hash :: ImportTableDescription -> Int

type Rep ImportTableDescription

Defined in Amazonka.DynamoDB.Types.ImportTableDescription

type Rep ImportTableDescription = D1 ('MetaData "ImportTableDescription" "Amazonka.DynamoDB.Types.ImportTableDescription" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ImportTableDescription'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cloudWatchLogGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "errorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "importArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "importStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportStatus)) :*: S1 ('MetaSel ('Just "importedItemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))) :*: (((S1 ('MetaSel ('Just "inputCompressionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputCompressionType)) :*: S1 ('MetaSel ('Just "inputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormat))) :*: (S1 ('MetaSel ('Just "inputFormatOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormatOptions)) :*: (S1 ('MetaSel ('Just "processedItemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "processedSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: ((S1 ('MetaSel ('Just "s3BucketSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3BucketSource)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "tableArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tableCreationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableCreationParameters)) :*: S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newImportTableDescription :: ImportTableDescription

Create a value of ImportTableDescription 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:clientToken:ImportTableDescription', importTableDescription_clientToken - The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

$sel:cloudWatchLogGroupArn:ImportTableDescription', importTableDescription_cloudWatchLogGroupArn - The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

$sel:endTime:ImportTableDescription', importTableDescription_endTime - The time at which the creation of the table associated with this import task completed.

$sel:errorCount:ImportTableDescription', importTableDescription_errorCount - The number of errors occurred on importing the source file into the target table.

$sel:failureCode:ImportTableDescription', importTableDescription_failureCode - The error code corresponding to the failure that the import job ran into during execution.

$sel:failureMessage:ImportTableDescription', importTableDescription_failureMessage - The error message corresponding to the failure that the import job ran into during execution.

$sel:importArn:ImportTableDescription', importTableDescription_importArn - The Amazon Resource Number (ARN) corresponding to the import request.

$sel:importStatus:ImportTableDescription', importTableDescription_importStatus - The status of the import.

$sel:importedItemCount:ImportTableDescription', importTableDescription_importedItemCount - The number of items successfully imported into the new table.

$sel:inputCompressionType:ImportTableDescription', importTableDescription_inputCompressionType - The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

$sel:inputFormat:ImportTableDescription', importTableDescription_inputFormat - The format of the source data going into the target table.

$sel:inputFormatOptions:ImportTableDescription', importTableDescription_inputFormatOptions - The format options for the data that was imported into the target table. There is one value, CsvOption.

$sel:processedItemCount:ImportTableDescription', importTableDescription_processedItemCount - The total number of items processed from the source file.

$sel:processedSizeBytes:ImportTableDescription', importTableDescription_processedSizeBytes - The total size of data processed from the source file, in Bytes.

$sel:s3BucketSource:ImportTableDescription', importTableDescription_s3BucketSource - Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

$sel:startTime:ImportTableDescription', importTableDescription_startTime - The time when this import task started.

$sel:tableArn:ImportTableDescription', importTableDescription_tableArn - The Amazon Resource Number (ARN) of the table being imported into.

$sel:tableCreationParameters:ImportTableDescription', importTableDescription_tableCreationParameters - The parameters for the new table that is being imported into.

$sel:tableId:ImportTableDescription', importTableDescription_tableId - The table id corresponding to the table created by import table process.

importTableDescription_clientToken :: Lens' ImportTableDescription (Maybe Text)

The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

importTableDescription_cloudWatchLogGroupArn :: Lens' ImportTableDescription (Maybe Text)

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

importTableDescription_endTime :: Lens' ImportTableDescription (Maybe UTCTime)

The time at which the creation of the table associated with this import task completed.

importTableDescription_errorCount :: Lens' ImportTableDescription (Maybe Natural)

The number of errors occurred on importing the source file into the target table.

importTableDescription_failureCode :: Lens' ImportTableDescription (Maybe Text)

The error code corresponding to the failure that the import job ran into during execution.

importTableDescription_failureMessage :: Lens' ImportTableDescription (Maybe Text)

The error message corresponding to the failure that the import job ran into during execution.

importTableDescription_importArn :: Lens' ImportTableDescription (Maybe Text)

The Amazon Resource Number (ARN) corresponding to the import request.

importTableDescription_importStatus :: Lens' ImportTableDescription (Maybe ImportStatus)

The status of the import.

importTableDescription_importedItemCount :: Lens' ImportTableDescription (Maybe Natural)

The number of items successfully imported into the new table.

importTableDescription_inputCompressionType :: Lens' ImportTableDescription (Maybe InputCompressionType)

The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

importTableDescription_inputFormat :: Lens' ImportTableDescription (Maybe InputFormat)

The format of the source data going into the target table.

importTableDescription_inputFormatOptions :: Lens' ImportTableDescription (Maybe InputFormatOptions)

The format options for the data that was imported into the target table. There is one value, CsvOption.

importTableDescription_processedItemCount :: Lens' ImportTableDescription (Maybe Natural)

The total number of items processed from the source file.

importTableDescription_processedSizeBytes :: Lens' ImportTableDescription (Maybe Integer)

The total size of data processed from the source file, in Bytes.

importTableDescription_s3BucketSource :: Lens' ImportTableDescription (Maybe S3BucketSource)

Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

importTableDescription_startTime :: Lens' ImportTableDescription (Maybe UTCTime)

The time when this import task started.

importTableDescription_tableArn :: Lens' ImportTableDescription (Maybe Text)

The Amazon Resource Number (ARN) of the table being imported into.

importTableDescription_tableCreationParameters :: Lens' ImportTableDescription (Maybe TableCreationParameters)

The parameters for the new table that is being imported into.

importTableDescription_tableId :: Lens' ImportTableDescription (Maybe Text)

The table id corresponding to the table created by import table process.