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.
DescribeTemplate
Describe los metadatos de una plantilla.
Sintaxis de la solicitud
GET /accounts/AwsAccountId/templates/TemplateId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- AliasName
-
El alias de la plantilla que desea describir. Si nombra un alias específico, describe la versión a la que apunta el alias. Puede especificar la última versión de la plantilla proporcionando la palabra clave
$LATESTen laAliasNameParámetro. La palabra clave$PUBLISHEDno se aplica a plantillas.Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Patrón:
[\w\-]+|(\$LATEST)|(\$PUBLISHED) - AwsAccountId
-
El ID de laAWScuenta que contiene la plantilla que estás describiendo.
Restricciones de longitud Longitud fija de 12.
Patrón:
^[0-9]{12}$Obligatorio: Sí
- TemplateId
-
El identificador de la plantilla.
Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.
Patrón:
[\w\-]+Obligatorio: Sí
- VersionNumber
-
(Opcional) El número de la versión que se deben describir. Si una
VersionNumberno se proporciona el valor de parámetros de. Se describe la última versión de la plantilla.Rango válido: Valor mínimo de 1.
Cuerpo de la solicitud
La solicitud no tiene un cuerpo de la solicitud.
Sintaxis de la respuesta
HTTP/1.1 Status
Content-type: application/json
{
"RequestId": "string",
"Template": {
"Arn": "string",
"CreatedTime": number,
"LastUpdatedTime": number,
"Name": "string",
"TemplateId": "string",
"Version": {
"CreatedTime": number,
"DataSetConfigurations": [
{
"ColumnGroupSchemaList": [
{
"ColumnGroupColumnSchemaList": [
{
"Name": "string"
}
],
"Name": "string"
}
],
"DataSetSchema": {
"ColumnSchemaList": [
{
"DataType": "string",
"GeographicRole": "string",
"Name": "string"
}
]
},
"Placeholder": "string"
}
],
"Description": "string",
"Errors": [
{
"Message": "string",
"Type": "string"
}
],
"Sheets": [
{
"Name": "string",
"SheetId": "string"
}
],
"SourceEntityArn": "string",
"Status": "string",
"ThemeArn": "string",
"VersionNumber": number
}
}
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.
- Status
-
El estado HTTP de la solicitud.
El servicio devuelve los datos siguientes en formato JSON.
Errores
Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar Amazon QuickSight , que sus políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.
Código de estado HTTP: 401
- ConflictException
-
La actualización o eliminación de un recurso puede provocar un estado incoherente.
Código de estado HTTP: 409
- InternalFailureException
-
Se produjo un error interno.
Código de estado HTTP: 500
- InvalidParameterValueException
-
Uno o más parámetros tienen un valor que no es válido.
Código de estado HTTP: 400
- ResourceExistsException
-
El recurso especificado ya existe.
Código de estado HTTP: 409
- ResourceNotFoundException
-
No se encuentran uno o varios recursos.
Código de estado HTTP: 404
- ThrottlingException
-
El acceso está limitado.
Código de estado HTTP: 429
- UnsupportedUserEditionException
-
Este error indica que está llamando a una operación en Amazon QuickSighten la que la edición no incluye soporte para esa operación. Amazon Amazon QuickSight actualmente tiene Standard Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.
Código de estado HTTP: 403
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
