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("software.amazon.awssdk:codegen") public final class GetSessionEmbedUrlRequest extends QuickSightRequest implements ToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<GetSessionEmbedUrlRequest.Builder,GetSessionEmbedUrlRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.