O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. Saiba mais
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á.
ListPredictors
Exibe uma lista de preditores criados por meio das operações CreateAutoPredictor ou CreatePredictor. Para cada preditor, essa operação exibe um resumo das propriedades, incluindo o nome do recurso da Amazon (ARN).
Importante
O Amazon Forecast não está mais disponível para novos clientes. Os clientes existentes do Amazon Forecast podem continuar usando o serviço normalmente. Saiba mais
É possível recuperar o conjunto completo de propriedades usando o ARN com as operações DescribeAutoPredictor e DescribePredictor. É possível filtrar a lista usando uma matriz de objetos Filter.
Sintaxe da Solicitação
{
"Filters": [
{
"Condition": "string
",
"Key": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- Filters
-
Uma matriz de filtros. Para cada filtro, são fornecidas uma condição e uma declaração de correspondência. A condição é
IS
ouIS_NOT
, que especifica se os preditores correspondentes à declaração devem ser incluídos ou excluídos da lista, respectivamente. A declaração de correspondência consiste em uma chave e um valor.Propriedades do filtro
-
Condition
: a condição a ser aplicada. Os valores válidos sãoIS
eIS_NOT
. Para incluir os preditores correspondentes à declaração, especifiqueIS
. Para excluir preditores correspondentes, especifiqueIS_NOT
. -
Key
: o nome do parâmetro a ser filtrado. Os valores válidos sãoDatasetGroupArn
eStatus
. -
Value
: o valor a ser comparado.
Por exemplo, para listar todos os preditores cujo status seja ATIVO, especifique:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
Tipo: matriz de objetos Filter
Obrigatório: não
-
- MaxResults
-
O número de itens a serem exibidos na resposta.
Tipo: inteiro
Faixa válida: valor mínimo de 1. Valor máximo de 100.
Obrigatório: não
- NextToken
-
Se o resultado da solicitação anterior estava truncado, a resposta incluirá um
NextToken
. Para recuperar o próximo conjunto de resultados, use o token na próxima solicitação. Os tokens expiram após 24 horas.Tipo: string
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 3.000.
Padrão:
.+
Obrigatório: Não
Sintaxe da Resposta
{
"NextToken": "string",
"Predictors": [
{
"CreationTime": number,
"DatasetGroupArn": "string",
"IsAutoPredictor": boolean,
"LastModificationTime": number,
"Message": "string",
"PredictorArn": "string",
"PredictorName": "string",
"ReferencePredictorSummary": {
"Arn": "string",
"State": "string"
},
"Status": "string"
}
]
}
Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- NextToken
-
Se a resposta estiver truncada, o Amazon Forecast vai gerar esse token. Para recuperar o próximo conjunto de resultados, use o token na próxima solicitação.
Tipo: string
Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 3.000.
Padrão:
.+
- Predictors
-
Uma matriz de objetos que resumem as propriedades de cada preditor.
Tipo: matriz de objetos PredictorSummary
Erros
- InvalidInputException
-
Não podemos processar a solicitação porque ela inclui um valor inválido ou um valor que excede o intervalo válido.
Código de status HTTP: 400
- InvalidNextTokenException
-
O token não é válido. Os tokens expiram após 24 horas.
Código de Status HTTP: 400
Consulte Também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: