GenerateEmbedUrlForRegisteredUser - Amazon QuickSight
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe 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.

GenerateEmbedUrlForRegisteredUser

Génère une URL d'intégration que vous pouvez utiliser pour intégrer un Amazon QuickSight expérience dans votre site web. Cette action peut être utilisée pour tout type d'utilisateur enregistré sur Amazon QuickSight . Avant d'effectuer cette action, assurez-vous d'avoir configuré les informations Amazon appropriées QuickSight ressources et autorisations.

Les règles suivantes s'appliquent à l'URL générée :

  • Il contient un jeton au porteur temporaire. Il est valide pendant 5 minutes après sa génération. Une fois utilisé pendant cette période, il ne peut pas être réutilisé.

  • La période de validité de l'URL ne doit pas être confondue avec la durée de vie réelle de la session qui peut être personnalisée en utilisant le SessionLifetimeInMinutes   Paramètre .

    La session utilisateur qui en résulte est valide pendant 15 minutes (minimum) à 10 heures (maximum). Par défaut, la durée de la session est de 10 heures.

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

Pour de plus amples informations, veuillez consulterAnalyses intégréesdans 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

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

{
   "AllowedDomains": [ "string" ],
   "ExperienceConfiguration": { 
      "Dashboard": { 
         "InitialDashboardId": "string"
      },
      "QSearchBar": { 
         "InitialTopicId": "string"
      },
      "QuickSightConsole": { 
         "InitialPath": "string"
      }
   },
   "SessionLifetimeInMinutes": number,
   "UserArn": "string"
}

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

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

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

ExperienceConfiguration

L'expérience que vous intégrez. Pour les utilisateurs enregistrés, vous pouvez intégrer Amazon QuickSight des tableaux de bord ou l'ensemble d'Amazon QuickSight console

Type : objet RegisteredUserEmbeddingExperienceConfiguration

Obligatoire : Oui

UserArn

Amazon Resource Name (ARN) pour l'utilisateur enregistré.

Type : Chaîne

Obligatoire : Oui

AllowedDomains

Les domaines que vous souhaitez ajouter à la liste d'autorisation pour accéder à l'URL générée qui est ensuite intégrée. Ce paramètre facultatif remplace les domaines statiques configurés dans la fenêtre Gérer QuickSight menu sur Amazon QuickSight console Au lieu de cela, elle autorise uniquement les domaines que vous incluez dans ce paramètre. Vous pouvez répertorier jusqu'à trois domaines ou sous-domaines dans chaque appel d'API.

Pour inclure tous les sous-domaines d'un domaine spécifique à la liste d'autorisation, utilisez*. Par exemple,https://*.sapp.amazon.com.rproxy.goskope.cominclut tous les sous-domaines soushttps://sapp.amazon.com.

Type : Tableau de chaînes

Obligatoire : Non

SessionLifetimeInMinutes

Combien de minutes la session est valide. La durée de vie de la session doit être comprise entre [15 à 600] minutes.

Type : Long

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

Obligatoire : Non

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

L'URL d'intégration pour Amazon QuickSight tableau de bord ou console.

Type : Chaîne

RequestId

LeAWSID de la 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

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

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 champ--identity-type ANONYMOUSoption.

Code d'état HTTP : 403

UnsupportedUserEditionException

Cette erreur indique que vous appelez une opération portant sur Amazon QuickSightabonnement dont l'édition n'inclut pas la prise en charge de cette opération. Amazon Amazon QuickSight est actuellement disponible en 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 :