| 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
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
- data CreateExport = CreateExport' {}
- newCreateExport :: ExportResourceSpecification -> ImportExportFileFormat -> CreateExport
- createExport_filePassword :: Lens' CreateExport (Maybe Text)
- createExport_resourceSpecification :: Lens' CreateExport ExportResourceSpecification
- createExport_fileFormat :: Lens' CreateExport ImportExportFileFormat
- data CreateExportResponse = CreateExportResponse' {}
- newCreateExportResponse :: Int -> CreateExportResponse
- createExportResponse_creationDateTime :: Lens' CreateExportResponse (Maybe UTCTime)
- createExportResponse_exportId :: Lens' CreateExportResponse (Maybe Text)
- createExportResponse_exportStatus :: Lens' CreateExportResponse (Maybe ExportStatus)
- createExportResponse_fileFormat :: Lens' CreateExportResponse (Maybe ImportExportFileFormat)
- createExportResponse_resourceSpecification :: Lens' CreateExportResponse (Maybe ExportResourceSpecification)
- createExportResponse_httpStatus :: Lens' CreateExportResponse Int
Creating a Request
data CreateExport Source #
See: newCreateExport smart constructor.
Constructors
| CreateExport' | |
Fields
| |
Instances
Arguments
| :: ExportResourceSpecification | |
| -> ImportExportFileFormat | |
| -> 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
| |
Instances
newCreateExportResponse Source #
Arguments
| :: Int | |
| -> 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.