public static interface GenerateEmbedUrlForAnonymousUserRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GenerateEmbedUrlForAnonymousUserRequest.Builder,GenerateEmbedUrlForAnonymousUserRequest>
| Modifier and Type | Method and Description |
|---|---|
GenerateEmbedUrlForAnonymousUserRequest.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.
|
GenerateEmbedUrlForAnonymousUserRequest.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.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
authorizedResourceArns(Collection<String> authorizedResourceArns)
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access
during the lifetime of the session.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
authorizedResourceArns(String... authorizedResourceArns)
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access
during the lifetime of the session.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
awsAccountId(String awsAccountId)
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)
The configuration of the experience that you are embedding.
|
default GenerateEmbedUrlForAnonymousUserRequest.Builder |
experienceConfiguration(Consumer<AnonymousUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)
The configuration of the experience that you are embedding.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
namespace(String namespace)
The Amazon QuickSight namespace that the anonymous user virtually belongs to.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GenerateEmbedUrlForAnonymousUserRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
GenerateEmbedUrlForAnonymousUserRequest.Builder |
sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
sessionTags(Collection<SessionTag> sessionTags)
The session tags used for row-level security.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
sessionTags(Consumer<SessionTag.Builder>... sessionTags)
The session tags used for row-level security.
|
GenerateEmbedUrlForAnonymousUserRequest.Builder |
sessionTags(SessionTag... sessionTags)
The session tags used for row-level security.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGenerateEmbedUrlForAnonymousUserRequest.Builder awsAccountId(String awsAccountId)
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
awsAccountId - The ID for the Amazon Web Services account that contains the dashboard that you're embedding.GenerateEmbedUrlForAnonymousUserRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.GenerateEmbedUrlForAnonymousUserRequest.Builder namespace(String namespace)
The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon
QuickSight custom namespace, set this to default.
namespace - The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an
Amazon QuickSight custom namespace, set this to default.GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(Collection<SessionTag> sessionTags)
The session tags used for row-level security. Before you use this parameter, make sure that you have
configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter
so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
sessionTags - The session tags used for row-level security. Before you use this parameter, make sure that you have
configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration
parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(SessionTag... sessionTags)
The session tags used for row-level security. Before you use this parameter, make sure that you have
configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter
so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
sessionTags - The session tags used for row-level security. Before you use this parameter, make sure that you have
configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration
parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
GenerateEmbedUrlForAnonymousUserRequest.Builder sessionTags(Consumer<SessionTag.Builder>... sessionTags)
The session tags used for row-level security. Before you use this parameter, make sure that you have
configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter
so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
This is a convenience method that creates an instance of theSessionTag.Builder avoiding the need to create one
manually via SessionTag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #sessionTags(List.
sessionTags - a consumer that will call methods on
SessionTag.Builder#sessionTags(java.util.Collection) GenerateEmbedUrlForAnonymousUserRequest.Builder authorizedResourceArns(Collection<String> authorizedResourceArns)
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access
during the lifetime of the session. If you choose Dashboard embedding experience, pass the list
of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25
dashboard ARNs in each API call.
authorizedResourceArns - The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to
access during the lifetime of the session. If you choose Dashboard embedding experience,
pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently,
you can pass up to 25 dashboard ARNs in each API call.GenerateEmbedUrlForAnonymousUserRequest.Builder authorizedResourceArns(String... authorizedResourceArns)
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access
during the lifetime of the session. If you choose Dashboard embedding experience, pass the list
of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25
dashboard ARNs in each API call.
authorizedResourceArns - The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to
access during the lifetime of the session. If you choose Dashboard embedding experience,
pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently,
you can pass up to 25 dashboard ARNs in each API call.GenerateEmbedUrlForAnonymousUserRequest.Builder experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)
The configuration of the experience that you are embedding.
experienceConfiguration - The configuration of the experience that you are embedding.default GenerateEmbedUrlForAnonymousUserRequest.Builder experienceConfiguration(Consumer<AnonymousUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)
The configuration of the experience that you are embedding.
This is a convenience method that creates an instance of theAnonymousUserEmbeddingExperienceConfiguration.Builder avoiding the need to create one manually via
AnonymousUserEmbeddingExperienceConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to
experienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration).
experienceConfiguration - a consumer that will call methods on AnonymousUserEmbeddingExperienceConfiguration.BuilderexperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration)GenerateEmbedUrlForAnonymousUserRequest.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 QuickSight menu in the Amazon QuickSight 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.
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
QuickSight menu in the Amazon QuickSight 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.
GenerateEmbedUrlForAnonymousUserRequest.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 QuickSight menu in the Amazon QuickSight 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.
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
QuickSight menu in the Amazon QuickSight 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.
GenerateEmbedUrlForAnonymousUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGenerateEmbedUrlForAnonymousUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.