com.amazonaws.services.quicksight.model

Class GetDashboardEmbedUrlRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.GetDashboardEmbedUrlRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetDashboardEmbedUrlRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Parameter input for the GetDashboardEmbedUrl operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetDashboardEmbedUrlRequest()

Method Summary

Modifier and Type	Method and Description
GetDashboardEmbedUrlRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAdditionalDashboardIds() A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations.
String	getAwsAccountId() The ID for the AWS account that contains the dashboard that you're embedding.
String	getDashboardId() The ID for the dashboard, also added to the IAM policy.
String	getIdentityType() The authentication method that the user uses to sign in.
String	getNamespace() The QuickSight namespace that contains the dashboard IDs in this request.
Boolean	getResetDisabled() Remove the reset button on the embedded dashboard.
Long	getSessionLifetimeInMinutes() How many minutes the session is valid.
Boolean	getStatePersistenceEnabled() Adds persistence of state for the user session in an embedded dashboard.
Boolean	getUndoRedoDisabled() Remove the undo/redo button on the embedded dashboard.
String	getUserArn() The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
int	hashCode()
Boolean	isResetDisabled() Remove the reset button on the embedded dashboard.
Boolean	isStatePersistenceEnabled() Adds persistence of state for the user session in an embedded dashboard.
Boolean	isUndoRedoDisabled() Remove the undo/redo button on the embedded dashboard.
void	setAdditionalDashboardIds(Collection<String> additionalDashboardIds) A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations.
void	setAwsAccountId(String awsAccountId) The ID for the AWS account that contains the dashboard that you're embedding.
void	setDashboardId(String dashboardId) The ID for the dashboard, also added to the IAM policy.
void	setIdentityType(String identityType) The authentication method that the user uses to sign in.
void	setNamespace(String namespace) The QuickSight namespace that contains the dashboard IDs in this request.
void	setResetDisabled(Boolean resetDisabled) Remove the reset button on the embedded dashboard.
void	setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
void	setStatePersistenceEnabled(Boolean statePersistenceEnabled) Adds persistence of state for the user session in an embedded dashboard.
void	setUndoRedoDisabled(Boolean undoRedoDisabled) Remove the undo/redo button on the embedded dashboard.
void	setUserArn(String userArn) The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
String	toString() Returns a string representation of this object.
GetDashboardEmbedUrlRequest	withAdditionalDashboardIds(Collection<String> additionalDashboardIds) A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations.
GetDashboardEmbedUrlRequest	withAdditionalDashboardIds(String... additionalDashboardIds) A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations.
GetDashboardEmbedUrlRequest	withAwsAccountId(String awsAccountId) The ID for the AWS account that contains the dashboard that you're embedding.
GetDashboardEmbedUrlRequest	withDashboardId(String dashboardId) The ID for the dashboard, also added to the IAM policy.
GetDashboardEmbedUrlRequest	withIdentityType(EmbeddingIdentityType identityType) The authentication method that the user uses to sign in.
GetDashboardEmbedUrlRequest	withIdentityType(String identityType) The authentication method that the user uses to sign in.
GetDashboardEmbedUrlRequest	withNamespace(String namespace) The QuickSight namespace that contains the dashboard IDs in this request.
GetDashboardEmbedUrlRequest	withResetDisabled(Boolean resetDisabled) Remove the reset button on the embedded dashboard.
GetDashboardEmbedUrlRequest	withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GetDashboardEmbedUrlRequest	withStatePersistenceEnabled(Boolean statePersistenceEnabled) Adds persistence of state for the user session in an embedded dashboard.
GetDashboardEmbedUrlRequest	withUndoRedoDisabled(Boolean undoRedoDisabled) Remove the undo/redo button on the embedded dashboard.
GetDashboardEmbedUrlRequest	withUserArn(String userArn) The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDashboardEmbedUrlRequest

public GetDashboardEmbedUrlRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The ID for the AWS account that contains the dashboard that you're embedding.

Parameters:

awsAccountId - The ID for the AWS account that contains the dashboard that you're embedding.

getAwsAccountId

public String getAwsAccountId()

The ID for the AWS account that contains the dashboard that you're embedding.

Returns:

The ID for the AWS account that contains the dashboard that you're embedding.

withAwsAccountId

public GetDashboardEmbedUrlRequest withAwsAccountId(String awsAccountId)

The ID for the AWS account that contains the dashboard that you're embedding.

Parameters:

awsAccountId - The ID for the AWS account that contains the dashboard that you're embedding.

Returns:

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

setDashboardId

public void setDashboardId(String dashboardId)

The ID for the dashboard, also added to the IAM policy.

