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.LexV2Models.StartImport

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

Synopsis

data StartImport = StartImport' {
- filePassword :: Maybe (Sensitive Text)
- importId :: Text
- resourceSpecification :: ImportResourceSpecification
- mergeStrategy :: MergeStrategy
}
newStartImport :: Text -> ImportResourceSpecification -> MergeStrategy -> StartImport
startImport_filePassword :: Lens' StartImport (Maybe Text)
startImport_importId :: Lens' StartImport Text
startImport_resourceSpecification :: Lens' StartImport ImportResourceSpecification
startImport_mergeStrategy :: Lens' StartImport MergeStrategy
data StartImportResponse = StartImportResponse' {
- creationDateTime :: Maybe POSIX
- importId :: Maybe Text
- importStatus :: Maybe ImportStatus
- mergeStrategy :: Maybe MergeStrategy
- resourceSpecification :: Maybe ImportResourceSpecification
- httpStatus :: Int
}
newStartImportResponse :: Int -> StartImportResponse
startImportResponse_creationDateTime :: Lens' StartImportResponse (Maybe UTCTime)
startImportResponse_importId :: Lens' StartImportResponse (Maybe Text)
startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus)
startImportResponse_mergeStrategy :: Lens' StartImportResponse (Maybe MergeStrategy)
startImportResponse_resourceSpecification :: Lens' StartImportResponse (Maybe ImportResourceSpecification)
startImportResponse_httpStatus :: Lens' StartImportResponse Int

Creating a Request

data StartImport Source #

See: newStartImport smart constructor.

Constructors

StartImport'

Fields

filePassword :: Maybe (Sensitive Text)
The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
importId :: Text
The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
resourceSpecification :: ImportResourceSpecification
Parameters for creating the bot, bot locale or custom vocabulary.
mergeStrategy :: MergeStrategy
The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

Instances

Instances details

ToJSON StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods toJSON :: StartImport -> Value # toEncoding :: StartImport -> Encoding # toJSONList :: [StartImport] -> Value # toEncodingList :: [StartImport] -> Encoding #
ToHeaders StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods toHeaders :: StartImport -> [Header] #
ToPath StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods toPath :: StartImport -> ByteString #
ToQuery StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods toQuery :: StartImport -> QueryString #
AWSRequest StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Associated Types type AWSResponse StartImport # Methods request :: (Service -> Service) -> StartImport -> Request StartImport # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartImport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartImport))) #
Generic StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Associated Types type Rep StartImport :: Type -> Type # Methods from :: StartImport -> Rep StartImport x # to :: Rep StartImport x -> StartImport #
Show StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods showsPrec :: Int -> StartImport -> ShowS # show :: StartImport -> String # showList :: [StartImport] -> ShowS #
NFData StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods rnf :: StartImport -> () #
Eq StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods (==) :: StartImport -> StartImport -> Bool # (/=) :: StartImport -> StartImport -> Bool #
Hashable StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods hashWithSalt :: Int -> StartImport -> Int # hash :: StartImport -> Int #
type AWSResponse StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport type AWSResponse StartImport = StartImportResponse
type Rep StartImport Source #
Instance details Defined in Amazonka.LexV2Models.StartImport type Rep StartImport = D1 ('MetaData "StartImport" "Amazonka.LexV2Models.StartImport" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "StartImport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filePassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "importId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImportResourceSpecification) :*: S1 ('MetaSel ('Just "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MergeStrategy))))

newStartImport Source #

Arguments

:: Text	`StartImport`
-> ImportResourceSpecification	`StartImport`
-> 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:filePassword:StartImport', startImport_filePassword - The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.

StartImport, startImport_importId - The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

StartImport, startImport_resourceSpecification - Parameters for creating the bot, bot locale or custom vocabulary.

StartImport, startImport_mergeStrategy - The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

Request Lenses

startImport_filePassword :: Lens' StartImport (Maybe Text) Source #

The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.

startImport_importId :: Lens' StartImport Text Source #

The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

startImport_resourceSpecification :: Lens' StartImport ImportResourceSpecification Source #

Parameters for creating the bot, bot locale or custom vocabulary.

startImport_mergeStrategy :: Lens' StartImport MergeStrategy Source #

The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

Destructuring the Response

data StartImportResponse Source #

See: newStartImportResponse smart constructor.

Constructors

StartImportResponse'

Fields

creationDateTime :: Maybe POSIX
The date and time that the import request was created.
importId :: Maybe Text
A unique identifier for the import.
importStatus :: Maybe ImportStatus
The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.
mergeStrategy :: Maybe MergeStrategy
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
resourceSpecification :: Maybe ImportResourceSpecification
The parameters used when importing the resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartImportResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Associated Types type Rep StartImportResponse :: Type -> Type # Methods from :: StartImportResponse -> Rep StartImportResponse x # to :: Rep StartImportResponse x -> StartImportResponse #
Read StartImportResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods readsPrec :: Int -> ReadS StartImportResponse # readList :: ReadS [StartImportResponse] # readPrec :: ReadPrec StartImportResponse # readListPrec :: ReadPrec [StartImportResponse] #
Show StartImportResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods showsPrec :: Int -> StartImportResponse -> ShowS # show :: StartImportResponse -> String # showList :: [StartImportResponse] -> ShowS #
NFData StartImportResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods rnf :: StartImportResponse -> () #
Eq StartImportResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartImport Methods (==) :: StartImportResponse -> StartImportResponse -> Bool # (/=) :: StartImportResponse -> StartImportResponse -> Bool #
type Rep StartImportResponse Source #
Instance details Defined in Amazonka.LexV2Models.StartImport type Rep StartImportResponse = D1 ('MetaData "StartImportResponse" "Amazonka.LexV2Models.StartImport" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "StartImportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "importId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "importStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportStatus)))) :: (S1 ('MetaSel ('Just "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MergeStrategy)) :: (S1 ('MetaSel ('Just "resourceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportResourceSpecification)) :*: 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:

StartImportResponse, startImportResponse_creationDateTime - The date and time that the import request was created.

StartImport, startImportResponse_importId - A unique identifier for the import.

StartImportResponse, startImportResponse_importStatus - The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.

StartImport, startImportResponse_mergeStrategy - The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

StartImport, startImportResponse_resourceSpecification - The parameters used when importing the resource.

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

Response Lenses

startImportResponse_creationDateTime :: Lens' StartImportResponse (Maybe UTCTime) Source #

The date and time that the import request was created.

startImportResponse_importId :: Lens' StartImportResponse (Maybe Text) Source #

A unique identifier for the import.

startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus) Source #

The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.

startImportResponse_mergeStrategy :: Lens' StartImportResponse (Maybe MergeStrategy) Source #

The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

startImportResponse_resourceSpecification :: Lens' StartImportResponse (Maybe ImportResourceSpecification) Source #

The parameters used when importing the resource.

startImportResponse_httpStatus :: Lens' StartImportResponse Int Source #

The response's http status code.