GetMigrations - Amazon Lex V1
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

Se você estiver usando o Amazon Lex V2, consulte o Guia do Amazon Lex V2.

 

Se você estiver usando o Amazon Lex V1, recomendamos atualizar seus bots para o Amazon Lex V2. Não estamos mais adicionando novos atributos à V1 e recomendamos o uso da V2 para todos os novos bots.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

GetMigrations

Obtém uma lista das migrações entre o Amazon Lex V1 e o Amazon Lex V2.

Sintaxe da Solicitação

GET /migrations?maxResults=maxResults&migrationStatusEquals=migrationStatusEquals&nextToken=nextToken&sortByAttribute=sortByAttribute&sortByOrder=sortByOrder&v1BotNameContains=v1BotNameContains HTTP/1.1

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

maxResults

O número máximo de migrações a serem retornadas na resposta. O padrão é 10.

Faixa válida: valor mínimo de 1. Valor máximo de 50.

migrationStatusEquals

Filtra a lista para conter somente migrações no estado especificado.

Valores Válidos: IN_PROGRESS | COMPLETED | FAILED

nextToken

Um token de paginação que busca a próxima página de migrações. Se a resposta a essa operação for truncada, o Amazon Lex retornará um token de paginação na resposta. Para buscar a próxima página de migrações, especifique o token de paginação na solicitação.

sortByAttribute

O campo pelo qual classificar a lista de migrações. Você pode classificar pelo nome do bot do Amazon Lex V1 ou pela data e hora em que a migração foi iniciada.

Valores Válidos: V1_BOT_NAME | MIGRATION_DATE_TIME

sortByOrder

A ordem para classificar a lista.

Valores Válidos: ASCENDING | DESCENDING

v1BotNameContains

Filtra a lista para conter somente bots cujo nome contenha a string especificada. A string é correspondida em qualquer lugar no nome do bot.

Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.

Padrão: ^([A-Za-z]_?)+$

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "migrationSummaries": [ 
      { 
         "migrationId": "string",
         "migrationStatus": "string",
         "migrationStrategy": "string",
         "migrationTimestamp": number,
         "v1BotLocale": "string",
         "v1BotName": "string",
         "v1BotVersion": "string",
         "v2BotId": "string",
         "v2BotRole": "string"
      }
   ],
   "nextToken": "string"
}

Elementos de Resposta

Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

migrationSummaries

Uma matriz de resumos para migrações do Amazon Lex V1 para o Amazon Lex V2. Para ver detalhes da migração, use o migrationId do resumo em uma chamada para a operação GetMigration.

Tipo: matriz de objetos MigrationSummary

nextToken

Se a resposta for truncada, ela incluirá um token de paginação que você pode especificar em sua próxima solicitação para buscar a próxima página de migrações.

Tipo: string

Erros

BadRequestException

A solicitação não está bem formada. Por exemplo, um valor é inválido ou um campo obrigatório está faltando. Verifique os valores dos campos e tente novamente.

Código de Status HTTP: 400

InternalFailureException

Ocorreu um erro interno do Amazon Lex. Tente sua solicitação novamente.

Código de Status HTTP: 500

LimitExceededException

A solicitação excedeu um limite. Tente sua solicitação novamente.

Código de status HTTP: 429

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: