DescribeWhatIfForecastExport - Amazon Forecast
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Amazon Forecast n'est plus disponible pour les nouveaux clients. Les clients existants d'Amazon Forecast peuvent continuer à utiliser le service normalement. En savoir plus »

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribeWhatIfForecastExport

Décrit l'exportation de prévisions hypothétiques créée à l'aide de cette opération. CreateWhatIfForecastExport

Important

Amazon Forecast n'est plus disponible pour les nouveaux clients. Les clients existants d'Amazon Forecast peuvent continuer à utiliser le service normalement. En savoir plus »

Outre la liste des propriétés fournies dans la CreateWhatIfForecastExport demande, cette opération répertorie les propriétés suivantes :

  • CreationTime

  • LastModificationTime

  • Message- Si une erreur s'est produite, informations sur l'erreur.

  • Status

Syntaxe de la requête

{
   "WhatIfForecastExportArn": "string"
}

Paramètres de demande

La demande accepte les données suivantes au JSON format suivant.

WhatIfForecastExportArn

Le nom de la ressource Amazon (ARN) de l'exportation de prévisions hypothétiques qui vous intéresse.

Type : String

Contraintes de longueur : longueur maximale de 300.

Modèle : arn:([a-z\d-]+):forecast:.*:.*:.+

Obligatoire : oui

Syntaxe de la réponse

{
   "CreationTime": number,
   "Destination": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EstimatedTimeRemainingInMinutes": number,
   "Format": "string",
   "LastModificationTime": number,
   "Message": "string",
   "Status": "string",
   "WhatIfForecastArns": [ "string" ],
   "WhatIfForecastExportArn": "string",
   "WhatIfForecastExportName": "string"
}

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées sous JSON forme formatée par le service.

CreationTime

Date à laquelle l'exportation des prévisions hypothétiques a été créée.

Type : Timestamp

Destination

Destination d'une tâche d'exportation. Fournissez un chemin S3, un rôle AWS Identity and Access Management (IAM) permettant à Amazon Forecast d'accéder à l'emplacement et une clé AWS Key Management Service (KMS) (facultatif).

Type : objet DataDestination

EstimatedTimeRemainingInMinutes

Temps approximatif restant pour terminer l'exportation des prévisions hypothétiques, en minutes.

Type : long

Format

Le format des données exportées, CSV ouPARQUET.

Type : String

Contraintes de longueur : longueur maximale de 7.

Modèle : ^CSV|PARQUET$

LastModificationTime

La dernière fois que la ressource a été modifiée. L'horodatage dépend du statut de la tâche :

  • CREATE_PENDING- LeCreationTime.

  • CREATE_IN_PROGRESS- L'horodatage actuel.

  • CREATE_STOPPING- L'horodatage actuel.

  • CREATE_STOPPED- Quand le travail s'est arrêté.

  • ACTIVEou CREATE_FAILED - Lorsque le travail s'est terminé ou a échoué.

Type : Timestamp

Message

Si une erreur s'est produite, un message d'information la concernant.

Type : String

Status

État de la prévision hypothétique. Les États incluent :

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Note

L'exportation Status des prévisions hypothétiques doit être effectuée ACTIVE avant que vous puissiez accéder à l'exportation des prévisions.

Type : String

Contraintes de longueur : longueur maximale de 256.

WhatIfForecastArns

Un tableau de noms de ressources Amazon (ARNs) qui représente toutes les prévisions hypothétiques exportées dans cette ressource.

Type : tableau de chaînes

Contraintes de longueur : longueur maximale de 300.

Modèle : arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastExportArn

Le nom de la ressource Amazon (ARN) de l'exportation des prévisions hypothétiques.

Type : String

Contraintes de longueur : longueur maximale de 300.

Modèle : arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastExportName

Nom de l'exportation de prévisions hypothétiques.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.

Modèle : ^[a-zA-Z][a-zA-Z0-9_]*

Erreurs

InvalidInputException

Nous ne pouvons pas traiter la demande car elle contient une valeur non valide ou une valeur qui dépasse la plage valide.

HTTPCode de statut : 400

ResourceNotFoundException

Nous ne trouvons aucune ressource portant ce nom de ressource Amazon (ARN). Vérifiez le ARN et réessayez.

HTTPCode de statut : 400

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :