Learn R Programming
paws.analytics (version 0.1.11)

quicksight_get_session_embed_url: Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code

Description

Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use get_session_embed_url where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the update_user API operation. Use register_user API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

Usage

quicksight_get_session_embed_url(AwsAccountId, EntryPoint,
  SessionLifetimeInMinutes, UserArn)

Arguments

AwsAccountId

[required] The ID for the AWS account associated with your QuickSight subscription.

EntryPoint

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard

  • /analyses/AnalysisId - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis

SessionLifetimeInMinutes

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

UserArn

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

  1. Active Directory (AD) users or group members

  2. Invited nonfederated users

  3. AWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

Value

A list with the following syntax:

list(
  EmbedUrl = "string",
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$get_session_embed_url(
  AwsAccountId = "string",
  EntryPoint = "string",
  SessionLifetimeInMinutes = 123,
  UserArn = "string"
)