DescribeDashboard - Amazon QuickSight
Sintassi della richiestaParametri della richiesta URI:Corpo della richiestaSintassi della rispostaElementi di rispostaErroriVedi anche

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

DescribeDashboard

Fornisce un riepilogo per una dashboard.

Sintassi della richiesta

GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

Parametri della richiesta URI:

La richiesta utilizza i seguenti parametri URI.

AliasName

Il nome alias.

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 2048 caratteri.

Modello: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

L'ID delAWSaccount che contiene la dashboard che stai descrivendo.

Vincoli di lunghezza: Lunghezza fissa di 12.

Modello: ^[0-9]{12}$

Campo obbligatorio: Sì

DashboardId

L'ID del dashboard.

Vincoli di lunghezza: Lunghezza minima pari a 1. La lunghezza massima è 2048 caratteri.

Modello: [\w\-]+

Campo obbligatorio: Sì

VersionNumber

Il numero di versione del dashboard. Se non viene passato un numero di versione, viene descritta l'ultima versione pubblicata della dashboard.

Intervallo valido: Valore minimo di 1.

Corpo della richiesta

La richiesta non ha un corpo della richiesta.

Sintassi della risposta

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"
}

Elementi di risposta

Se l'operazione riesce, il servizio restituisce la seguente risposta HTTP.

Status

Lo stato HTTP di questa richiesta.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

Dashboard

Informazioni sulla dashboard.

Tipo: Dashboard oggetto

RequestId

LaAWSID della richiesta per questa operazione.

Type: Stringa

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

AccessDeniedException

Non hai l'accesso. Le credenziali fornite non possono essere convalidate. È possibile che non sei autorizzato a effettuare la richiesta. Assicurati che il tuo account sia autorizzato a utilizzare Amazon QuickSight , che le policy abbiano le autorizzazioni corrette e che siano utilizzate le chiavi di accesso corrette.

Codice di stato HTTP: 401

InternalFailureException

Si è verificato un errore interno.

Codice di stato HTTP: 500

InvalidParameterValueException

Uno o più parametri hanno un valore non valido.

Codice di stato HTTP: 400

ResourceNotFoundException

Uno o più risorse non sono state trovate.

Codice di stato HTTP: 404

ThrottlingException

L'accesso è limitato.

Codice di stato HTTP: 429

UnsupportedUserEditionException

Questo errore indica che si sta chiamando un'operazione su Amazon QuickSightabbonamento in cui l'edizione non include il supporto per tale operazione. Amazon Amazon QuickSight al momento ha Standard Edition ed Enterprise Edition. Non tutte le operazioni e funzionalità sono disponibili in ogni edizione.

Codice di stato HTTP: 403

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: