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

Amazonka.DynamoDB.ImportTable

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports table data from an S3 bucket.

Synopsis

Creating a Request

data ImportTable Source #

See: newImportTable smart constructor.

Constructors

ImportTable'

Fields

clientToken :: Maybe Text
Providing a ClientToken makes the call to ImportTableInput 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 IdempotentParameterMismatch exception.
inputCompressionType :: Maybe InputCompressionType
Type of compression to be used on the input coming from the imported table.
inputFormatOptions :: Maybe InputFormatOptions
Additional properties that specify how the input is formatted,
s3BucketSource :: S3BucketSource
The S3 bucket that provides the source for the import.
inputFormat :: InputFormat
The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.
tableCreationParameters :: TableCreationParameters
Parameters for the table to import the data into.

Instances

Instances details

ToJSON ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods toJSON :: ImportTable -> Value # toEncoding :: ImportTable -> Encoding # toJSONList :: [ImportTable] -> Value # toEncodingList :: [ImportTable] -> Encoding #
ToHeaders ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods toHeaders :: ImportTable -> [Header] #
ToPath ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods toPath :: ImportTable -> ByteString #
ToQuery ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods toQuery :: ImportTable -> QueryString #
AWSRequest ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Associated Types type AWSResponse ImportTable # Methods request :: (Service -> Service) -> ImportTable -> Request ImportTable # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportTable -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportTable))) #
Generic ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Associated Types type Rep ImportTable :: Type -> Type # Methods from :: ImportTable -> Rep ImportTable x # to :: Rep ImportTable x -> ImportTable #
Read ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods readsPrec :: Int -> ReadS ImportTable # readList :: ReadS [ImportTable] # readPrec :: ReadPrec ImportTable # readListPrec :: ReadPrec [ImportTable] #
Show ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods showsPrec :: Int -> ImportTable -> ShowS # show :: ImportTable -> String # showList :: [ImportTable] -> ShowS #
NFData ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods rnf :: ImportTable -> () #
Eq ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods (==) :: ImportTable -> ImportTable -> Bool # (/=) :: ImportTable -> ImportTable -> Bool #
Hashable ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods hashWithSalt :: Int -> ImportTable -> Int # hash :: ImportTable -> Int #
type AWSResponse ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable type AWSResponse ImportTable = ImportTableResponse
type Rep ImportTable Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable type Rep ImportTable = D1 ('MetaData "ImportTable" "Amazonka.DynamoDB.ImportTable" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ImportTable'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "inputCompressionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputCompressionType)) :: S1 ('MetaSel ('Just "inputFormatOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFormatOptions)))) :: (S1 ('MetaSel ('Just "s3BucketSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3BucketSource) :: (S1 ('MetaSel ('Just "inputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputFormat) :*: S1 ('MetaSel ('Just "tableCreationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TableCreationParameters)))))

newImportTable Source #

Arguments

:: S3BucketSource	`ImportTable`
-> InputFormat	`ImportTable`
-> TableCreationParameters	`ImportTable`
-> ImportTable

Create a value of ImportTable 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:

ImportTable, importTable_clientToken - Providing a ClientToken makes the call to ImportTableInput 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 IdempotentParameterMismatch exception.

ImportTable, importTable_inputCompressionType - Type of compression to be used on the input coming from the imported table.

ImportTable, importTable_inputFormatOptions - Additional properties that specify how the input is formatted,

ImportTable, importTable_s3BucketSource - The S3 bucket that provides the source for the import.

ImportTable, importTable_inputFormat - The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

ImportTable, importTable_tableCreationParameters - Parameters for the table to import the data into.

Request Lenses

importTable_clientToken :: Lens' ImportTable (Maybe Text) Source #

Providing a ClientToken makes the call to ImportTableInput 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 IdempotentParameterMismatch exception.

importTable_inputCompressionType :: Lens' ImportTable (Maybe InputCompressionType) Source #

Type of compression to be used on the input coming from the imported table.

importTable_inputFormatOptions :: Lens' ImportTable (Maybe InputFormatOptions) Source #

Additional properties that specify how the input is formatted,

importTable_s3BucketSource :: Lens' ImportTable S3BucketSource Source #

The S3 bucket that provides the source for the import.

importTable_inputFormat :: Lens' ImportTable InputFormat Source #

The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

importTable_tableCreationParameters :: Lens' ImportTable TableCreationParameters Source #

Parameters for the table to import the data into.

Destructuring the Response

data ImportTableResponse Source #

See: newImportTableResponse smart constructor.

Constructors

ImportTableResponse'
Fields httpStatus :: Int The response's http status code. importTableDescription :: ImportTableDescription Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.

Instances

Instances details

Generic ImportTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Associated Types type Rep ImportTableResponse :: Type -> Type # Methods from :: ImportTableResponse -> Rep ImportTableResponse x # to :: Rep ImportTableResponse x -> ImportTableResponse #
Read ImportTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods readsPrec :: Int -> ReadS ImportTableResponse # readList :: ReadS [ImportTableResponse] # readPrec :: ReadPrec ImportTableResponse # readListPrec :: ReadPrec [ImportTableResponse] #
Show ImportTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods showsPrec :: Int -> ImportTableResponse -> ShowS # show :: ImportTableResponse -> String # showList :: [ImportTableResponse] -> ShowS #
NFData ImportTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods rnf :: ImportTableResponse -> () #
Eq ImportTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable Methods (==) :: ImportTableResponse -> ImportTableResponse -> Bool # (/=) :: ImportTableResponse -> ImportTableResponse -> Bool #
type Rep ImportTableResponse Source #
Instance details Defined in Amazonka.DynamoDB.ImportTable type Rep ImportTableResponse = D1 ('MetaData "ImportTableResponse" "Amazonka.DynamoDB.ImportTable" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ImportTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "importTableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImportTableDescription)))

newImportTableResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportTableResponse'`
-> ImportTableDescription	`$sel:importTableDescription:ImportTableResponse'`
-> ImportTableResponse

Create a value of ImportTableResponse 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:httpStatus:ImportTableResponse', importTableResponse_httpStatus - The response's http status code.

$sel:importTableDescription:ImportTableResponse', importTableResponse_importTableDescription - Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.

Response Lenses

importTableResponse_httpStatus :: Lens' ImportTableResponse Int Source #

The response's http status code.

importTableResponse_importTableDescription :: Lens' ImportTableResponse ImportTableDescription Source #

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.