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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.

Synopsis

data GetMigration = GetMigration' {
- migrationId :: Text
}
newGetMigration :: Text -> GetMigration
getMigration_migrationId :: Lens' GetMigration Text
data GetMigrationResponse = GetMigrationResponse' {
- alerts :: Maybe [MigrationAlert]
- migrationId :: Maybe Text
- migrationStatus :: Maybe MigrationStatus
- migrationStrategy :: Maybe MigrationStrategy
- migrationTimestamp :: Maybe POSIX
- v1BotLocale :: Maybe Locale
- v1BotName :: Maybe Text
- v1BotVersion :: Maybe Text
- v2BotId :: Maybe Text
- v2BotRole :: Maybe Text
- httpStatus :: Int
}
newGetMigrationResponse :: Int -> GetMigrationResponse
getMigrationResponse_alerts :: Lens' GetMigrationResponse (Maybe [MigrationAlert])
getMigrationResponse_migrationId :: Lens' GetMigrationResponse (Maybe Text)
getMigrationResponse_migrationStatus :: Lens' GetMigrationResponse (Maybe MigrationStatus)
getMigrationResponse_migrationStrategy :: Lens' GetMigrationResponse (Maybe MigrationStrategy)
getMigrationResponse_migrationTimestamp :: Lens' GetMigrationResponse (Maybe UTCTime)
getMigrationResponse_v1BotLocale :: Lens' GetMigrationResponse (Maybe Locale)
getMigrationResponse_v1BotName :: Lens' GetMigrationResponse (Maybe Text)
getMigrationResponse_v1BotVersion :: Lens' GetMigrationResponse (Maybe Text)
getMigrationResponse_v2BotId :: Lens' GetMigrationResponse (Maybe Text)
getMigrationResponse_v2BotRole :: Lens' GetMigrationResponse (Maybe Text)
getMigrationResponse_httpStatus :: Lens' GetMigrationResponse Int

Creating a Request

data GetMigration Source #

See: newGetMigration smart constructor.

Constructors

GetMigration'
Fields migrationId :: Text The unique identifier of the migration to view. The `migrationID` is returned by the operation.

Instances

Instances details

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

newGetMigration Source #

Arguments

:: Text	`GetMigration`
-> GetMigration

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

GetMigration, getMigration_migrationId - The unique identifier of the migration to view. The migrationID is returned by the operation.

Request Lenses

getMigration_migrationId :: Lens' GetMigration Text Source #

The unique identifier of the migration to view. The migrationID is returned by the operation.

Destructuring the Response

data GetMigrationResponse Source #

See: newGetMigrationResponse smart constructor.

Constructors

GetMigrationResponse'

Fields

alerts :: Maybe [MigrationAlert]
A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex V2 developer guide.
migrationId :: Maybe Text
The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.
migrationStatus :: Maybe MigrationStatus
Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.
migrationStrategy :: Maybe 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.
migrationTimestamp :: Maybe POSIX
The date and time that the migration started.
v1BotLocale :: Maybe Locale
The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.
v1BotName :: Maybe Text
The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.
v1BotVersion :: Maybe Text
The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.
v2BotId :: Maybe Text
The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.
v2BotRole :: Maybe Text
The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetMigrationResponse Source #

Arguments

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

Create a value of GetMigrationResponse 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:alerts:GetMigrationResponse', getMigrationResponse_alerts - A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.

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

GetMigration, getMigrationResponse_migrationId - The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.

GetMigrationResponse, getMigrationResponse_migrationStatus - Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.

GetMigrationResponse, getMigrationResponse_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.

GetMigrationResponse, getMigrationResponse_migrationTimestamp - The date and time that the migration started.

GetMigrationResponse, getMigrationResponse_v1BotLocale - The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.

GetMigrationResponse, getMigrationResponse_v1BotName - The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.

GetMigrationResponse, getMigrationResponse_v1BotVersion - The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.

GetMigrationResponse, getMigrationResponse_v2BotId - The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.

GetMigrationResponse, getMigrationResponse_v2BotRole - The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

$sel:httpStatus:GetMigrationResponse', getMigrationResponse_httpStatus - The response's http status code.

Response Lenses

getMigrationResponse_alerts :: Lens' GetMigrationResponse (Maybe [MigrationAlert]) Source #

A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.

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

getMigrationResponse_migrationId :: Lens' GetMigrationResponse (Maybe Text) Source #

The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.

getMigrationResponse_migrationStatus :: Lens' GetMigrationResponse (Maybe MigrationStatus) Source #

Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.

getMigrationResponse_migrationStrategy :: Lens' GetMigrationResponse (Maybe 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.

getMigrationResponse_migrationTimestamp :: Lens' GetMigrationResponse (Maybe UTCTime) Source #

The date and time that the migration started.

getMigrationResponse_v1BotLocale :: Lens' GetMigrationResponse (Maybe Locale) Source #

The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.

getMigrationResponse_v1BotName :: Lens' GetMigrationResponse (Maybe Text) Source #

The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.

getMigrationResponse_v1BotVersion :: Lens' GetMigrationResponse (Maybe Text) Source #

The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.

getMigrationResponse_v2BotId :: Lens' GetMigrationResponse (Maybe Text) Source #

The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.

getMigrationResponse_v2BotRole :: Lens' GetMigrationResponse (Maybe Text) Source #

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

getMigrationResponse_httpStatus :: Lens' GetMigrationResponse Int Source #

The response's http status code.