GetDashboardEmbedUrl

Génère une URL de session temporaire et un code d'autorisation (jeton porteur) que vous pouvez utiliser pour intégrer un Amazon QuickSight tableau de bord en lecture seule sur votre site Web ou votre application. Avant d'utiliser cette commande, assurez-vous d'avoir configuré les tableaux de bord et les autorisations.

Actuellement, vous pouvez utiliserGetDashboardEmbedURLuniquement depuis le serveur, pas depuis le navigateur de l'utilisateur. Les règles suivantes s'appliquent à l'URL générée :

• Ces valeurs doivent être utilisées ensemble.

• Ils ne peuvent être utilisés qu'une seule fois.

• Ces valeurs sont valides pendant 5 minutes après l'exécution de cette commande.

• Vous êtes facturé uniquement lorsque l'URL est utilisée ou en cas d'interaction avec Amazon QuickSight.

• La session utilisateur qui en résulte est valide pendant 15 minutes (par défaut) jusqu'à 10 heures (maximum). Vous pouvez utiliser l'optionSessionLifetimeInMinutespour personnaliser la durée de la session.

Pour de plus amples informations, veuillez consulterIntégration de l'analyse à l'aide GetDashboardEmbedUrldans leAmazon QuickSight Guide de l'utilisateur.

Pour plus d'informations sur les étapes de haut niveau relatives à l'intégration et pour une démonstration interactive de la manière dont vous pouvez personnaliser l'intégration, visitez leAmazon QuickSight Portail des développeurs.

Syntaxe de la demande

GET /accounts/AwsAccountId/dashboards/DashboardId/embed-url?additional-dashboard-ids=AdditionalDashboardIds&creds-type=IdentityType&namespace=Namespace&reset-disabled=ResetDisabled&session-lifetime=SessionLifetimeInMinutes&state-persistence-enabled=StatePersistenceEnabled&undo-redo-disabled=UndoRedoDisabled&user-arn=UserArn HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AdditionalDashboardIds

Une liste d'un ou de plusieurs ID de tableau de bord auxquels vous souhaitez que les utilisateurs anonymes aient un accès temporaire. Actuellement, leIdentityTypeparamètre doit être défini surANONYMOUScar d'autres types d'identité s'authentifient en tant qu'Amazon QuickSight ou les utilisateurs IAM. Par exemple, si vous définissez »--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS», la session peut accéder aux trois tableaux de bord.

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 20 éléments.

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : [\w\-]+

AwsAccountId

ID pour leCompte AWSqui contient le tableau de bord que vous intégrez.

Contraintes de longueur : Longueur fixe de 12.

Modèle : ^[0-9]{12}$

Obligatoire : Oui

DashboardId

ID pour le tableau de bord, également ajouté à laAWS Identity and Access ManagementStratégie (IAM).

Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 2048.

Modèle : [\w\-]+

Obligatoire : Oui

IdentityType

Méthode d'authentification utilisée par l'utilisateur pour se connecter.

Valeurs valides : IAM | QUICKSIGHT | ANONYMOUS

Obligatoire : Oui

Namespace

Amazon QuickSight espace de noms qui contient les ID de tableau de bord dans cette demande. Si vous n'utilisez pas d'espace de noms personnalisé, définissezNamespace = default.

Contraintes de longueur : Longueur maximale de 64.

Modèle : ^[a-zA-Z0-9._-]*$

ResetDisabled

Supprime le bouton reset (réinitialisation) sur le tableau de bord intégré. La valeur par défaut est FALSE, ce qui active le bouton de réinitialisation.

SessionLifetimeInMinutes

Combien de minutes la session est valide. La vie de la session doit être comprise entre 15 et 600 minutes.

Plage valide : La valeur minimale est 15. Valeur maximale fixée à 600.

StatePersistenceEnabled

Ajoute la persistance de l'état pour la session utilisateur dans un tableau de bord intégré. La persistance s'applique à la feuille et aux paramètres. Il s'agit des paramètres de contrôle que l'abonné du tableau de bord (Amazon QuickSight reader) choisit lors de l'affichage du tableau de bord. Si ce paramètre est défini surTRUE, les paramètres sont les mêmes lorsque l'abonné rouvre la même URL de tableau de bord. L'état est stocké sur Amazon QuickSight, pas dans un cookie de navigateur. Si ce paramètre est défini sur FALSE, l'état de la session utilisateur n'est pas conservé. La valeur par défaut est FALSE.

UndoRedoDisabled

Supprime le bouton undo/redo (annuler/rétablir) du tableau de bord intégré. La valeur par défaut est FALSE, ce qui active le bouton Annuler/Rétablir.

UserArn

Amazon QuickSight ARN (Amazon Resource Name) de l'utilisateur, à utiliser avecQUICKSIGHTType d'identité. Vous pouvez l'utiliser pour n'importe quel Amazon QuickSight utilisateurs de votre compte (lecteurs, auteurs ou administrateurs) authentifiés comme suit :

• Utilisateurs ou membres du groupe Active Directory (AD)

• Utilisateurs non fédérés invités

• Utilisateurs IAM et sessions basées sur un rôle IAM authentifiés par le biais de l'authentification unique (SSO) fédérée utilisant SAML, OpenID Connect ou la fédération IAM.

Ignorez ce paramètre pour les utilisateurs du troisième groupe (utilisateurs IAM et sessions basées sur les rôles IAM).

Corps de la requête

La demande n'a pas de corps de requête.

Syntaxe de la réponse

HTTP/1.1 Status
Content-type: application/json

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

Eléments de réponse

Si l'action aboutit, le service renvoie la réponse HTTP suivante.

Status

Le statut HTTP de la requête.

Les données suivantes sont renvoyées au format JSON par le service.

EmbedUrl

URL à usage unique que vous pouvez insérer dans votre page Web côté serveur pour intégrer votre tableau de bord. Cette URL est valide pendant 5 minutes. L'opération API fournit l'URL avec unauth_codequi permet une (et une seule) connexion à une session utilisateur valide pendant 10 heures.

Type : Chaîne

RequestId

LeAWSID de demande pour cette opération.

Type : Chaîne

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

AccessDeniedException

Vous n'avez pas accès à cet élément. Les informations d'identification fournies n'ont pas pu être validées. Il est possible que vous ne soyez pas autorisé à effectuer la demande. Assurez-vous que votre compte est autorisé à utiliser Amazon QuickSight , que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.

HTTP Status Code : 401

DomainNotWhitelistedException

Le domaine spécifié ne figure pas sur la liste d'autorisation. Tous les domaines associés aux tableaux de bord intégrés doivent être ajoutés à la liste approuvée par un Amazon QuickSight administrateur.

HTTP Status Code : 403

IdentityTypeNotSupportedException

Le type d'identité spécifié n'est pas pris en charge. Type d'identité pris en charge :IAMetQUICKSIGHT.

HTTP Status Code : 403

InternalFailureException

Une défaillance interne s'est produite.

HTTP Status Code : 500

InvalidParameterValueException

La valeur d'un ou de plusieurs paramètres n'est pas valide.

HTTP Status Code : 400

QuickSightUserNotFoundException

L'utilisateur avec le nom fourni est introuvable. Cette erreur peut se produire dans toute opération qui nécessite de rechercher un utilisateur en se basant sur un nom d'utilisateur fourni, par exempleDeleteUser,DescribeUseretc.

HTTP Status Code : 404

ResourceExistsException

La ressource spécifiée existe déjà.

HTTP Status Code : 409

ResourceNotFoundException

Une ou plusieurs ressources n'ont pas pu être trouvées.

HTTP Status Code : 404

SessionLifetimeInMinutesInvalidException

Le nombre de minutes spécifié pour la durée de vie d'une session n'est pas valide. La vie de la session doit être comprise entre 15 et 600 minutes.

HTTP Status Code : 400

ThrottlingException

L'accès est limité.

HTTP Status Code : 429

UnsupportedPricingPlanException

Cette erreur indique que vous appelez une opération d'intégration dans Amazon. QuickSightsans le plan tarifaire requis sur votreAWS. Avant de pouvoir utiliser l'intégration pour les utilisateurs anonymes, un QuickSight l'administrateur doit ajouter la tarification de la capacité à Amazon QuickSight. Vous pouvez effectuer cette opération dans le champGérer Amazon QuickSight.

Une fois la tarification de la capacité ajoutée, vous pouvez utiliser le GetDashboardEmbedUrl Opération d'API avec le--identity-type ANONYMOUSoption.

HTTP Status Code : 403

UnsupportedUserEditionException

Cette erreur indique que vous appelez une opération portant sur un compte Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon QuickSight est actuellement disponible pour Standard Edition et Enterprise Edition. Toutes les opérations et fonctionnalités ne sont pas disponibles dans chaque édition.

HTTP Status Code : 403

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• Kit AWS SDK pour C++

• Kit AWS SDK pour Go

• AWS SDK for Java V2

• AWSKits SDK pour JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• Kit SDK AWS pour Ruby V3