Interface GenerateEmbedUrlForRegisteredUserRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>, QuickSightRequest.Builder, SdkBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GenerateEmbedUrlForRegisteredUserRequest
@Mutable @NotThreadSafe public static interface GenerateEmbedUrlForRegisteredUserRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>

  • Method Details

    • awsAccountId

      GenerateEmbedUrlForRegisteredUserRequest.Builder awsAccountId(String awsAccountId)

      The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

      Parameters:
      awsAccountId - The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionLifetimeInMinutes

      GenerateEmbedUrlForRegisteredUserRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

      How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

      Parameters:
      sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userArn

      GenerateEmbedUrlForRegisteredUserRequest.Builder userArn(String userArn)

      The Amazon Resource Name for the registered user.

      Parameters:
      userArn - The Amazon Resource Name for the registered user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • experienceConfiguration

      GenerateEmbedUrlForRegisteredUserRequest.Builder experienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration)

      The experience that you want to embed. For registered users, you can embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.

      Parameters:
      experienceConfiguration - The experience that you want to embed. For registered users, you can embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • experienceConfiguration

      default GenerateEmbedUrlForRegisteredUserRequest.Builder experienceConfiguration(Consumer<RegisteredUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)

      The experience that you want to embed. For registered users, you can embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.

      This is a convenience method that creates an instance of the RegisteredUserEmbeddingExperienceConfiguration.Builder avoiding the need to create one manually via RegisteredUserEmbeddingExperienceConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to experienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration).

      Parameters:
      experienceConfiguration - a consumer that will call methods on RegisteredUserEmbeddingExperienceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allowedDomains

      GenerateEmbedUrlForRegisteredUserRequest.Builder allowedDomains(Collection<String> allowedDomains)

      The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

      Parameters:
      allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

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

    • allowedDomains

      GenerateEmbedUrlForRegisteredUserRequest.Builder allowedDomains(String... allowedDomains)

      The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

      Parameters:
      allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

      To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

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

    • overrideConfiguration

      GenerateEmbedUrlForRegisteredUserRequest.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

      GenerateEmbedUrlForRegisteredUserRequest.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.