As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# DescribeTemplate
Descreve os metadados de um modelo.
## Sintaxe da solicitação
```
GET /accounts/AwsAccountId/templates/TemplateId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1
```
## Parâmetros da solicitação de URI
A solicitação usa os parâmetros de URI a seguir.
** [AliasName](#API_DescribeTemplate_RequestSyntax) **
O alias do modelo que você quer descrever. Se você nomear um alias específico, descreverá a versão para a qual o alias aponta. Você pode especificar a versão mais recente do modelo fornecendo a palavra-chave.`$LATEST`no`AliasName`parâmetro . A palavra-chave da`$PUBLISHED`não se aplica a modelos.
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão: `[\w\-]+|(\$LATEST)|(\$PUBLISHED)`
** [AwsAccountId](#API_DescribeTemplate_RequestSyntax) **
O ID daAWSconta que contém o modelo que você está descrevendo.
Restrições de comprimento: Comprimento fixo de 12.
Padrão: `^[0-9]{12}$`
Obrigatório: Sim
** [TemplateId](#API_DescribeTemplate_RequestSyntax) **
O ID do modelo.
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão: `[\w\-]+`
Obrigatório: Sim
** [VersionNumber](#API_DescribeTemplate_RequestSyntax) **
(Opcional) O número da versão a serem descritas. Em caso de`VersionNumber`valor do parâmetro não for fornecido, a versão mais recente do modelo é descrita.
Intervalo válido: Valor mínimo de 1.
## Corpo da solicitação
Essa solicitação não tem o corpo da solicitação.
## Sintaxe da resposta
```
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 resposta
Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir.
** [Status](#API_DescribeTemplate_ResponseSyntax) **
O status HTTP da solicitação.
Os seguintes dados são retornados no formato JSON pelo serviço.
** [RequestId](#API_DescribeTemplate_ResponseSyntax) **
OAWSID da solicitação para essa operação.
Type: String
** [Template](#API_DescribeTemplate_ResponseSyntax) **
A estrutura do modelo para o objeto que você quer descrever.
Tipo: objeto [Template](API_Template.md)
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte.[Erros comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso a esse item. Não foi possível validar as credenciais fornecidas fornecidas. Talvez você não tenha permissão para executar a solicitação. Verifique se sua conta está autorizada a usar a Amazon QuickSight , se as suas políticas têm as permissões corretas e se você está usando as chaves de acesso corretas.
Código de status HTTP: 401
** ConflictException **
Atualizar ou excluir um recurso pode causar um estado inconsistente.
Código de status HTTP: 409
** InternalFailureException **
Ocorreu um erro interno.
Código de status HTTP: 500
** InvalidParameterValueException **
Um ou mais parâmetros têm um valor que não é válido.
Código de status HTTP: 400
** ResourceExistsException **
O recurso especificado já existe já existe.
Código de status HTTP: 409
** ResourceNotFoundException **
Não foi possível encontrar um ou mais recursos.
Código de status HTTP: 404
** ThrottlingException **
O acesso é limitado.
Código de status HTTP: 429
** UnsupportedUserEditionException **
Esse erro indica que você está chamando uma operação em uma Amazon. QuickSightassinatura em que a edição não inclui suporte para essa operação. Amazon Amazon Amazon QuickSight atualmente está disponível na Standard Edition e Enterprise Edition. Nem todas operações e recursos estão disponível em todas as edições.
Código de status HTTP: 403
## Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeTemplate)
+ [AWSSDK para o JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeTemplate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeTemplate)