Class GetSessionEmbedUrlRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,
GetSessionEmbedUrlRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.builder()
final String
The URL you use to access the embedded session.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
static Class
<? extends GetSessionEmbedUrlRequest.Builder> final Long
How many minutes the session is valid.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userArn()
The Amazon QuickSight user's Amazon Resource Name (ARN), for use withQUICKSIGHT
identity type.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
- whereDashboardId
is the actual ID key from the Amazon QuickSight console URL of the dashboard -
/analyses/AnalysisId
- whereAnalysisId
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
- whereDashboardId
is the actual ID key from the Amazon QuickSight console URL of the dashboard -
/analyses/AnalysisId
- whereAnalysisId
is the actual ID key from the Amazon QuickSight console URL of the analysis
-
-
-
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
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
-
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:-
Active Directory (AD) users or group members
-
Invited nonfederated users
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,
GetSessionEmbedUrlRequest> - Specified by:
toBuilder
in classQuickSightRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-