GetSessionEmbedUrl - Amazon QuickSight
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

GetSessionEmbedUrl

Generiert eine Sitzungs-URL und einen Autorisierungscode, die Sie zum Einbetten von Amazon Amazon verwenden können QuickSight -Konsole in Ihrem Webservercode. Verwenden vonGetSessionEmbedUrl, bei dem Sie ein Autoren-Portal bereitstellen möchten, mit dem Benutzer Datenquellen, Datasets, Analysen, Analysen und Dashboards erstellen können. Die Benutzer, die auf ein eingebettetes Amazon zugreifen QuickSight Konsole muss zur Autor- oder Admin-Sicherheitskohorte gehören. Wenn Sie die Berechtigungen auf einige dieser Funktionen einschränken möchten, fügen Sie dem Benutzer ein benutzerdefiniertes Berechtigungsprofil mit dem Befehl UpdateUser APIP-Operation. Verwenden von RegisterUser API-Vorgang zum Hinzufügen eines neuen Benutzers mit angehängtem benutzerdefinierten Berechtigungsprofil. Weitere Informationen finden Sie in der folgenden Abschnitten imAmazon QuickSight Benutzerhandbuch:

Anforderungssyntax

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

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

AwsAccountId

Die ID derAWS-Kontomit Ihrem Amazon verbunden QuickSight Abonnement.

Längenbeschränkungen: Feste Länge von 12.

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

Erforderlich: Ja

EntryPoint

Die URL, die Sie für den Zugriff auf die eingebettete Sitzung verwenden. Die URL des Einstiegspunkts ist auf die folgenden Pfade beschränkt:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - Wobei giltDashboardIdder tatsächliche ID-Schlüssel von Amazon ist Amazon QuickSight Konsolen-URL des Dashboards

  • /analyses/AnalysisId - Wobei giltAnalysisIdder tatsächliche ID-Schlüssel von Amazon ist Amazon QuickSight -Konsolen-URL der Analyse

Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 1000 Zeichen.

SessionLifetimeInMinutes

Wie viele Minuten ist die Sitzung gültig. Die Lebensdauer der Sitzung muss 15-600 Minuten betragen.

Gültiger Bereich: Der Mindestwert ist 15. Maximalwert 600.

UserArn

Der Amazon QuickSight Amazon-Ressourcenname (ARN) des Benutzers, zur Verwendung mitQUICKSIGHTIdentitätstyp. Sie können dies für jede Art von Amazon verwenden QuickSight Benutzer in Ihrem Konto (Leser, Autoren oder Administratoren). Sie müssen als eines der folgenden Dinge authentifiziert werden:

  1. Active Directory (AD) -Benutzer oder -Gruppenmitglieder

  2. Eingeladene Benutzer ohne Verbund

  3. AWS Identity and Access Management(IAM-Benutzer) und IAM-Rollen-basierte Sitzungen, authentifiziert durch verbundenes Single Sign-On mit SAML, OpenID Connect oder IAM-Verbund

Lassen Sie diesen Parameter für Benutzer in der dritten Gruppe, IAM-Benutzer und rollenbasierte IAM-Sitzungen weg.

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

HTTP/1.1 Status
Content-type: application/json

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

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst die folgende HTTP-Antwort zurück.

Status

Der HTTP-Status der Anforderung.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

EmbedUrl

Eine URL zur einmaligen Verwendung, die Sie in Ihre serverseitige Webseite eingeben können, um Ihr Amazon einzubetten QuickSight session. Diese URL ist 5 Minuten gültig. Die API-Operation stellt die URL mit einemauth_codeWert, der eine (und nur eine) Anmeldung bei einer Benutzersitzung ermöglicht, die 10 Stunden lang gültig ist.

Type: String

RequestId

DieAWSAnforderungs-ID für diese Operation.

Type: String

Fehler

Hinweise zu den Fehlern, die bei allen Aktionen auftreten, finden Sie unterHäufige Fehler.

AccessDeniedException

Sie haben keinen Zugriff auf dieses Element. Die bereitgestellten Anmeldeinformationen konnten nicht überprüft werden. Sie sind möglicherweise nicht berechtigt, die Anforderung auszuführen. Stellen Sie sicher, dass Ihr Konto für die Nutzung von Amazon autorisiert ist QuickSight -Service, dass Ihre Richtlinien die richtigen Berechtigungen besitzen und dass Sie die richtigen Zugriffsschlüssel verwenden.

HTTP P-Statuscode: 401

InternalFailureException

Es ist ein interner Fehler aufgetreten.

HTTP P-Statuscode: 500

InvalidParameterValueException

Ein oder mehrere Parameter haben einen Wert, der nicht gültig ist.

HTTP P-Statuscode: 400

QuickSightUserNotFoundException

Der Benutzer mit dem angegebenen Namen wurde nicht gefunden. Dieser Fehler kann bei jedem Vorgang vorkommen, bei dem ein Benutzer anhand eines angegebenen Benutzernamens gesucht werden muss, wie z. B. B.DeleteUser,DescribeUserusw.

HTTP P-Statuscode: 404

ResourceExistsException

Die angegebene Ressource ist bereits vorhanden.

HTTP P-Statuscode: 409

ResourceNotFoundException

Mindestens eine Ressource kann nicht gefunden werden.

HTTP P-Statuscode: 404

SessionLifetimeInMinutesInvalidException

Die Anzahl der Minuten für die Lebensdauer einer Sitzung ist ungültig. Die Lebensdauer der Sitzung muss 15-600 Minuten betragen.

HTTP P-Statuscode: 400

ThrottlingException

Der Zugriff wird gedrosselt

HTTP P-Statuscode: 429

UnsupportedUserEditionException

Dieser Fehler zeigt an, dass Sie eine Operation bei Amazon durchführen. QuickSightAbonnement, bei dem die Edition keine Unterstützung für diesen Vorgang enthält. Amazon Amazon QuickSight verfügt derzeit über eine Standard Edition und eine Enterprise Edition. Nicht jede Operation und Funktion ist in jeder Version verfügbar ist.

HTTP P-Statuscode: 403

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: