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.CreateExport

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

Synopsis

Creating a Request

data CreateExport Source #

See: newCreateExport smart constructor.

Constructors

CreateExport'

Fields

filePassword :: Maybe (Sensitive Text)
An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
resourceSpecification :: ExportResourceSpecification
Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.
fileFormat :: ImportExportFileFormat
The file format of the bot or bot locale definition files.

Instances

Instances details

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

newCreateExport Source #

Arguments

:: ExportResourceSpecification	`CreateExport`
-> ImportExportFileFormat	`CreateExport`
-> CreateExport

Create a value of CreateExport 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:CreateExport', createExport_filePassword - An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.

CreateExport, createExport_resourceSpecification - Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

CreateExport, createExport_fileFormat - The file format of the bot or bot locale definition files.

Request Lenses

createExport_filePassword :: Lens' CreateExport (Maybe Text) Source #

An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.

createExport_resourceSpecification :: Lens' CreateExport ExportResourceSpecification Source #

Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

createExport_fileFormat :: Lens' CreateExport ImportExportFileFormat Source #

The file format of the bot or bot locale definition files.

Destructuring the Response

data CreateExportResponse Source #

See: newCreateExportResponse smart constructor.

Constructors

CreateExportResponse'

Fields

creationDateTime :: Maybe POSIX
The date and time that the request to export a bot was created.
exportId :: Maybe Text
An identifier for a specific request to create an export.
exportStatus :: Maybe ExportStatus
The status of the export. When the status is Completed, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.
fileFormat :: Maybe ImportExportFileFormat
The file format used for the bot or bot locale definition files.
resourceSpecification :: Maybe ExportResourceSpecification
A description of the type of resource that was exported, either a bot or a bot locale.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateExportResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateExport Associated Types type Rep CreateExportResponse :: Type -> Type # Methods from :: CreateExportResponse -> Rep CreateExportResponse x # to :: Rep CreateExportResponse x -> CreateExportResponse #
Read CreateExportResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateExport Methods readsPrec :: Int -> ReadS CreateExportResponse # readList :: ReadS [CreateExportResponse] # readPrec :: ReadPrec CreateExportResponse # readListPrec :: ReadPrec [CreateExportResponse] #
Show CreateExportResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateExport Methods showsPrec :: Int -> CreateExportResponse -> ShowS # show :: CreateExportResponse -> String # showList :: [CreateExportResponse] -> ShowS #
NFData CreateExportResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateExport Methods rnf :: CreateExportResponse -> () #
Eq CreateExportResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateExport Methods (==) :: CreateExportResponse -> CreateExportResponse -> Bool # (/=) :: CreateExportResponse -> CreateExportResponse -> Bool #
type Rep CreateExportResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateExport type Rep CreateExportResponse = D1 ('MetaData "CreateExportResponse" "Amazonka.LexV2Models.CreateExport" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateExportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "exportId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exportStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportStatus)))) :: (S1 ('MetaSel ('Just "fileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportExportFileFormat)) :: (S1 ('MetaSel ('Just "resourceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportResourceSpecification)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateExportResponse Source #

Arguments

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

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

CreateExportResponse, createExportResponse_creationDateTime - The date and time that the request to export a bot was created.

CreateExportResponse, createExportResponse_exportId - An identifier for a specific request to create an export.

CreateExportResponse, createExportResponse_exportStatus - The status of the export. When the status is Completed, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.

CreateExport, createExportResponse_fileFormat - The file format used for the bot or bot locale definition files.

CreateExport, createExportResponse_resourceSpecification - A description of the type of resource that was exported, either a bot or a bot locale.

$sel:httpStatus:CreateExportResponse', createExportResponse_httpStatus - The response's http status code.

Response Lenses

createExportResponse_creationDateTime :: Lens' CreateExportResponse (Maybe UTCTime) Source #

The date and time that the request to export a bot was created.

createExportResponse_exportId :: Lens' CreateExportResponse (Maybe Text) Source #

An identifier for a specific request to create an export.

createExportResponse_exportStatus :: Lens' CreateExportResponse (Maybe ExportStatus) Source #

The status of the export. When the status is Completed, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.

createExportResponse_fileFormat :: Lens' CreateExportResponse (Maybe ImportExportFileFormat) Source #

The file format used for the bot or bot locale definition files.

createExportResponse_resourceSpecification :: Lens' CreateExportResponse (Maybe ExportResourceSpecification) Source #

A description of the type of resource that was exported, either a bot or a bot locale.

createExportResponse_httpStatus :: Lens' CreateExportResponse Int Source #

The response's http status code.