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

Description

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

Synopsis

Creating a Request

data GetMigrations Source #

See: newGetMigrations smart constructor.

Constructors

GetMigrations' 

Fields

  • sortByOrder :: Maybe SortOrder

    The order so sort the list.

  • sortByAttribute :: Maybe MigrationSortAttribute

    The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

  • nextToken :: Maybe Text

    A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

  • migrationStatusEquals :: Maybe MigrationStatus

    Filters the list to contain only migrations in the specified state.

  • v1BotNameContains :: Maybe Text

    Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

  • maxResults :: Maybe Natural

    The maximum number of migrations to return in the response. The default is 10.

Instances

Instances details
Eq GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Read GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Show GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Generic GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Associated Types

type Rep GetMigrations :: Type -> Type #

NFData GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Methods

rnf :: GetMigrations -> () #

Hashable GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

AWSRequest GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Associated Types

type AWSResponse GetMigrations #

ToHeaders GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

ToPath GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

ToQuery GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

type Rep GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

type Rep GetMigrations = D1 ('MetaData "GetMigrations" "Amazonka.LexModels.GetMigrations" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetMigrations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sortByOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: (S1 ('MetaSel ('Just "sortByAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationSortAttribute)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "migrationStatusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationStatus)) :*: (S1 ('MetaSel ('Just "v1BotNameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse GetMigrations Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

newGetMigrations :: GetMigrations Source #

Create a value of GetMigrations 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:sortByOrder:GetMigrations', getMigrations_sortByOrder - The order so sort the list.

$sel:sortByAttribute:GetMigrations', getMigrations_sortByAttribute - The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

$sel:nextToken:GetMigrations', getMigrations_nextToken - A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

$sel:migrationStatusEquals:GetMigrations', getMigrations_migrationStatusEquals - Filters the list to contain only migrations in the specified state.

$sel:v1BotNameContains:GetMigrations', getMigrations_v1BotNameContains - Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

$sel:maxResults:GetMigrations', getMigrations_maxResults - The maximum number of migrations to return in the response. The default is 10.

Request Lenses

getMigrations_sortByAttribute :: Lens' GetMigrations (Maybe MigrationSortAttribute) Source #

The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

getMigrations_nextToken :: Lens' GetMigrations (Maybe Text) Source #

A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

getMigrations_migrationStatusEquals :: Lens' GetMigrations (Maybe MigrationStatus) Source #

Filters the list to contain only migrations in the specified state.

getMigrations_v1BotNameContains :: Lens' GetMigrations (Maybe Text) Source #

Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

getMigrations_maxResults :: Lens' GetMigrations (Maybe Natural) Source #

The maximum number of migrations to return in the response. The default is 10.

Destructuring the Response

data GetMigrationsResponse Source #

See: newGetMigrationsResponse smart constructor.

Constructors

GetMigrationsResponse' 

Fields

  • migrationSummaries :: Maybe [MigrationSummary]

    An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the migrationId from the summary in a call to the operation.

  • nextToken :: Maybe Text

    If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetMigrationsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Read GetMigrationsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Show GetMigrationsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Generic GetMigrationsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Associated Types

type Rep GetMigrationsResponse :: Type -> Type #

NFData GetMigrationsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

Methods

rnf :: GetMigrationsResponse -> () #

type Rep GetMigrationsResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetMigrations

type Rep GetMigrationsResponse = D1 ('MetaData "GetMigrationsResponse" "Amazonka.LexModels.GetMigrations" "libZSservicesZSamazonka-lex-modelsZSamazonka-lex-models" 'False) (C1 ('MetaCons "GetMigrationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "migrationSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MigrationSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetMigrationsResponse Source #

Create a value of GetMigrationsResponse 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:migrationSummaries:GetMigrationsResponse', getMigrationsResponse_migrationSummaries - An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the migrationId from the summary in a call to the operation.

$sel:nextToken:GetMigrations', getMigrationsResponse_nextToken - If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.

$sel:httpStatus:GetMigrationsResponse', getMigrationsResponse_httpStatus - The response's http status code.

Response Lenses

getMigrationsResponse_migrationSummaries :: Lens' GetMigrationsResponse (Maybe [MigrationSummary]) Source #

An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the migrationId from the summary in a call to the operation.

getMigrationsResponse_nextToken :: Lens' GetMigrationsResponse (Maybe Text) Source #

If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.