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

DescribeExplainability

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

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

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

ExplainabilityArn

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

Type : String

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 sous JSON forme formatée par le service.

CreationTime

Date de création de la ressource Explainability.

Type : Timestamp

DataSource

La source de vos données, un rôle AWS Identity and Access Management (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 : booléen

EndDateTime

Il TimePointGranularity est défini surSPECIFIC, le dernier point temporel de l'explicabilité.

Type : String

Contraintes de longueur : longueur maximale de 19.

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

EstimatedTimeRemainingInMinutes

Le temps restant estimé, en minutes, pour terminer le CreateExplainability travail.

Type : long

ExplainabilityArn

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

Type : String

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 : String

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 le travail s'est terminé ou a échoué.

Type : Timestamp

Message

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

Type : String

ResourceArn

Nom de la ressource Amazon (ARN) du Predictor ou Forecast utilisé pour créer la ressource Explainability.

Type : String

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

Il TimePointGranularity est défini surSPECIFIC, le premier point temporel de l'explicabilité.

Type : String

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 Explainability. Les États incluent :

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Type : String

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.

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 :