Parameters:

dashboardId - The ID for the dashboard, also added to the IAM policy.

getDashboardId

public String getDashboardId()

The ID for the dashboard, also added to the IAM policy.

Returns:

The ID for the dashboard, also added to the IAM policy.

withDashboardId

public GetDashboardEmbedUrlRequest withDashboardId(String dashboardId)

The ID for the dashboard, also added to the IAM policy.

Parameters:

dashboardId - The ID for the dashboard, also added to the IAM policy.

Returns:

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

setIdentityType

public void setIdentityType(String identityType)

The authentication method that the user uses to sign in.

Parameters:

identityType - The authentication method that the user uses to sign in.

See Also:

EmbeddingIdentityType

getIdentityType

public String getIdentityType()

The authentication method that the user uses to sign in.

Returns:

The authentication method that the user uses to sign in.

See Also:

EmbeddingIdentityType

withIdentityType

public GetDashboardEmbedUrlRequest withIdentityType(String identityType)

The authentication method that the user uses to sign in.

Parameters:

identityType - The authentication method that the user uses to sign in.

Returns:

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

See Also:

EmbeddingIdentityType

withIdentityType

public GetDashboardEmbedUrlRequest withIdentityType(EmbeddingIdentityType identityType)

The authentication method that the user uses to sign in.

Parameters:

identityType - The authentication method that the user uses to sign in.

Returns:

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

See Also:

EmbeddingIdentityType

setSessionLifetimeInMinutes

public void setSessionLifetimeInMinutes(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.

getSessionLifetimeInMinutes

public Long getSessionLifetimeInMinutes()

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.

withSessionLifetimeInMinutes

public GetDashboardEmbedUrlRequest withSessionLifetimeInMinutes(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.

setUndoRedoDisabled

public void setUndoRedoDisabled(Boolean undoRedoDisabled)

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Parameters:

undoRedoDisabled - Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

getUndoRedoDisabled

public Boolean getUndoRedoDisabled()

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Returns:

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

withUndoRedoDisabled

public GetDashboardEmbedUrlRequest withUndoRedoDisabled(Boolean undoRedoDisabled)

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Parameters:

undoRedoDisabled - Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Returns:

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

isUndoRedoDisabled

public Boolean isUndoRedoDisabled()

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Returns:

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

setResetDisabled

public void setResetDisabled(Boolean resetDisabled)

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Parameters:

resetDisabled - Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

getResetDisabled

public Boolean getResetDisabled()

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Returns:

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

withResetDisabled

public GetDashboardEmbedUrlRequest withResetDisabled(Boolean resetDisabled)

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Parameters:

resetDisabled - Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Returns:

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

isResetDisabled

public Boolean isResetDisabled()

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Returns:

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

setStatePersistenceEnabled

public void setStatePersistenceEnabled(Boolean statePersistenceEnabled)

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Parameters:

statePersistenceEnabled - Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

getStatePersistenceEnabled

public Boolean getStatePersistenceEnabled()

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Returns:

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

withStatePersistenceEnabled

public GetDashboardEmbedUrlRequest withStatePersistenceEnabled(Boolean statePersistenceEnabled)

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Parameters:

statePersistenceEnabled - Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Returns:

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

isStatePersistenceEnabled

public Boolean isStatePersistenceEnabled()

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Returns:

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

setUserArn

public void setUserArn(String userArn)

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• 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 Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

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

getUserArn

public String getUserArn()

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• 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 Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

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

withUserArn

public GetDashboardEmbedUrlRequest withUserArn(String userArn)

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• 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 Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

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

setNamespace

public void setNamespace(String namespace)

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

Parameters:

namespace - The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

getNamespace

public String getNamespace()

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

Returns:

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

withNamespace

public GetDashboardEmbedUrlRequest withNamespace(String namespace)

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

Parameters:

namespace - The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "default".

Returns:

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

getAdditionalDashboardIds

public List<String> getAdditionalDashboardIds()

A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

setAdditionalDashboardIds

public void setAdditionalDashboardIds(Collection<String> additionalDashboardIds)

A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Parameters:

additionalDashboardIds - A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

withAdditionalDashboardIds

public GetDashboardEmbedUrlRequest withAdditionalDashboardIds(String... additionalDashboardIds)

A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalDashboardIds(java.util.Collection) or withAdditionalDashboardIds(java.util.Collection) if you want to override the existing values.

Parameters:

additionalDashboardIds - A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

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

withAdditionalDashboardIds

public GetDashboardEmbedUrlRequest withAdditionalDashboardIds(Collection<String> additionalDashboardIds)

A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Parameters:

additionalDashboardIds - A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetDashboardEmbedUrlRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()