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

GenerateEmbedUrlForAnonymousUser

Genera un URL di incorporamento che puoi utilizzare per incorporare un Amazon QuickSight dashboard nel tuo sito web, senza dover registrare alcun utente lettore. Prima di usare questa azione, assicurati di aver configurato le dashboard e le autorizzazioni.

Le seguenti regole si applicano all'URL generato:

  • Contiene un gettone al portatore temporaneo. È valido per 5 minuti dopo la sua generazione. Una volta riscattato entro questo periodo, non può essere riutilizzato di nuovo.

  • Il periodo di validità dell'URL non deve essere confuso con la durata effettiva della sessione che può essere personalizzata utilizzando il SessionLifetimeInMinutes Parametro . La sessione utente risultante è valida da 15 minuti (minimo) a 10 ore (massimo). La durata predefinita della sessione è di 10 ore.

  • Ti viene addebitato solo quando viene utilizzato l'URL o c'è interazione con Amazon QuickSight.

Per ulteriori informazioni, consultaAnalisi incorporatenellaAmazon QuickSight Guida per l’utente di.

Per ulteriori informazioni sui passaggi di alto livello per l'incorporamento e per una demo interattiva dei modi in cui è possibile personalizzare l'incorporamento, visitare ilAmazon QuickSight Portale per sviluppatori.

Sintassi della richiesta

POST /accounts/AwsAccountId/embed-url/anonymous-user HTTP/1.1
Content-type: application/json

{
   "AllowedDomains": [ "string" ],
   "AuthorizedResourceArns": [ "string" ],
   "ExperienceConfiguration": { 
      "Dashboard": { 
         "InitialDashboardId": "string"
      }
   },
   "Namespace": "string",
   "SessionLifetimeInMinutes": number,
   "SessionTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Parametri della richiesta URI:

La richiesta utilizza i seguenti parametri URI.

AwsAccountId

L'ID delAccount AWSche contiene la dashboard che stai incorporando.

Vincoli di lunghezza: Lunghezza fissa di 12.

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

bbbbligatorio Sì

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

AuthorizedResourceArns

Amazon Resource Name (ARN) per Amazon QuickSight risorse a cui l'utente è autorizzato ad accedere durante la durata della sessione. Se scegliDashboardesperienza di incorporamento, passare l'elenco degli ARN del dashboard nell'account che si desidera che l'utente sia in grado di visualizzare. Attualmente, puoi passare fino a 25 ARN del dashboard in ogni chiamata API.

Type: Gamma di stringhe

bbbbligatorio Sì

ExperienceConfiguration

La configurazione dell'esperienza che stai incorporando.

Tipo: AnonymousUserEmbeddingExperienceConfiguration oggetto

bbbbligatorio Sì

Namespace

L'Amazon QuickSight spazio dei nomi a cui appartiene virtualmente l'utente anonimo. Se non utilizzi un Amazon QuickSight spazio dei nomi personalizzato, impostalo sudefault.

Type: Stringa

Vincoli di lunghezza: La lunghezza massima è 64 caratteri.

Modello: ^[a-zA-Z0-9._-]*$

bbbbligatorio Sì

AllowedDomains

I domini che si desidera aggiungere all'elenco consentiti per l'accesso all'URL generato che viene quindi incorporato. Questo parametro facoltativo sostituisce i domini statici configurati in Gestione QuickSight menu in Amazzonia QuickSight Console. Consente invece solo i domini inclusi in questo parametro. Puoi elencare fino a tre domini o sottodomini in ogni chiamata API.

Per includere tutti i sottodomini di un dominio specifico nell'elenco consentiti, utilizzare*. Ad esempio,https://*.sapp.amazon.com.rproxy.goskope.cominclude tutti i sottodomini sottohttps://sapp.amazon.com.

Type: Gamma di stringhe

bbbbligatorio No

SessionLifetimeInMinutes

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

Type: Lungo

Intervallo valido: Valore minimo di 15. valore massimo pari a 600.

bbbbligatorio No

SessionTags

I tag di sessione utilizzati per la protezione a livello di riga. Prima di usare questo parametro, assicurati di aver configurato i set di dati pertinenti utilizzando laDataSet$RowLevelPermissionTagConfigurationin modo che i tag di sessione possano essere utilizzati per fornire sicurezza a livello di riga.

Questi non sono i tag utilizzati per ilAWSFunzione di Tagging di risorse. Per ulteriori informazioni, consultaUtilizzo della protezione a livello di riga (RLS) con i tagnellaAmazon QuickSight Guida per l’utente di.

Type: Matrice diSessionTagoggetti

Membri dell'array: Numero minimo di 1 elemento. Numero massimo di 50 item.

bbbbligatorio No

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

L'URL di incorporamento per la dashboard.

Type: Stringa

RequestId

LaAWSID 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. 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

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 di stato HTTP: 400

ThrottlingException

L'accesso è limitato.

Codice di stato HTTP: 429

UnsupportedPricingPlanException

Questo errore indica che stai chiamando un'operazione di incorporamento in Amazon QuickSightsenza il piano tariffario richiesto sul tuoAWSconto. Prima di poter utilizzare l'incorporamento per utenti anonimi, un QuickSight l'amministratore deve aggiungere il prezzo della capacità ad Amazon QuickSight. Tale operazione può essere eseguita nellaGestione di Amazon QuickSight(Certificato creato).

Dopo aver aggiunto il prezzo della capacità, puoi utilizzare il GetDashboardEmbedUrl Operazione API con--identity-type ANONYMOUSopzione.

Codice di stato HTTP: 403

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 attualmente 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: