Amazonka.LexModels.StartImport

Starts a job to import a resource to Amazon Lex.

Creating a Request

data StartImport

See: newStartImport smart constructor.

Constructors

StartImport'

Fields

• tags :: Maybe [Tag]

  A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

• payload :: Base64

  A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.

• resourceType :: ResourceType

  Specifies the type of resource to export. Each resource also exports any resources that it depends on.

  • A bot exports dependent intents.
  • An intent exports dependent slot types.
• mergeStrategy :: MergeStrategy

  Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

  • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

    OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Instances

ToJSON StartImport

Defined in Amazonka.LexModels.StartImport

Methods

toJSON :: StartImport -> Value

toEncoding :: StartImport -> Encoding

toJSONList :: [StartImport] -> Value

toEncodingList :: [StartImport] -> Encoding

ToHeaders StartImport

Defined in Amazonka.LexModels.StartImport

Methods

toHeaders :: StartImport -> [Header]

ToPath StartImport

Defined in Amazonka.LexModels.StartImport

Methods

toPath :: StartImport -> ByteString

ToQuery StartImport

Defined in Amazonka.LexModels.StartImport

Methods

toQuery :: StartImport -> QueryString

AWSRequest StartImport

Defined in Amazonka.LexModels.StartImport

Associated Types

type AWSResponse StartImport

Methods

request :: (Service -> Service) -> StartImport -> Request StartImport

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartImport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartImport)))

Generic StartImport

Defined in Amazonka.LexModels.StartImport

Associated Types

type Rep StartImport :: Type -> Type

Methods

from :: StartImport -> Rep StartImport x

to :: Rep StartImport x -> StartImport

Read StartImport

Defined in Amazonka.LexModels.StartImport

Methods

readsPrec :: Int -> ReadS StartImport

readList :: ReadS [StartImport]

readPrec :: ReadPrec StartImport

readListPrec :: ReadPrec [StartImport]

Show StartImport

Defined in Amazonka.LexModels.StartImport

Methods

showsPrec :: Int -> StartImport -> ShowS

show :: StartImport -> String

showList :: [StartImport] -> ShowS

NFData StartImport

Defined in Amazonka.LexModels.StartImport

Methods

rnf :: StartImport -> ()

Eq StartImport

Defined in Amazonka.LexModels.StartImport

Methods

(==) :: StartImport -> StartImport -> Bool

(/=) :: StartImport -> StartImport -> Bool

Hashable StartImport

Defined in Amazonka.LexModels.StartImport

Methods

hashWithSalt :: Int -> StartImport -> Int

hash :: StartImport -> Int

type AWSResponse StartImport

Defined in Amazonka.LexModels.StartImport

type AWSResponse StartImport = StartImportResponse

type Rep StartImport

Defined in Amazonka.LexModels.StartImport

