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.
DescribeExplainability
Describe un recurso de explicabilidad creado mediante la operación. CreateExplainability
Sintaxis de la solicitud
{
"ExplainabilityArn": "string"
}Parámetros de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ExplainabilityArn
-
El nombre de recurso de Amazon (ARN) de la explicablidad que describir.
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,
"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"
}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 recurso de explicabilidad.
Tipo: marca temporal
- DataSource
-
La fuente de los datos, una función AWS Identity and Access Management (IAM) que permite a Amazon Forecast acceder a los datos y, opcionalmente, una clave AWS Key Management Service (KMS).
Tipo: objeto DataSource
- EnableVisualization
-
Si la visualización estaba habilitada para el recurso de explicabilidad.
Tipo: Booleano
- EndDateTime
-
Si
TimePointGranularityestá establecido enSPECIFIC, el último punto de tiempo en la explicabilidad.Tipo: cadena
Limitaciones de longitud: longitud máxima de 19 caracteres.
Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ - EstimatedTimeRemainingInMinutes
-
El tiempo estimado que queda en minutos para que finalice el trabajo CreateExplainability.
Tipo: largo
- ExplainabilityArn
-
El nombre de recurso de Amazon (ARN) de la explicabilidad.
Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
Patrón:
arn:([a-z\d-]+):forecast:.*:.*:.+ - ExplainabilityConfig
-
Los ajustes de configuración que definen la granularidad de las series temporales y los puntos de tiempo para la Explicabilidad.
Tipo: objeto ExplainabilityConfig
- ExplainabilityName
-
El nombre de la explicabilidad.
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_]* - LastModificationTime
-
La última vez que se modificó el recurso. La marca temporal depende del estado del trabajo:
-
CREATE_PENDING: laCreationTime. -
CREATE_IN_PROGRESS: marca temporal actual. -
CREATE_STOPPING: marca temporal actual. -
CREATE_STOPPED: cuándo se detuvo el trabajo. -
ACTIVEoCREATE_FAILED: cuando el trabajo terminó o falló.
Tipo: marca temporal
-
- Message
-
Si se produjo un error, un mensaje informativo sobre el error.
Tipo: cadena
- ResourceArn
-
El nombre de recurso de Amazon (ARN) del predictor o la previsión utilizado para crear el recurso de explicabilidad.
Tipo: cadena
Limitaciones de longitud: longitud máxima de 256.
Patrón:
arn:([a-z\d-]+):forecast:.*:.*:.+ - Schema
-
Define los campos de un conjunto de datos.
Tipo: objeto Schema
- StartDateTime
-
Si
TimePointGranularityestá establecido enSPECIFIC, el primer punto de tiempo en la explicabilidad.Tipo: cadena
Limitaciones de longitud: longitud máxima de 19 caracteres.
Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ - Status
-
El estado del recurso de explicabilidad. Los estados incluyen:
-
ACTIVE -
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
CREATE_STOPPING,CREATE_STOPPED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
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, consulte lo siguiente:
