software.amazon.awssdk.services.quicksight.model

Class GetSessionEmbedUrlRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.GetSessionEmbedUrlRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSessionEmbedUrlRequest
extends QuickSightRequest
implements ToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSessionEmbedUrlRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
static GetSessionEmbedUrlRequest.Builder	builder()
String	entryPoint() The URL you use to access the embedded session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GetSessionEmbedUrlRequest.Builder>	serializableBuilderClass()
Long	sessionLifetimeInMinutes() How many minutes the session is valid.
GetSessionEmbedUrlRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userArn() The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

awsAccountId

public final String awsAccountId()

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

Returns:

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

entryPoint

public final 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

Returns:

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

public final Long sessionLifetimeInMinutes()

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

Returns:

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

userArn

public final 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.

Returns:

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.

toBuilder

public GetSessionEmbedUrlRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static GetSessionEmbedUrlRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetSessionEmbedUrlRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo