View a markdown version of this page

DescribeExplainability - Amazon Forecast
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir 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.

DescribeExplainability

Décrit une ressource d'explicabilité créée à l'aide de cette opération. CreateExplainability

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 »

Syntaxe de la requête

{
   "ExplainabilityArn": "string"
}

Paramètres de demande

Cette demande accepte les données suivantes au format JSON.

ExplainabilityArn

Le nom de la ressource Amazon (ARN) de l'explicabilité à décrire.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "CreationTime": number,
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ExplainabilityArn": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "LastModificationTime": number,
   "Message": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Status": "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 au format JSON par le service.

CreationTime

Quand la ressource Explainability a été créée.

Type : Timestamp

DataSource

La source de vos données, un rôle Gestion des identités et des accès AWS (IAM) qui permet à Amazon Forecast d'accéder aux données et, éventuellement, une clé AWS Key Management Service (KMS).

Type : objet DataSource

EnableVisualization

Si la visualisation a été activée pour la ressource Explainability.

Type : Boolean

EndDateTime

S'il TimePointGranularity est défini surSPECIFIC, le dernier point temporel de l'Explicabilité.

Type : Chaîne

Contraintes de longueur : longueur maximale de 19.

Modèle : ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

EstimatedTimeRemainingInMinutes

Temps estimé restant en minutes pour que la CreateExplainability tâche soit terminée.

Type : Long

ExplainabilityArn

Le nom de ressource Amazon (ARN) de l'explicabilité.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

ExplainabilityConfig

Les paramètres de configuration qui définissent la granularité des séries chronologiques et des points temporels pour l'explicabilité.

Type : objet ExplainabilityConfig

ExplainabilityName

Le nom de l'explicabilité.

Type : Chaîne

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

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

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 la tâche s'est terminée ou a échoué.

Type : Timestamp

Message

Si une erreur s'est produite, un message concernant l'erreur.

Type : Chaîne

ResourceArn

Le nom de ressource Amazon (ARN) du prédicteur ou de la prévision utilisé pour créer la ressource d'explicabilité.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Schema

Définit les champs d'un jeu de données.

Type : objet Schema

StartDateTime

Si TimePointGranularity est défini surSPECIFIC, le premier point temporel de l'Explicabilité.

Type : Chaîne

Contraintes de longueur : longueur maximale de 19.

Modèle : ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Status

État de la ressource d'explicabilité. Les États incluent :

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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.

Code d’état HTTP : 400

ResourceNotFoundException

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

Code d’état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :