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 Details

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetSessionEmbedUrlRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.