Learn R Programming

paws.analytics (version 0.1.9)

quicksight_get_dashboard_embed_url: Generates a URL and authorization code that you can embed in your web server code

Description

Generates a URL and authorization code that you can embed in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Usage

quicksight_get_dashboard_embed_url(AwsAccountId, DashboardId,
  IdentityType, SessionLifetimeInMinutes, UndoRedoDisabled, ResetDisabled,
  UserArn)

Arguments

AwsAccountId

[required] The ID for the AWS account that contains the dashboard that you\'re embedding.

DashboardId

[required] The ID for the dashboard, also added to the IAM policy.

IdentityType

[required] The authentication method that the user uses to sign in.

SessionLifetimeInMinutes

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

UndoRedoDisabled

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

ResetDisabled

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

UserArn

The Amazon QuickSight user\'s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Request syntax

svc$get_dashboard_embed_url(
  AwsAccountId = "string",
  DashboardId = "string",
  IdentityType = "IAM"|"QUICKSIGHT",
  SessionLifetimeInMinutes = 123,
  UndoRedoDisabled = TRUE|FALSE,
  ResetDisabled = TRUE|FALSE,
  UserArn = "string"
)

Details

Currently, you can use GetDashboardEmbedURL only from the server, not from the user\'s browser. The following rules apply to the combination of URL and authorization code:

  • They must be used together.

  • They can be used one time only.

  • They are valid for 5 minutes after you run this command.

  • The resulting user session is valid for 10 hours.

For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.