Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LexModels.StartImport

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a job to import a resource to Amazon Lex.

Synopsis

data StartImport = StartImport' {
- tags :: Maybe [Tag]
- payload :: Base64
- resourceType :: ResourceType
- mergeStrategy :: MergeStrategy
}
newStartImport :: ByteString -> ResourceType -> MergeStrategy -> StartImport
startImport_tags :: Lens' StartImport (Maybe [Tag])
startImport_payload :: Lens' StartImport ByteString
startImport_resourceType :: Lens' StartImport ResourceType
startImport_mergeStrategy :: Lens' StartImport MergeStrategy
data StartImportResponse = StartImportResponse' {
- resourceType :: Maybe ResourceType
- importId :: Maybe Text
- createdDate :: Maybe POSIX
- name :: Maybe Text
- mergeStrategy :: Maybe MergeStrategy
- importStatus :: Maybe ImportStatus
- tags :: Maybe [Tag]
- httpStatus :: Int
}
newStartImportResponse :: Int -> StartImportResponse
startImportResponse_resourceType :: Lens' StartImportResponse (Maybe ResourceType)
startImportResponse_importId :: Lens' StartImportResponse (Maybe Text)
startImportResponse_createdDate :: Lens' StartImportResponse (Maybe UTCTime)
startImportResponse_name :: Lens' StartImportResponse (Maybe Text)
startImportResponse_mergeStrategy :: Lens' StartImportResponse (Maybe MergeStrategy)
startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus)
startImportResponse_tags :: Lens' StartImportResponse (Maybe [Tag])
startImportResponse_httpStatus :: Lens' StartImportResponse Int

Creating a Request

data StartImport Source #

See: newStartImport smart constructor.

Constructors

StartImport'

Fields

tags :: Maybe [Tag]
A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.
payload :: Base64
A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.
resourceType :: ResourceType
Specifies the type of resource to export. Each resource also exports any resources that it depends on.
- A bot exports dependent intents.
- An intent exports dependent slot types.
mergeStrategy :: MergeStrategy
Specifies the action that the StartImport operation should take when there is an existing resource with the same name.
- FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.
  OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Instances

Instances details

