DescribeDataset - Amazon Forecast
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeDataset

Describe un conjunto de datos de Amazon Forecast creado mediante la CreateDatasetoperación.

Además de enumerar los parámetros especificados en la solicitud CreateDataset, esta operación incluye las siguientes propiedades de conjunto de datos:

  • CreationTime

  • LastModificationTime

  • Status

Sintaxis de la solicitud

{
   "DatasetArn": "string"
}

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

DatasetArn

El nombre de recurso de Amazon (ARN) del conjunto de datos.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

Obligatorio: sí

Sintaxis de la respuesta

{
   "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 respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CreationTime

Cuándo se creó el conjunto de datos.

Tipo: marca temporal

DataFrequency

La frecuencia de la recopilación de datos.

Los intervalos válidos son Y (año), M (mes), W (semana), D (día), H (hora), 30min (30 minutos), 15min (15 minutos), 10min (10 minutos), 5min (5 minutos) y 1min (1 minuto). Por ejemplo, “M” indica todos los meses y “30min” indica cada 30 minutos.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 5.

Patrón: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

DatasetArn

El nombre de recurso de Amazon (ARN) del conjunto de datos.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):forecast:.*:.*:.+

DatasetName

Nombre del conjunto de datos.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 63.

Patrón: ^[a-zA-Z][a-zA-Z0-9_]*

DatasetType

El tipo del conjunto de datos.

Tipo: cadena

Valores válidos: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Domain

El dominio asociado al conjunto de datos.

Tipo: cadena

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

EncryptionConfig

La clave AWS Key Management Service (KMS) y la función AWS Identity and Access Management (IAM) que Amazon Forecast puede asumir para acceder a la clave.

Tipo: objeto EncryptionConfig

LastModificationTime

Cuando crea un conjunto de datos, LastModificationTime es lo mismo que CreationTime. Mientras se importan los datos al conjunto de datos, LastModificationTime es la hora actual de la llamada a DescribeDataset. Una vez finalizada una CreateDatasetImportJoboperación, LastModificationTime es cuando el trabajo de importación se ha completado o ha fallado.

Tipo: marca temporal

Schema

Una matriz de objetos SchemaAttribute en la que se especifican los campos del conjunto de datos. Cada SchemaAttribute especifica el nombre y el tipo de datos de un campo.

Tipo: objeto Schema

Status

El estado del conjunto de datos. Los estados incluyen:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

Los UPDATE estados se aplican cuando los datos se importan al conjunto de datos desde una llamada a la CreateDatasetImportJoboperación y reflejan el estado del trabajo de importación del conjunto de datos. Por ejemplo, cuando el estado del trabajo de importación es CREATE_IN_PROGRESS, el estado del conjunto de datos es UPDATE_IN_PROGRESS.

nota

Para poder importar los datos de entrenamiento, el Status del conjunto de datos debe ser ACTIVE.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Errores

InvalidInputException

No podemos procesar la solicitud porque incluye un valor no válido o un valor que supera el rango válido.

Código de estado HTTP: 400

ResourceNotFoundException

No podemos encontrar un recurso con ese nombre de recurso de Amazon (ARN). Compruebe el ARN e inténtelo de nuevo.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: