AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetSessionEmbedUrl operation. Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl 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 Amazon 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 UpdateUser API operation. Use RegisterUser 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:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.QuickSight.AmazonQuickSightRequest
      Amazon.QuickSight.Model.GetSessionEmbedUrlRequest

Namespace: Amazon.QuickSight.Model
Assembly: AWSSDK.QuickSight.dll
Version: 3.x.y.z

Syntax

C# 
public class GetSessionEmbedUrlRequest : AmazonQuickSightRequest
         IAmazonWebServiceRequest

The GetSessionEmbedUrlRequest type exposes the following members

Constructors

NameDescription
Public Method GetSessionEmbedUrlRequest()

Properties

NameTypeDescription
Public Property AwsAccountId System.String

Gets and sets the property AwsAccountId.

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Public Property EntryPoint System.String

Gets and sets the property 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 Amazon QuickSight console URL of the dashboard

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

Public Property SessionLifetimeInMinutes System.Int64

Gets and sets the property SessionLifetimeInMinutes.

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

Public Property UserArn System.String

Gets and sets the property 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. 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5