| 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.LexModels.GetExport
Description
Exports the contents of a Amazon Lex resource in a specified format.
Synopsis
- data GetExport = GetExport' {
- name :: Text
- version :: Text
- resourceType :: ResourceType
- exportType :: ExportType
- newGetExport :: Text -> Text -> ResourceType -> ExportType -> GetExport
- getExport_name :: Lens' GetExport Text
- getExport_version :: Lens' GetExport Text
- getExport_resourceType :: Lens' GetExport ResourceType
- getExport_exportType :: Lens' GetExport ExportType
- data GetExportResponse = GetExportResponse' {}
- newGetExportResponse :: Int -> GetExportResponse
- getExportResponse_exportStatus :: Lens' GetExportResponse (Maybe ExportStatus)
- getExportResponse_exportType :: Lens' GetExportResponse (Maybe ExportType)
- getExportResponse_failureReason :: Lens' GetExportResponse (Maybe Text)
- getExportResponse_name :: Lens' GetExportResponse (Maybe Text)
- getExportResponse_resourceType :: Lens' GetExportResponse (Maybe ResourceType)
- getExportResponse_url :: Lens' GetExportResponse (Maybe Text)
- getExportResponse_version :: Lens' GetExportResponse (Maybe Text)
- getExportResponse_httpStatus :: Lens' GetExportResponse Int
Creating a Request
See: newGetExport smart constructor.
Constructors
| GetExport' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ResourceType | |
| -> ExportType | |
| -> GetExport |
Create a value of GetExport 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:
GetExport, getExport_name - The name of the bot to export.
GetExport, getExport_version - The version of the bot to export.
GetExport, getExport_resourceType - The type of resource to export.
GetExport, getExport_exportType - The format of the exported data.
Request Lenses
getExport_resourceType :: Lens' GetExport ResourceType Source #
The type of resource to export.
getExport_exportType :: Lens' GetExport ExportType Source #
The format of the exported data.
Destructuring the Response
data GetExportResponse Source #
See: newGetExportResponse smart constructor.
Constructors
| GetExportResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> GetExportResponse |
Create a value of GetExportResponse 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:exportStatus:GetExportResponse', getExportResponse_exportStatus - The status of the export.
IN_PROGRESS- The export is in progress.READY- The export is complete.FAILED- The export could not be completed.
GetExport, getExportResponse_exportType - The format of the exported data.
GetExportResponse, getExportResponse_failureReason - If status is FAILED, Amazon Lex provides the reason that it failed
to export the resource.
GetExport, getExportResponse_name - The name of the bot being exported.
GetExport, getExportResponse_resourceType - The type of the exported resource.
$sel:url:GetExportResponse', getExportResponse_url - An S3 pre-signed URL that provides the location of the exported
resource. The exported resource is a ZIP archive that contains the
exported resource in JSON format. The structure of the archive may
change. Your code should not rely on the archive structure.
GetExport, getExportResponse_version - The version of the bot being exported.
$sel:httpStatus:GetExportResponse', getExportResponse_httpStatus - The response's http status code.
Response Lenses
getExportResponse_exportStatus :: Lens' GetExportResponse (Maybe ExportStatus) Source #
The status of the export.
IN_PROGRESS- The export is in progress.READY- The export is complete.FAILED- The export could not be completed.
getExportResponse_exportType :: Lens' GetExportResponse (Maybe ExportType) Source #
The format of the exported data.
getExportResponse_failureReason :: Lens' GetExportResponse (Maybe Text) Source #
If status is FAILED, Amazon Lex provides the reason that it failed
to export the resource.
getExportResponse_name :: Lens' GetExportResponse (Maybe Text) Source #
The name of the bot being exported.
getExportResponse_resourceType :: Lens' GetExportResponse (Maybe ResourceType) Source #
The type of the exported resource.
getExportResponse_url :: Lens' GetExportResponse (Maybe Text) Source #
An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.
getExportResponse_version :: Lens' GetExportResponse (Maybe Text) Source #
The version of the bot being exported.
getExportResponse_httpStatus :: Lens' GetExportResponse Int Source #
The response's http status code.