| 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.GetMigrations
Description
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
Synopsis
- data GetMigrations = GetMigrations' {}
 - newGetMigrations :: GetMigrations
 - getMigrations_maxResults :: Lens' GetMigrations (Maybe Natural)
 - getMigrations_migrationStatusEquals :: Lens' GetMigrations (Maybe MigrationStatus)
 - getMigrations_nextToken :: Lens' GetMigrations (Maybe Text)
 - getMigrations_sortByAttribute :: Lens' GetMigrations (Maybe MigrationSortAttribute)
 - getMigrations_sortByOrder :: Lens' GetMigrations (Maybe SortOrder)
 - getMigrations_v1BotNameContains :: Lens' GetMigrations (Maybe Text)
 - data GetMigrationsResponse = GetMigrationsResponse' {}
 - newGetMigrationsResponse :: Int -> GetMigrationsResponse
 - getMigrationsResponse_migrationSummaries :: Lens' GetMigrationsResponse (Maybe [MigrationSummary])
 - getMigrationsResponse_nextToken :: Lens' GetMigrationsResponse (Maybe Text)
 - getMigrationsResponse_httpStatus :: Lens' GetMigrationsResponse Int
 
Creating a Request
data GetMigrations Source #
See: newGetMigrations smart constructor.
Constructors
| GetMigrations' | |
Fields 
  | |
Instances
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:maxResults:GetMigrations', getMigrations_maxResults - The maximum number of migrations to return in the response. The default
 is 10.
$sel:migrationStatusEquals:GetMigrations', getMigrations_migrationStatusEquals - Filters the list to contain only migrations in the specified state.
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: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:sortByOrder:GetMigrations', getMigrations_sortByOrder - The order so sort the list.
$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.
Request Lenses
getMigrations_maxResults :: Lens' GetMigrations (Maybe Natural) Source #
The maximum number of migrations to return in the response. The default is 10.
getMigrations_migrationStatusEquals :: Lens' GetMigrations (Maybe MigrationStatus) Source #
Filters the list to contain only migrations in the specified state.
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_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_sortByOrder :: Lens' GetMigrations (Maybe SortOrder) Source #
The order so sort the list.
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.
Destructuring the Response
data GetMigrationsResponse Source #
See: newGetMigrationsResponse smart constructor.
Constructors
| GetMigrationsResponse' | |
Fields 
  | |
Instances
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.
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.
getMigrationsResponse_httpStatus :: Lens' GetMigrationsResponse Int Source #
The response's http status code.