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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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' {
- exportStatus :: Maybe ExportStatus
- exportType :: Maybe ExportType
- failureReason :: Maybe Text
- name :: Maybe Text
- resourceType :: Maybe ResourceType
- url :: Maybe Text
- version :: Maybe Text
- httpStatus :: Int
}
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

data GetExport Source #

See: newGetExport smart constructor.

Constructors

GetExport'
Fields name :: Text The name of the bot to export. version :: Text The version of the bot to export. resourceType :: ResourceType The type of resource to export. exportType :: ExportType The format of the exported data.

Instances

Instances details

ToHeaders GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods toHeaders :: GetExport -> [Header] #
ToPath GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods toPath :: GetExport -> ByteString #
ToQuery GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods toQuery :: GetExport -> QueryString #
AWSRequest GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Associated Types type AWSResponse GetExport # Methods request :: (Service -> Service) -> GetExport -> Request GetExport # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetExport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetExport))) #
Generic GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Associated Types type Rep GetExport :: Type -> Type # Methods from :: GetExport -> Rep GetExport x # to :: Rep GetExport x -> GetExport #
Read GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods readsPrec :: Int -> ReadS GetExport # readList :: ReadS [GetExport] # readPrec :: ReadPrec GetExport # readListPrec :: ReadPrec [GetExport] #
Show GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods showsPrec :: Int -> GetExport -> ShowS # show :: GetExport -> String # showList :: [GetExport] -> ShowS #
NFData GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods rnf :: GetExport -> () #
Eq GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods (==) :: GetExport -> GetExport -> Bool # (/=) :: GetExport -> GetExport -> Bool #
Hashable GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods hashWithSalt :: Int -> GetExport -> Int # hash :: GetExport -> Int #
type AWSResponse GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport type AWSResponse GetExport = GetExportResponse
type Rep GetExport Source #
Instance details Defined in Amazonka.LexModels.GetExport type Rep GetExport = D1 ('MetaData "GetExport" "Amazonka.LexModels.GetExport" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetExport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType) :*: S1 ('MetaSel ('Just "exportType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExportType))))

newGetExport Source #

Arguments

:: Text	`GetExport`
-> Text	`GetExport`
-> ResourceType	`GetExport`
-> ExportType	`GetExport`
-> 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_name :: Lens' GetExport Text Source #

The name of the bot to export.

getExport_version :: Lens' GetExport Text Source #

The version of the bot to export.

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

exportStatus :: Maybe 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.
exportType :: Maybe ExportType
The format of the exported data.
failureReason :: Maybe Text
If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.
name :: Maybe Text
The name of the bot being exported.
resourceType :: Maybe ResourceType
The type of the exported resource.
url :: Maybe Text
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.
version :: Maybe Text
The version of the bot being exported.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetExportResponse Source #
Instance details Defined in Amazonka.LexModels.GetExport Associated Types type Rep GetExportResponse :: Type -> Type # Methods from :: GetExportResponse -> Rep GetExportResponse x # to :: Rep GetExportResponse x -> GetExportResponse #
Read GetExportResponse Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods readsPrec :: Int -> ReadS GetExportResponse # readList :: ReadS [GetExportResponse] # readPrec :: ReadPrec GetExportResponse # readListPrec :: ReadPrec [GetExportResponse] #
Show GetExportResponse Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods showsPrec :: Int -> GetExportResponse -> ShowS # show :: GetExportResponse -> String # showList :: [GetExportResponse] -> ShowS #
NFData GetExportResponse Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods rnf :: GetExportResponse -> () #
Eq GetExportResponse Source #
Instance details Defined in Amazonka.LexModels.GetExport Methods (==) :: GetExportResponse -> GetExportResponse -> Bool # (/=) :: GetExportResponse -> GetExportResponse -> Bool #
type Rep GetExportResponse Source #
Instance details Defined in Amazonka.LexModels.GetExport type Rep GetExportResponse = D1 ('MetaData "GetExportResponse" "Amazonka.LexModels.GetExport" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetExportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "exportStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportStatus)) :: S1 ('MetaSel ('Just "exportType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportType))) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetExportResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetExportResponse'`
-> 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.