software.amazon.awssdk.services.quicksight.model

Interface GetSessionEmbedUrlRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>, QuickSightRequest.Builder, SdkBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetSessionEmbedUrlRequest

public static interface GetSessionEmbedUrlRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>

Method Summary

Modifier and Type	Method and Description
GetSessionEmbedUrlRequest.Builder	awsAccountId(String awsAccountId) The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
GetSessionEmbedUrlRequest.Builder	entryPoint(String entryPoint) The URL you use to access the embedded session.
GetSessionEmbedUrlRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetSessionEmbedUrlRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetSessionEmbedUrlRequest.Builder	sessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GetSessionEmbedUrlRequest.Builder	userArn(String userArn) The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

awsAccountId

GetSessionEmbedUrlRequest.Builder awsAccountId(String awsAccountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

entryPoint

GetSessionEmbedUrlRequest.Builder entryPoint(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionLifetimeInMinutes

GetSessionEmbedUrlRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

userArn

GetSessionEmbedUrlRequest.Builder userArn(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetSessionEmbedUrlRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetSessionEmbedUrlRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder