GetSessionEmbedUrl - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la requêteSyntaxe de la réponseEléments de réponseErreursVoir aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GetSessionEmbedUrl

Génère une URL de session et un code d'autorisation que vous pouvez utiliser pour intégrer Amazon Amazon QuickSight console dans le code de votre serveur Web. UtiliserGetSessionEmbedUrloù vous souhaitez fournir un portail de création qui permet aux utilisateurs de créer des sources de données, des ensembles de données, des analyses et des tableaux de bord. Les utilisateurs qui accèdent à un Amazon intégré QuickSight doit appartenir à la cohorte de sécurité de l'auteur ou de l'administrateur. Si vous souhaitez restreindre les autorisations à certaines de ces fonctionnalités, ajoutez un profil d'autorisations personnalisé à l'utilisateur avec le UpdateUser Opération d'API. Utiliser RegisterUser Opération d'API pour ajouter un nouvel utilisateur auquel est associé un profil d'autorisation personnalisé. Pour plus d'informations, consultez les sections suivantes dans leAmazon QuickSight Guide de l'utilisateur :

Syntaxe de la demande

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

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

AwsAccountId

ID pour leCompte AWSassocié à votre Amazon QuickSight abonnement.

Contraintes de longueur : Longueur fixe de 12.

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

Obligatoire : Oui

EntryPoint

URL que vous utilisez pour accéder à la session intégrée. L'URL du point d'entrée est limitée aux chemins suivants :

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - oùDashboardIdest la véritable clé d'identification d'Amazon QuickSight URL de la console du tableau de bord

  • /analyses/AnalysisId - oùAnalysisIdest la véritable clé d'identification d'Amazon QuickSight URL de la console de l'analyse

Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1 000.

SessionLifetimeInMinutes

Combien de minutes la session est valide. La durée de vie de la session doit être de 15 600 minutes.

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

UserArn

L'Amazon QuickSight ARN de l'utilisateur, à utiliser avecQUICKSIGHTtype d'identité. Vous pouvez l'utiliser pour n'importe quel type d'Amazon QuickSight utilisateurs de votre compte (lecteurs, auteurs ou administrateurs). Ils doivent être authentifiés par l'un des éléments suivants :

  1. Utilisateurs ou membres du groupe Active Directory (AD)

  2. Utilisateurs non fédérés invités

  3. AWS Identity and Access Management(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, les utilisateurs IAM et les 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 Amazon QuickSight session. 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 article. 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.

Code d'état HTTP : : 401

InternalFailureException

Une défaillance interne s'est produite.

Code d'état HTTP : : 500

InvalidParameterValueException

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

Code d'état HTTP : : 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,DescribeUser, etc.

Code d'état HTTP : : 404

ResourceExistsException

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

Code d'état HTTP : : 409

ResourceNotFoundException

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

Code d'état HTTP : : 404

SessionLifetimeInMinutesInvalidException

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

Code d'état HTTP : : 400

ThrottlingException

L'accès est limité.

Code d'état HTTP : : 429

UnsupportedUserEditionException

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

Code d'état HTTP : : 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 :