GetSessionEmbedUrl - 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à.

GetSessionEmbedUrl

Genera un URL di sessione e un codice di autorizzazione che puoi utilizzare per incorporare Amazon Amazon QuickSight console nel codice di server Web. UtilizzaGetSessionEmbedUrldove si desidera fornire un portale di authoring che consenta agli utenti di creare origini dati, set di dati, analisi e dashboard. Gli utenti che accedono a un Amazon incorporato QuickSight la console deve appartenere alla coorte di sicurezza dell'autore o dell'amministratore. Se si desidera limitare le autorizzazioni ad alcune di queste funzionalità, aggiungere un profilo di autorizzazioni personalizzato all'utente con UpdateUser Operazione API. Utilizza RegisterUser Operazione API per aggiungere un nuovo utente con un profilo di autorizzazione personalizzato allegato. Per ulteriori informazioni, consulta le sezioni seguenti nellaAmazon QuickSight Guida per l’utente di:

Sintassi della richiesta

GET /accounts/AwsAccountId/session-embed-url?entry-point=EntryPoint&session-lifetime=SessionLifetimeInMinutes&user-arn=UserArn HTTP/1.1

Parametri della richiesta URI:

La richiesta utilizza i seguenti parametri URI.

AwsAccountId

L'ID per ilAccount AWSassociato al tuo Amazon QuickSight Abbonamento.

Vincoli di lunghezza: Lunghezza fissa di 12.

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

Campo obbligatorio: Sì

EntryPoint

L'URL utilizzato per accedere alla sessione incorporata. L'URL del punto di ingresso è vincolato ai seguenti percorsi:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - doveDashboardIdè la chiave ID effettiva dell'Amazon QuickSight URL della console della dashboard

  • /analyses/AnalysisId - doveAnalysisIdè la chiave ID effettiva dell'Amazon QuickSight URL della console dell'analisi

Vincoli di lunghezza: Lunghezza minima pari a 1. Lunghezza massima di 1000.

SessionLifetimeInMinutes

Quanti minuti è valida la sessione. La durata di una sessione deve essere di 15-600 minuti.

Interlo di lo lo Valore minimo di 15. valore massimo pari a 600.

UserArn

L'Amazon QuickSight L'Amazon Resource Name (ARN) dell'utente, da usare conQUICKSIGHTTipo di identità. Puoi usarlo per qualsiasi tipo di Amazon QuickSight utenti nel tuo account (lettori, autori o amministratori). Devono essere autenticati come uno dei seguenti:

  1. Membri di gruppi e utenti di Active Directory

  2. Codice di utenti non federati

  3. AWS Identity and Access ManagementUtenti IAM autenticati tramite Federated Single Sign-On con SAML, OpenID Connect o la federazione IAM

Omettere questo parametro per gli utenti del terzo gruppo, gli utenti IAM e le sessioni basate sui ruoli IAM.

Corpo della richiesta

La richiesta non ha un corpo della richiesta.

Sintassi della risposta

HTTP/1.1 Status
Content-type: application/json

{
   "EmbedUrl": "string",
   "RequestId": "string"
}

Elementi di risposta

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

Status

Lo stato HTTP della richiesta.

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

EmbedUrl

Un URL monouso che puoi inserire nella tua pagina web lato server per incorporare il tuo Amazon QuickSight sessione. Questo URL è valido per 5 minuti. L'operazione API fornisce all'URL unauth_codeche abilita un (e solo uno) accesso a una sessione utente valida per 10 ore.

Type: Stringa

RequestId

LaAWSCodice di una richiesta per questa operazione.

Type: Stringa

Errori

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

AccessDeniedException

Non hai l'accesso a questo articolo. 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 servizio, che le policy abbiano le autorizzazioni corrette e che siano utilizzate le chiavi di accesso corrette.

Codice Codice Codice Codice stato HTTP Codice 401

InternalFailureException

Si è verificato un errore interno.

Codice Codice Codice Codice stato HTTP Codice 500

InvalidParameterValueException

Uno o più parametri hanno un valore non valido.

Codice Codice Codice Codice stato HTTP Codice 400

QuickSightUserNotFoundException

L'utente con il nome fornito non è stato trovato. Questo errore può verificarsi in qualsiasi operazione che richiede la ricerca di un utente in base a un nome utente fornito, ad esempioDeleteUser,DescribeUsere così via.

Codice Codice Codice Codice stato HTTP Codice 404

ResourceExistsException

La risorsa specificata esiste già.

Codice Codice Codice Codice stato HTTP Codice 409

ResourceNotFoundException

Uno o più risorse non sono state trovate.

Codice Codice Codice Codice stato HTTP Codice 404

SessionLifetimeInMinutesInvalidException

Il numero di minuti specificato per la durata di una sessione non è valido. La durata di una sessione deve essere di 15-600 minuti.

Codice Codice Codice Codice stato HTTP Codice 400

ThrottlingException

L'accesso è limitato.

Codice Codice Codice Codice stato HTTP Codice 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 QuickSight Al momento ha Standard Edition ed Enterprise Edition. Non tutte le operazioni e funzionalità sono disponibili in ogni edizione.

Codice Codice Codice Codice stato HTTP Codice 403

Vedi anche

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