DescribeDataset - Amazon Forecast
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosVer também

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

DescribeDataset

Descreve um conjunto de dados do Amazon Forecast criado usando a CreateDatasetoperação.

Além de listar os parâmetros especificados na solicitação CreateDataset, essa operação inclui as seguintes propriedades do conjunto de dados:

  • CreationTime

  • LastModificationTime

  • Status

Sintaxe da Solicitação

{
   "DatasetArn": "string"
}

Parâmetros da solicitação

A solicitação aceita os dados a seguir no formato JSON.

DatasetArn

O nome do recurso da Amazon (ARN) do conjunto de dados.

Tipo: string

Restrições de tamanhos: tamanho máximo de 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

Exigido: Sim

Sintaxe da Resposta

{
   "CreationTime": number,
   "DataFrequency": "string",
   "DatasetArn": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "LastModificationTime": number,
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "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.

CreationTime

Quando o conjunto de dados foi criado.

Tipo: Carimbo de data/hora

DataFrequency

A frequência da coleta de dados.

Os intervalos válidos são Y (Ano), M (Mês), W (Semana), D (Dia), H (Hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) e 1min (1 minuto). Por exemplo, “M” indica todos os meses e “30min” indica a cada 30 minutos.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 5.

Padrão: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

DatasetArn

O nome do recurso da Amazon (ARN) do conjunto de dados.

Tipo: string

Restrições de tamanhos: tamanho máximo de 256.

Padrão: arn:([a-z\d-]+):forecast:.*:.*:.+

DatasetName

O nome do conjunto de dados.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 63.

Padrão: ^[a-zA-Z][a-zA-Z0-9_]*

DatasetType

O tipo de conjunto de dados.

Tipo: strings

Valores Válidos: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Domain

O domínio associado ao conjunto de dados.

Tipo: strings

Valores Válidos: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS

EncryptionConfig

Chave do AWS Key Management Service (KMS) e um perfil do AWS Identity and Access Management (IAM) que o Amazon Forecast pode assumir para acessar a chave.

Tipo: objeto EncryptionConfig

LastModificationTime

Ao criar um conjunto de dados, LastModificationTime é o mesmo que CreationTime. Enquanto os dados estão sendo importados para o conjunto de dados, LastModificationTime é a hora atual da chamada DescribeDataset. Após a conclusão de uma CreateDatasetImportJoboperação, LastModificationTime é quando o trabalho de importação foi concluído ou falhou.

Tipo: Carimbo de data/hora

Schema

Uma matriz de objetos SchemaAttribute que especificam os campos de conjuntos de dados. Cada SchemaAttribute especifica o nome e o tipo de dados de um campo.

Tipo: objeto Schema

Status

O status do conjunto de dados. Os estados são:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

Os UPDATE estados se aplicam enquanto os dados são importados para o conjunto de dados a partir de uma chamada para a CreateDatasetImportJoboperação e refletem o status do trabalho de importação do conjunto de dados. Por exemplo, quando o status do trabalho de importação é CREATE_IN_PROGRESS, o status do conjunto de dados é UPDATE_IN_PROGRESS.

nota

O Status do conjunto de dados deve ser ACTIVE para que seja possível treinar dados.

Tipo: string

Restrições de tamanhos: tamanho máximo de 256.

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

ResourceNotFoundException

Não conseguimos encontrar um recurso com esse nome de recurso da Amazon (ARN). Verifique o ARN e tente novamente.

Código de Status HTTP: 400

Ver também

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