@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GenerateEmbedUrlForAnonymousUserRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
GenerateEmbedUrlForAnonymousUserRequest() |
Modifier and Type | Method and Description |
---|---|
GenerateEmbedUrlForAnonymousUserRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAllowedDomains()
The domains that you want to add to the allow list for access to the generated URL that is then embedded.
|
List<String> |
getAuthorizedResourceArns()
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during
the lifetime of the session.
|
String |
getAwsAccountId()
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
|
AnonymousUserEmbeddingExperienceConfiguration |
getExperienceConfiguration()
The configuration of the experience that you are embedding.
|
String |
getNamespace()
The Amazon QuickSight namespace that the anonymous user virtually belongs to.
|
Long |
getSessionLifetimeInMinutes()
How many minutes the session is valid.
|
List<SessionTag> |
getSessionTags()
The session tags used for row-level security.
|
int |
hashCode() |
void |
setAllowedDomains(Collection<String> allowedDomains)
The domains that you want to add to the allow list for access to the generated URL that is then embedded.
|
void |
setAuthorizedResourceArns(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.
|
void |
setAwsAccountId(String awsAccountId)
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
|
void |
setExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)
The configuration of the experience that you are embedding.
|
void |
setNamespace(String namespace)
The Amazon QuickSight namespace that the anonymous user virtually belongs to.
|
void |
setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid.
|
void |
setSessionTags(Collection<SessionTag> sessionTags)
The session tags used for row-level security.
|
String |
toString()
Returns a string representation of this object.
|
GenerateEmbedUrlForAnonymousUserRequest |
withAllowedDomains(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 |
withAllowedDomains(String... allowedDomains)
The domains that you want to add to the allow list for access to the generated URL that is then embedded.
|
GenerateEmbedUrlForAnonymousUserRequest |
withAuthorizedResourceArns(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 |
withAuthorizedResourceArns(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 |
withAwsAccountId(String awsAccountId)
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
|
GenerateEmbedUrlForAnonymousUserRequest |
withExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)
The configuration of the experience that you are embedding.
|
GenerateEmbedUrlForAnonymousUserRequest |
withNamespace(String namespace)
The Amazon QuickSight namespace that the anonymous user virtually belongs to.
|
GenerateEmbedUrlForAnonymousUserRequest |
withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid.
|
GenerateEmbedUrlForAnonymousUserRequest |
withSessionTags(Collection<SessionTag> sessionTags)
The session tags used for row-level security.
|
GenerateEmbedUrlForAnonymousUserRequest |
withSessionTags(SessionTag... sessionTags)
The session tags used for row-level security.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public GenerateEmbedUrlForAnonymousUserRequest()
public void setAwsAccountId(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.public String getAwsAccountId()
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
public GenerateEmbedUrlForAnonymousUserRequest withAwsAccountId(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.public void setSessionLifetimeInMinutes(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.public Long getSessionLifetimeInMinutes()
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
public GenerateEmbedUrlForAnonymousUserRequest withSessionLifetimeInMinutes(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.public void setNamespace(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
.public String getNamespace()
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
.
default
.public GenerateEmbedUrlForAnonymousUserRequest withNamespace(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
.public List<SessionTag> getSessionTags()
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.
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.
public void setSessionTags(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.
public GenerateEmbedUrlForAnonymousUserRequest withSessionTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setSessionTags(java.util.Collection)
or withSessionTags(java.util.Collection)
if you want to
override the existing values.
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.
public GenerateEmbedUrlForAnonymousUserRequest withSessionTags(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.
public List<String> getAuthorizedResourceArns()
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.
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.public void setAuthorizedResourceArns(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.public GenerateEmbedUrlForAnonymousUserRequest withAuthorizedResourceArns(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.
NOTE: This method appends the values to the existing list (if any). Use
setAuthorizedResourceArns(java.util.Collection)
or
withAuthorizedResourceArns(java.util.Collection)
if you want to override the existing values.
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.public GenerateEmbedUrlForAnonymousUserRequest withAuthorizedResourceArns(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.public void setExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)
The configuration of the experience that you are embedding.
experienceConfiguration
- The configuration of the experience that you are embedding.public AnonymousUserEmbeddingExperienceConfiguration getExperienceConfiguration()
The configuration of the experience that you are embedding.
public GenerateEmbedUrlForAnonymousUserRequest withExperienceConfiguration(AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration)
The configuration of the experience that you are embedding.
experienceConfiguration
- The configuration of the experience that you are embedding.public List<String> getAllowedDomains()
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
.
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
.
public void setAllowedDomains(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
.
public GenerateEmbedUrlForAnonymousUserRequest withAllowedDomains(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
.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedDomains(java.util.Collection)
or withAllowedDomains(java.util.Collection)
if you want
to override the existing values.
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
.
public GenerateEmbedUrlForAnonymousUserRequest withAllowedDomains(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
.
public String toString()
toString
in class Object
Object.toString()
public GenerateEmbedUrlForAnonymousUserRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()