amazonka-lex-models-2.0: Amazon Lex Model Building Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LexModels.GetExport

Description

Exports the contents of a Amazon Lex resource in a specified format.

Synopsis

Creating a Request

data GetExport Source #

See: newGetExport smart constructor.

Constructors

GetExport' 

Fields

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

ToQuery GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

AWSRequest GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Associated Types

type AWSResponse GetExport #

Generic GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Associated Types

type Rep GetExport :: Type -> Type #

Read GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Show GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

NFData GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Methods

rnf :: GetExport -> () #

Eq GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Hashable GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

type AWSResponse GetExport Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

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 #

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 #

Read GetExportResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Show GetExportResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

NFData GetExportResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

Methods

rnf :: GetExportResponse -> () #

Eq GetExportResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

type Rep GetExportResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetExport

newGetExportResponse Source #

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