Eq StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods (==) :: StartImport -> StartImport -> Bool # (/=) :: StartImport -> StartImport -> Bool #
Read StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods readsPrec :: Int -> ReadS StartImport # readList :: ReadS [StartImport] # readPrec :: ReadPrec StartImport # readListPrec :: ReadPrec [StartImport] #
Show StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods showsPrec :: Int -> StartImport -> ShowS # show :: StartImport -> String # showList :: [StartImport] -> ShowS #
Generic StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Associated Types type Rep StartImport :: Type -> Type # Methods from :: StartImport -> Rep StartImport x # to :: Rep StartImport x -> StartImport #
NFData StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods rnf :: StartImport -> () #
Hashable StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods hashWithSalt :: Int -> StartImport -> Int # hash :: StartImport -> Int #
ToJSON StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods toJSON :: StartImport -> Value # toEncoding :: StartImport -> Encoding # toJSONList :: [StartImport] -> Value # toEncodingList :: [StartImport] -> Encoding #
AWSRequest StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Associated Types type AWSResponse StartImport # Methods request :: StartImport -> Request StartImport # response :: MonadResource m => Logger -> Service -> Proxy StartImport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartImport))) #
ToHeaders StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods toHeaders :: StartImport -> [Header] #
ToPath StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods toPath :: StartImport -> ByteString #
ToQuery StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods toQuery :: StartImport -> QueryString #
type Rep StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport type Rep StartImport = D1 ('MetaData "StartImport" "Amazonka.LexModels.StartImport" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "StartImport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType) :*: S1 ('MetaSel ('Just "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MergeStrategy))))
type AWSResponse StartImport Source #
Instance details Defined in Amazonka.LexModels.StartImport type AWSResponse StartImport = StartImportResponse

newStartImport Source #

Arguments

:: ByteString	`$sel:payload:StartImport'`
-> ResourceType	`$sel:resourceType:StartImport'`
-> MergeStrategy	`$sel:mergeStrategy:StartImport'`
-> StartImport

Create a value of StartImport 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:tags:StartImport', startImport_tags - A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

$sel:payload:StartImport', startImport_payload - A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:resourceType:StartImport', startImport_resourceType - Specifies the type of resource to export. Each resource also exports any resources that it depends on.

A bot exports dependent intents.
An intent exports dependent slot types.

$sel:mergeStrategy:StartImport', startImport_mergeStrategy - Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.
OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Request Lenses

startImport_tags :: Lens' StartImport (Maybe [Tag]) Source #

A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

startImport_payload :: Lens' StartImport ByteString Source #

A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

startImport_resourceType :: Lens' StartImport ResourceType Source #

Specifies the type of resource to export. Each resource also exports any resources that it depends on.

A bot exports dependent intents.
An intent exports dependent slot types.

startImport_mergeStrategy :: Lens' StartImport MergeStrategy Source #

Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.
OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Destructuring the Response

data StartImportResponse Source #

See: newStartImportResponse smart constructor.

Constructors

StartImportResponse'

Fields

resourceType :: Maybe ResourceType
The type of resource to import.
importId :: Maybe Text
The identifier for the specific import job.
createdDate :: Maybe POSIX
A timestamp for the date and time that the import job was requested.
name :: Maybe Text
The name given to the import job.
mergeStrategy :: Maybe MergeStrategy
The action to take when there is a merge conflict.
importStatus :: Maybe ImportStatus
The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.
tags :: Maybe [Tag]
A list of tags added to the imported bot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq StartImportResponse Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods (==) :: StartImportResponse -> StartImportResponse -> Bool # (/=) :: StartImportResponse -> StartImportResponse -> Bool #
Read StartImportResponse Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods readsPrec :: Int -> ReadS StartImportResponse # readList :: ReadS [StartImportResponse] # readPrec :: ReadPrec StartImportResponse # readListPrec :: ReadPrec [StartImportResponse] #
Show StartImportResponse Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods showsPrec :: Int -> StartImportResponse -> ShowS # show :: StartImportResponse -> String # showList :: [StartImportResponse] -> ShowS #
Generic StartImportResponse Source #
Instance details Defined in Amazonka.LexModels.StartImport Associated Types type Rep StartImportResponse :: Type -> Type # Methods from :: StartImportResponse -> Rep StartImportResponse x # to :: Rep StartImportResponse x -> StartImportResponse #
NFData StartImportResponse Source #
Instance details Defined in Amazonka.LexModels.StartImport Methods rnf :: StartImportResponse -> () #
type Rep StartImportResponse Source #
Instance details Defined in Amazonka.LexModels.StartImport type Rep StartImportResponse = D1 ('MetaData "StartImportResponse" "Amazonka.LexModels.StartImport" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "StartImportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: S1 ('MetaSel ('Just "importId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MergeStrategy)) :: S1 ('MetaSel ('Just "importStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportStatus))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartImportResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartImportResponse'`
-> StartImportResponse

Create a value of StartImportResponse 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:resourceType:StartImport', startImportResponse_resourceType - The type of resource to import.

$sel:importId:StartImportResponse', startImportResponse_importId - The identifier for the specific import job.

$sel:createdDate:StartImportResponse', startImportResponse_createdDate - A timestamp for the date and time that the import job was requested.

$sel:name:StartImportResponse', startImportResponse_name - The name given to the import job.

$sel:mergeStrategy:StartImport', startImportResponse_mergeStrategy - The action to take when there is a merge conflict.

$sel:importStatus:StartImportResponse', startImportResponse_importStatus - The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.

$sel:tags:StartImport', startImportResponse_tags - A list of tags added to the imported bot.

$sel:httpStatus:StartImportResponse', startImportResponse_httpStatus - The response's http status code.