CreateForecastExportJob - Amazon Forecast

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.

CreateForecastExportJob

Exporta una previsión creada por la operación CreateForecast en su bucket de Amazon Simple Storage Service (Amazon S3). El nombre del archivo de previsión coincidirá con las siguientes convenciones:

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

donde el componente < ExportTimestamp > está en Java SimpleDateFormat (aaaa-mm-ddthh-mm-SSZ).

Debe especificar un objeto DataDestination que incluya un rol (IAM) de AWS Identity and Access Management que Amazon Forecast pueda asumir para acceder al bucket de Amazon S3. Para obtener más información, consulte Configuración de permisos para Amazon Forecast.

Para obtener más información, consulte Generación de previsiones.

Para obtener una lista de todos sus trabajos de exportación de previsiones, utilice la operación ListForecastExportJobs.

nota

El Status del trabajo de exportación de previsión debe estar ACTIVE antes de poder acceder a la previsión en su bucket de Amazon S3. Utilice la operación DescribeForecastExportJob para obtener el estado.

Sintaxis de la solicitud

{ "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobName": "string", "Format": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Destination

La ubicación en la que desea guardar la previsión y una función AWS Identity and Access Management (IAM) que Amazon Forecast puede asumir para acceder a la ubicación. La previsión debe exportarse a un bucket de Amazon S3.

Si se utiliza el cifrado, Destination debe incluir una clave AWS Key Management Service (KMS). El rol de IAM debe permitir a Amazon Forecast acceder a la clave.

Tipo: objeto DataDestination

Obligatorio: sí

ForecastArn

El nombre de recurso de Amazon (ARN) de la previsión que desea exportar.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

Obligatorio: sí

ForecastExportJobName

El nombre del trabajo de exportación de previsión.

Tipo: string

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

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

Obligatorio: sí

Format

El formato de los datos exportados, CSV o PARQUET. El valor predeterminado es CSV.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 7.

Patrón: ^CSV|PARQUET$

Obligatorio: no

Tags

Los metadatos opcionales que se aplican al trabajo de exportación de previsión para ayudarle a categorizarlas y organizarlas. Cada etiqueta está formada por una clave y un valor opcional, ambos definidos por el usuario.

Se aplican las siguientes restricciones básicas a las etiquetas:

  • Número máximo de etiquetas por recurso: 50.

  • Para cada recurso, cada clave de etiqueta debe ser única y solo puede tener un valor.

  • Longitud máxima de la clave: 128 caracteres Unicode en UTF-8

  • Longitud máxima del valor: 256 caracteres Unicode en UTF-8

  • Si se utiliza su esquema de etiquetado en múltiples servicios y recursos, recuerde que otros servicios pueden tener otras restricciones sobre caracteres permitidos. Los caracteres permitidos generalmente son: letras, números y espacios representables en UTF-8, además de los siguientes caracteres: + - = . _ : / @.

  • Las claves y los valores de las etiquetas distinguen entre mayúsculas y minúsculas.

  • No utilice aws:AWS:, ni ninguna combinación de mayúsculas o minúsculas como prefijo para las claves, ya que está reservado para su uso. AWS Las claves de etiquetas que tienen este prefijo no se pueden editar ni eliminar. Los valores pueden tener este prefijo. Si el valor de una etiqueta tiene aws como prefijo pero la clave no, Forecast la considera una etiqueta de usuario y se contabilizará en el límite de 50 etiquetas. Las etiquetas que tengan solo el prefijo de clave de aws no cuentan para el límite de etiquetas por recurso.

Tipo: matriz de objetos Tag

Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.

Obligatorio: no

Sintaxis de la respuesta

{ "ForecastExportJobArn": "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.

ForecastExportJobArn

El nombre del recurso de Amazon (ARN) del trabajo de exportación.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

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

LimitExceededException

Se ha superado el límite en el número de recursos por cuenta.

Código de estado HTTP: 400

ResourceAlreadyExistsException

Ya existe un recurso con este nombre. Inténtelo de nuevo con un nombre diferente.

Código de estado HTTP: 400

ResourceInUseException

El recurso especificado está en uso.

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: