Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LexModels.StartMigration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.

For more information, see Migrating a bot in the Amazon Lex developer guide.

Synopsis

data StartMigration = StartMigration' {
- v1BotName :: Text
- v1BotVersion :: Text
- v2BotName :: Text
- v2BotRole :: Text
- migrationStrategy :: MigrationStrategy
}
newStartMigration :: Text -> Text -> Text -> Text -> MigrationStrategy -> StartMigration
startMigration_v1BotName :: Lens' StartMigration Text
startMigration_v1BotVersion :: Lens' StartMigration Text
startMigration_v2BotName :: Lens' StartMigration Text
startMigration_v2BotRole :: Lens' StartMigration Text
startMigration_migrationStrategy :: Lens' StartMigration MigrationStrategy
data StartMigrationResponse = StartMigrationResponse' {
- v1BotVersion :: Maybe Text
- migrationStrategy :: Maybe MigrationStrategy
- migrationTimestamp :: Maybe POSIX
- v2BotId :: Maybe Text
- v1BotLocale :: Maybe Locale
- v1BotName :: Maybe Text
- v2BotRole :: Maybe Text
- migrationId :: Maybe Text
- httpStatus :: Int
}
newStartMigrationResponse :: Int -> StartMigrationResponse
startMigrationResponse_v1BotVersion :: Lens' StartMigrationResponse (Maybe Text)
startMigrationResponse_migrationStrategy :: Lens' StartMigrationResponse (Maybe MigrationStrategy)
startMigrationResponse_migrationTimestamp :: Lens' StartMigrationResponse (Maybe UTCTime)
startMigrationResponse_v2BotId :: Lens' StartMigrationResponse (Maybe Text)
startMigrationResponse_v1BotLocale :: Lens' StartMigrationResponse (Maybe Locale)
startMigrationResponse_v1BotName :: Lens' StartMigrationResponse (Maybe Text)
startMigrationResponse_v2BotRole :: Lens' StartMigrationResponse (Maybe Text)
startMigrationResponse_migrationId :: Lens' StartMigrationResponse (Maybe Text)
startMigrationResponse_httpStatus :: Lens' StartMigrationResponse Int

Creating a Request

data StartMigration Source #

See: newStartMigration smart constructor.

Constructors

StartMigration'

Fields

v1BotName :: Text
The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
v1BotVersion :: Text
The version of the bot to migrate to Amazon Lex V2. You can migrate the $LATEST version as well as any numbered version.
v2BotName :: Text
The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.
- If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW migration strategy.
- If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration strategy to change the contents of the Amazon Lex V2 bot.
v2BotRole :: Text
The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
migrationStrategy :: MigrationStrategy
The strategy used to conduct the migration.
- CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
- UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

Instances

Instances details

Eq StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods (==) :: StartMigration -> StartMigration -> Bool # (/=) :: StartMigration -> StartMigration -> Bool #
Read StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods readsPrec :: Int -> ReadS StartMigration # readList :: ReadS [StartMigration] # readPrec :: ReadPrec StartMigration # readListPrec :: ReadPrec [StartMigration] #
Show StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods showsPrec :: Int -> StartMigration -> ShowS # show :: StartMigration -> String # showList :: [StartMigration] -> ShowS #
Generic StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Associated Types type Rep StartMigration :: Type -> Type # Methods from :: StartMigration -> Rep StartMigration x # to :: Rep StartMigration x -> StartMigration #
NFData StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods rnf :: StartMigration -> () #
Hashable StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods hashWithSalt :: Int -> StartMigration -> Int # hash :: StartMigration -> Int #
ToJSON StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods toJSON :: StartMigration -> Value # toEncoding :: StartMigration -> Encoding # toJSONList :: [StartMigration] -> Value # toEncodingList :: [StartMigration] -> Encoding #
AWSRequest StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Associated Types type AWSResponse StartMigration # Methods request :: StartMigration -> Request StartMigration # response :: MonadResource m => Logger -> Service -> Proxy StartMigration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartMigration))) #
ToHeaders StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods toHeaders :: StartMigration -> [Header] #
ToPath StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods toPath :: StartMigration -> ByteString #
ToQuery StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods toQuery :: StartMigration -> QueryString #
type Rep StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration type Rep StartMigration = D1 ('MetaData "StartMigration" "Amazonka.LexModels.StartMigration" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "StartMigration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "v1BotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "v1BotVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "v2BotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "v2BotRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "migrationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MigrationStrategy)))))
type AWSResponse StartMigration Source #
Instance details Defined in Amazonka.LexModels.StartMigration type AWSResponse StartMigration = StartMigrationResponse

newStartMigration Source #

Arguments

:: Text	`$sel:v1BotName:StartMigration'`
-> Text	`$sel:v1BotVersion:StartMigration'`
-> Text	`$sel:v2BotName:StartMigration'`
-> Text	`$sel:v2BotRole:StartMigration'`
-> MigrationStrategy	`$sel:migrationStrategy:StartMigration'`
-> StartMigration

Create a value of StartMigration 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:v1BotName:StartMigration', startMigration_v1BotName - The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.

$sel:v1BotVersion:StartMigration', startMigration_v1BotVersion - The version of the bot to migrate to Amazon Lex V2. You can migrate the $LATEST version as well as any numbered version.

$sel:v2BotName:StartMigration', startMigration_v2BotName - The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.

If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW migration strategy.
If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration strategy to change the contents of the Amazon Lex V2 bot.

$sel:v2BotRole:StartMigration', startMigration_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

$sel:migrationStrategy:StartMigration', startMigration_migrationStrategy - The strategy used to conduct the migration.

CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

Request Lenses

startMigration_v1BotName :: Lens' StartMigration Text Source #

The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.

startMigration_v1BotVersion :: Lens' StartMigration Text Source #

The version of the bot to migrate to Amazon Lex V2. You can migrate the $LATEST version as well as any numbered version.

startMigration_v2BotName :: Lens' StartMigration Text Source #

The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.

If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW migration strategy.
If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration strategy to change the contents of the Amazon Lex V2 bot.

startMigration_v2BotRole :: Lens' StartMigration Text Source #

The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

startMigration_migrationStrategy :: Lens' StartMigration MigrationStrategy Source #

The strategy used to conduct the migration.

CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.
UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

Destructuring the Response

data StartMigrationResponse Source #

See: newStartMigrationResponse smart constructor.

Constructors

StartMigrationResponse'

Fields

v1BotVersion :: Maybe Text
The version of the bot to migrate to Amazon Lex V2.
migrationStrategy :: Maybe MigrationStrategy
The strategy used to conduct the migration.
migrationTimestamp :: Maybe POSIX
The date and time that the migration started.
v2BotId :: Maybe Text
The unique identifier for the Amazon Lex V2 bot.
v1BotLocale :: Maybe Locale
The locale used for the Amazon Lex V1 bot.
v1BotName :: Maybe Text
The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
v2BotRole :: Maybe Text
The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
migrationId :: Maybe Text
The unique identifier that Amazon Lex assigned to the migration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq StartMigrationResponse Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods (==) :: StartMigrationResponse -> StartMigrationResponse -> Bool # (/=) :: StartMigrationResponse -> StartMigrationResponse -> Bool #
Read StartMigrationResponse Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods readsPrec :: Int -> ReadS StartMigrationResponse # readList :: ReadS [StartMigrationResponse] # readPrec :: ReadPrec StartMigrationResponse # readListPrec :: ReadPrec [StartMigrationResponse] #
Show StartMigrationResponse Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods showsPrec :: Int -> StartMigrationResponse -> ShowS # show :: StartMigrationResponse -> String # showList :: [StartMigrationResponse] -> ShowS #
Generic StartMigrationResponse Source #
Instance details Defined in Amazonka.LexModels.StartMigration Associated Types type Rep StartMigrationResponse :: Type -> Type # Methods from :: StartMigrationResponse -> Rep StartMigrationResponse x # to :: Rep StartMigrationResponse x -> StartMigrationResponse #
NFData StartMigrationResponse Source #
Instance details Defined in Amazonka.LexModels.StartMigration Methods rnf :: StartMigrationResponse -> () #
type Rep StartMigrationResponse Source #
Instance details Defined in Amazonka.LexModels.StartMigration type Rep StartMigrationResponse = D1 ('MetaData "StartMigrationResponse" "Amazonka.LexModels.StartMigration" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "StartMigrationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "v1BotVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "migrationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationStrategy))) :: (S1 ('MetaSel ('Just "migrationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "v2BotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "v1BotLocale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Locale)) :: S1 ('MetaSel ('Just "v1BotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "v2BotRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "migrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newStartMigrationResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartMigrationResponse'`
-> StartMigrationResponse

Create a value of StartMigrationResponse 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:v1BotVersion:StartMigration', startMigrationResponse_v1BotVersion - The version of the bot to migrate to Amazon Lex V2.

$sel:migrationStrategy:StartMigration', startMigrationResponse_migrationStrategy - The strategy used to conduct the migration.

$sel:migrationTimestamp:StartMigrationResponse', startMigrationResponse_migrationTimestamp - The date and time that the migration started.

$sel:v2BotId:StartMigrationResponse', startMigrationResponse_v2BotId - The unique identifier for the Amazon Lex V2 bot.

$sel:v1BotLocale:StartMigrationResponse', startMigrationResponse_v1BotLocale - The locale used for the Amazon Lex V1 bot.

$sel:v1BotName:StartMigration', startMigrationResponse_v1BotName - The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.

$sel:v2BotRole:StartMigration', startMigrationResponse_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

$sel:migrationId:StartMigrationResponse', startMigrationResponse_migrationId - The unique identifier that Amazon Lex assigned to the migration.

$sel:httpStatus:StartMigrationResponse', startMigrationResponse_httpStatus - The response's http status code.

Response Lenses

startMigrationResponse_v1BotVersion :: Lens' StartMigrationResponse (Maybe Text) Source #

The version of the bot to migrate to Amazon Lex V2.

startMigrationResponse_migrationStrategy :: Lens' StartMigrationResponse (Maybe MigrationStrategy) Source #

The strategy used to conduct the migration.

startMigrationResponse_migrationTimestamp :: Lens' StartMigrationResponse (Maybe UTCTime) Source #

The date and time that the migration started.

startMigrationResponse_v2BotId :: Lens' StartMigrationResponse (Maybe Text) Source #

The unique identifier for the Amazon Lex V2 bot.

startMigrationResponse_v1BotLocale :: Lens' StartMigrationResponse (Maybe Locale) Source #

The locale used for the Amazon Lex V1 bot.

startMigrationResponse_v1BotName :: Lens' StartMigrationResponse (Maybe Text) Source #

The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.

startMigrationResponse_v2BotRole :: Lens' StartMigrationResponse (Maybe Text) Source #

The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

startMigrationResponse_migrationId :: Lens' StartMigrationResponse (Maybe Text) Source #

The unique identifier that Amazon Lex assigned to the migration.

startMigrationResponse_httpStatus :: Lens' StartMigrationResponse Int Source #

The response's http status code.