GetSessionEmbedUrlRequest

import type { GetSessionEmbedUrlRequest } from "https://aws-api.deno.dev/v0.3/services/quicksight.ts?docs=full";

interface GetSessionEmbedUrlRequest {

AwsAccountId: string;

EntryPoint?: string | null;

SessionLifetimeInMinutes?: number | null;

UserArn?: string | null;

}

§Properties

AwsAccountId: string

[src]

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

EntryPoint?: string | null

[src]

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

SessionLifetimeInMinutes?: number | null

[src]

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

UserArn?: string | null

[src]

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:

Active Directory (AD) users or group members
Invited nonfederated users
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.