aws_sdk_lexmodelbuilding/client/
get_migration.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetMigration`](crate::operation::get_migration::builders::GetMigrationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`migration_id(impl Into<String>)`](crate::operation::get_migration::builders::GetMigrationFluentBuilder::migration_id) / [`set_migration_id(Option<String>)`](crate::operation::get_migration::builders::GetMigrationFluentBuilder::set_migration_id):<br>required: **true**<br><p>The unique identifier of the migration to view. The <code>migrationID</code> is returned by the operation.</p><br>
7    /// - On success, responds with [`GetMigrationOutput`](crate::operation::get_migration::GetMigrationOutput) with field(s):
8    ///   - [`migration_id(Option<String>)`](crate::operation::get_migration::GetMigrationOutput::migration_id): <p>The unique identifier of the migration. This is the same as the identifier used when calling the <code>GetMigration</code> operation.</p>
9    ///   - [`v1_bot_name(Option<String>)`](crate::operation::get_migration::GetMigrationOutput::v1_bot_name): <p>The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.</p>
10    ///   - [`v1_bot_version(Option<String>)`](crate::operation::get_migration::GetMigrationOutput::v1_bot_version): <p>The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.</p>
11    ///   - [`v1_bot_locale(Option<Locale>)`](crate::operation::get_migration::GetMigrationOutput::v1_bot_locale): <p>The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.</p>
12    ///   - [`v2_bot_id(Option<String>)`](crate::operation::get_migration::GetMigrationOutput::v2_bot_id): <p>The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.</p>
13    ///   - [`v2_bot_role(Option<String>)`](crate::operation::get_migration::GetMigrationOutput::v2_bot_role): <p>The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.</p>
14    ///   - [`migration_status(Option<MigrationStatus>)`](crate::operation::get_migration::GetMigrationOutput::migration_status): <p>Indicates the status of the migration. When the status is <code>COMPLETE</code> 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.</p>
15    ///   - [`migration_strategy(Option<MigrationStrategy>)`](crate::operation::get_migration::GetMigrationOutput::migration_strategy): <p>The strategy used to conduct the migration.</p> <ul>  <li>   <p><code>CREATE_NEW</code> - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.</p></li>  <li>   <p><code>UPDATE_EXISTING</code> - 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.</p></li> </ul>
16    ///   - [`migration_timestamp(Option<DateTime>)`](crate::operation::get_migration::GetMigrationOutput::migration_timestamp): <p>The date and time that the migration started.</p>
17    ///   - [`alerts(Option<Vec::<MigrationAlert>>)`](crate::operation::get_migration::GetMigrationOutput::alerts): <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html">Migrating a bot</a> in the <i>Amazon Lex V2 developer guide</i>.</p>
18    /// - On failure, responds with [`SdkError<GetMigrationError>`](crate::operation::get_migration::GetMigrationError)
19    pub fn get_migration(&self) -> crate::operation::get_migration::builders::GetMigrationFluentBuilder {
20        crate::operation::get_migration::builders::GetMigrationFluentBuilder::new(self.handle.clone())
21    }
22}