libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LexModels.GetMigration

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

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
Eq GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Read GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Show GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Generic GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Associated Types

type Rep GetMigration :: Type -> Type #

NFData GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Methods

rnf :: GetMigration -> () #

Hashable GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

AWSRequest GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Associated Types

type AWSResponse GetMigration #

ToHeaders GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

ToPath GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

ToQuery GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

type Rep GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

type Rep GetMigration = D1 ('MetaData "GetMigration" "Amazonka.LexModels.GetMigration" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetMigration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "migrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetMigration Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

newGetMigration Source #

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:

$sel:migrationId: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

  • v1BotVersion :: Maybe Text

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

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

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

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

  • v2BotId :: Maybe Text

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

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

  • v2BotRole :: Maybe Text

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

  • migrationId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetMigrationResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Read GetMigrationResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Show GetMigrationResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Generic GetMigrationResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Associated Types

type Rep GetMigrationResponse :: Type -> Type #

NFData GetMigrationResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

Methods

rnf :: GetMigrationResponse -> () #

type Rep GetMigrationResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigration

type Rep GetMigrationResponse = D1 ('MetaData "GetMigrationResponse" "Amazonka.LexModels.GetMigration" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetMigrationResponse'" '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 "alerts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MigrationAlert])) :*: S1 ('MetaSel ('Just "migrationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationStatus))))) :*: ((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))))))

newGetMigrationResponse Source #

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:v1BotVersion:GetMigrationResponse', getMigrationResponse_v1BotVersion - The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.

$sel:migrationStrategy: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.

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

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

$sel:migrationStatus: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.

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

$sel:v1BotLocale:GetMigrationResponse', getMigrationResponse_v1BotLocale - The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.

$sel:v1BotName:GetMigrationResponse', getMigrationResponse_v1BotName - The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.

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

$sel:migrationId:GetMigration', getMigrationResponse_migrationId - The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.

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

Response Lenses

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

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

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_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_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_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_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_v2BotRole :: Lens' GetMigrationResponse (Maybe Text) Source #

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

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.