type Rep StartImport = D1 ('MetaData "StartImport" "Amazonka.LexModels.StartImport" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "StartImport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType) :*: S1 ('MetaSel ('Just "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MergeStrategy))))

newStartImport

Arguments

:: ByteString

$sel:payload:StartImport'

-> ResourceType

StartImport

-> MergeStrategy

StartImport

-> StartImport

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

StartImport, startImport_tags - A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

$sel:payload:StartImport', startImport_payload - A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

StartImport, startImport_resourceType - Specifies the type of resource to export. Each resource also exports any resources that it depends on.

• A bot exports dependent intents.
• An intent exports dependent slot types.

StartImport, startImport_mergeStrategy - Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

• FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

  OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Request Lenses

startImport_tags :: Lens' StartImport (Maybe [Tag])

A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.

startImport_payload :: Lens' StartImport ByteString

A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

startImport_resourceType :: Lens' StartImport ResourceType

Specifies the type of resource to export. Each resource also exports any resources that it depends on.

• A bot exports dependent intents.
• An intent exports dependent slot types.

startImport_mergeStrategy :: Lens' StartImport MergeStrategy

Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

• FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

  OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

Destructuring the Response

data StartImportResponse

See: newStartImportResponse smart constructor.

Constructors

StartImportResponse'

Fields

• createdDate :: Maybe POSIX

  A timestamp for the date and time that the import job was requested.

• importId :: Maybe Text

  The identifier for the specific import job.

• importStatus :: Maybe ImportStatus

  The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.

• mergeStrategy :: Maybe MergeStrategy

  The action to take when there is a merge conflict.

• name :: Maybe Text

  The name given to the import job.

• resourceType :: Maybe ResourceType

  The type of resource to import.

• tags :: Maybe [Tag]

  A list of tags added to the imported bot.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartImportResponse

Defined in Amazonka.LexModels.StartImport

Associated Types

type Rep StartImportResponse :: Type -> Type

Methods

from :: StartImportResponse -> Rep StartImportResponse x

to :: Rep StartImportResponse x -> StartImportResponse

Read StartImportResponse

Defined in Amazonka.LexModels.StartImport

Methods

readsPrec :: Int -> ReadS StartImportResponse

readList :: ReadS [StartImportResponse]

readPrec :: ReadPrec StartImportResponse

readListPrec :: ReadPrec [StartImportResponse]

Show StartImportResponse

Defined in Amazonka.LexModels.StartImport

Methods

showsPrec :: Int -> StartImportResponse -> ShowS

show :: StartImportResponse -> String

showList :: [StartImportResponse] -> ShowS

NFData StartImportResponse

Defined in Amazonka.LexModels.StartImport

Methods

rnf :: StartImportResponse -> ()

Eq StartImportResponse

Defined in Amazonka.LexModels.StartImport

Methods

(==) :: StartImportResponse -> StartImportResponse -> Bool

(/=) :: StartImportResponse -> StartImportResponse -> Bool

type Rep StartImportResponse

Defined in Amazonka.LexModels.StartImport

type Rep StartImportResponse = D1 ('MetaData "StartImportResponse" "Amazonka.LexModels.StartImport" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "StartImportResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "importId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "importStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportStatus)) :*: S1 ('MetaSel ('Just "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MergeStrategy)))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartImportResponse

Arguments

:: Int

$sel:httpStatus:StartImportResponse'

-> StartImportResponse

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

StartImportResponse, startImportResponse_createdDate - A timestamp for the date and time that the import job was requested.

$sel:importId:StartImportResponse', startImportResponse_importId - The identifier for the specific import job.

$sel:importStatus:StartImportResponse', startImportResponse_importStatus - The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.

StartImport, startImportResponse_mergeStrategy - The action to take when there is a merge conflict.

StartImportResponse, startImportResponse_name - The name given to the import job.

StartImport, startImportResponse_resourceType - The type of resource to import.

StartImport, startImportResponse_tags - A list of tags added to the imported bot.

$sel:httpStatus:StartImportResponse', startImportResponse_httpStatus - The response's http status code.

Response Lenses

startImportResponse_createdDate :: Lens' StartImportResponse (Maybe UTCTime)

A timestamp for the date and time that the import job was requested.

startImportResponse_importId :: Lens' StartImportResponse (Maybe Text)

The identifier for the specific import job.

startImportResponse_importStatus :: Lens' StartImportResponse (Maybe ImportStatus)

The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.

startImportResponse_mergeStrategy :: Lens' StartImportResponse (Maybe MergeStrategy)

The action to take when there is a merge conflict.

startImportResponse_name :: Lens' StartImportResponse (Maybe Text)

The name given to the import job.

startImportResponse_resourceType :: Lens' StartImportResponse (Maybe ResourceType)

The type of resource to import.

startImportResponse_tags :: Lens' StartImportResponse (Maybe [Tag])

A list of tags added to the imported bot.

startImportResponse_httpStatus :: Lens' StartImportResponse Int

The response's http status code.