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á.
DescribeDashboard
Fornece um resumo para um painel.
Sintaxe da solicitação
GET /accounts/AwsAccountId/dashboards/DashboardId?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
-
O nome do alias.
Restrições de tamanho: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão:
[\w\-]+|(\$LATEST)|(\$PUBLISHED) - AwsAccountId
-
A ID doAWSconta que contém o painel que você está descrevendo.
Restrições de tamanho: Comprimento fixo de 12.
Padrão:
^[0-9]{12}$Obrigatório: Sim
- DashboardId
-
A ID do painel.
Restrições de tamanho: Tamanho mínimo de 1. Tamanho máximo de 2048.
Padrão:
[\w\-]+Obrigatório: Sim
- VersionNumber
-
O número da versão do painel. Se um número de versão não for aprovado, a última versão publicada do painel será 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
{
"Dashboard": {
"Arn": "string",
"CreatedTime": number,
"DashboardId": "string",
"LastPublishedTime": number,
"LastUpdatedTime": number,
"Name": "string",
"Version": {
"Arn": "string",
"CreatedTime": number,
"DataSetArns": [ "string" ],
"Description": "string",
"Errors": [
{
"Message": "string",
"Type": "string"
}
],
"Sheets": [
{
"Name": "string",
"SheetId": "string"
}
],
"SourceEntityArn": "string",
"Status": "string",
"ThemeArn": "string",
"VersionNumber": number
}
},
"RequestId": "string"
}Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir.
- Status
-
O status HTTP dessa solicitação.
Os seguintes dados são retornados no formato JSON pelo serviço.
Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulteErros comuns.
- AccessDeniedException
-
Você não tem acesso a esse item. Não foi possível validar as credenciais 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
- 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
- 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 QuickSight 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:
