AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::QuickSight::Model::UpdateDashboardRequest Class Reference

#include <UpdateDashboardRequest.h>

+ Inheritance diagram for Aws::QuickSight::Model::UpdateDashboardRequest:

Public Member Functions

 UpdateDashboardRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAwsAccountId () const
 
bool AwsAccountIdHasBeenSet () const
 
void SetAwsAccountId (const Aws::String &value)
 
void SetAwsAccountId (Aws::String &&value)
 
void SetAwsAccountId (const char *value)
 
UpdateDashboardRequestWithAwsAccountId (const Aws::String &value)
 
UpdateDashboardRequestWithAwsAccountId (Aws::String &&value)
 
UpdateDashboardRequestWithAwsAccountId (const char *value)
 
const Aws::StringGetDashboardId () const
 
bool DashboardIdHasBeenSet () const
 
void SetDashboardId (const Aws::String &value)
 
void SetDashboardId (Aws::String &&value)
 
void SetDashboardId (const char *value)
 
UpdateDashboardRequestWithDashboardId (const Aws::String &value)
 
UpdateDashboardRequestWithDashboardId (Aws::String &&value)
 
UpdateDashboardRequestWithDashboardId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateDashboardRequestWithName (const Aws::String &value)
 
UpdateDashboardRequestWithName (Aws::String &&value)
 
UpdateDashboardRequestWithName (const char *value)
 
const DashboardSourceEntityGetSourceEntity () const
 
bool SourceEntityHasBeenSet () const
 
void SetSourceEntity (const DashboardSourceEntity &value)
 
void SetSourceEntity (DashboardSourceEntity &&value)
 
UpdateDashboardRequestWithSourceEntity (const DashboardSourceEntity &value)
 
UpdateDashboardRequestWithSourceEntity (DashboardSourceEntity &&value)
 
const ParametersGetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Parameters &value)
 
void SetParameters (Parameters &&value)
 
UpdateDashboardRequestWithParameters (const Parameters &value)
 
UpdateDashboardRequestWithParameters (Parameters &&value)
 
const Aws::StringGetVersionDescription () const
 
bool VersionDescriptionHasBeenSet () const
 
void SetVersionDescription (const Aws::String &value)
 
void SetVersionDescription (Aws::String &&value)
 
void SetVersionDescription (const char *value)
 
UpdateDashboardRequestWithVersionDescription (const Aws::String &value)
 
UpdateDashboardRequestWithVersionDescription (Aws::String &&value)
 
UpdateDashboardRequestWithVersionDescription (const char *value)
 
const DashboardPublishOptionsGetDashboardPublishOptions () const
 
bool DashboardPublishOptionsHasBeenSet () const
 
void SetDashboardPublishOptions (const DashboardPublishOptions &value)
 
void SetDashboardPublishOptions (DashboardPublishOptions &&value)
 
UpdateDashboardRequestWithDashboardPublishOptions (const DashboardPublishOptions &value)
 
UpdateDashboardRequestWithDashboardPublishOptions (DashboardPublishOptions &&value)
 
const Aws::StringGetThemeArn () const
 
bool ThemeArnHasBeenSet () const
 
void SetThemeArn (const Aws::String &value)
 
void SetThemeArn (Aws::String &&value)
 
void SetThemeArn (const char *value)
 
UpdateDashboardRequestWithThemeArn (const Aws::String &value)
 
UpdateDashboardRequestWithThemeArn (Aws::String &&value)
 
UpdateDashboardRequestWithThemeArn (const char *value)
 
- Public Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual ~QuickSightRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file UpdateDashboardRequest.h.

Constructor & Destructor Documentation

◆ UpdateDashboardRequest()

Aws::QuickSight::Model::UpdateDashboardRequest::UpdateDashboardRequest ( )

Member Function Documentation

◆ AwsAccountIdHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::AwsAccountIdHasBeenSet ( ) const
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 48 of file UpdateDashboardRequest.h.

◆ DashboardIdHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::DashboardIdHasBeenSet ( ) const
inline

The ID for the dashboard.

Definition at line 95 of file UpdateDashboardRequest.h.

◆ DashboardPublishOptionsHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::DashboardPublishOptionsHasBeenSet ( ) const
inline

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption

    • This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Definition at line 384 of file UpdateDashboardRequest.h.

◆ GetAwsAccountId()

const Aws::String& Aws::QuickSight::Model::UpdateDashboardRequest::GetAwsAccountId ( ) const
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 42 of file UpdateDashboardRequest.h.

◆ GetDashboardId()

const Aws::String& Aws::QuickSight::Model::UpdateDashboardRequest::GetDashboardId ( ) const
inline

The ID for the dashboard.

Definition at line 90 of file UpdateDashboardRequest.h.

◆ GetDashboardPublishOptions()

const DashboardPublishOptions& Aws::QuickSight::Model::UpdateDashboardRequest::GetDashboardPublishOptions ( ) const
inline

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption

    • This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Definition at line 366 of file UpdateDashboardRequest.h.

◆ GetName()

const Aws::String& Aws::QuickSight::Model::UpdateDashboardRequest::GetName ( ) const
inline

The display name of the dashboard.

Definition at line 131 of file UpdateDashboardRequest.h.

◆ GetParameters()

const Parameters& Aws::QuickSight::Model::UpdateDashboardRequest::GetParameters ( ) const
inline

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 271 of file UpdateDashboardRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::QuickSight::Model::UpdateDashboardRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file UpdateDashboardRequest.h.

◆ GetSourceEntity()

const DashboardSourceEntity& Aws::QuickSight::Model::UpdateDashboardRequest::GetSourceEntity ( ) const
inline

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 183 of file UpdateDashboardRequest.h.

◆ GetThemeArn()

const Aws::String& Aws::QuickSight::Model::UpdateDashboardRequest::GetThemeArn ( ) const
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 465 of file UpdateDashboardRequest.h.

◆ GetVersionDescription()

const Aws::String& Aws::QuickSight::Model::UpdateDashboardRequest::GetVersionDescription ( ) const
inline

A description for the first version of the dashboard being created.

Definition at line 312 of file UpdateDashboardRequest.h.

◆ NameHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::NameHasBeenSet ( ) const
inline

The display name of the dashboard.

Definition at line 136 of file UpdateDashboardRequest.h.

◆ ParametersHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::ParametersHasBeenSet ( ) const
inline

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 278 of file UpdateDashboardRequest.h.

◆ SerializePayload()

Aws::String Aws::QuickSight::Model::UpdateDashboardRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAwsAccountId() [1/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetAwsAccountId ( const Aws::String value)
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 54 of file UpdateDashboardRequest.h.

◆ SetAwsAccountId() [2/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetAwsAccountId ( Aws::String &&  value)
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 60 of file UpdateDashboardRequest.h.

◆ SetAwsAccountId() [3/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetAwsAccountId ( const char *  value)
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 66 of file UpdateDashboardRequest.h.

◆ SetDashboardId() [1/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetDashboardId ( const Aws::String value)
inline

The ID for the dashboard.

Definition at line 100 of file UpdateDashboardRequest.h.

◆ SetDashboardId() [2/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetDashboardId ( Aws::String &&  value)
inline

The ID for the dashboard.

Definition at line 105 of file UpdateDashboardRequest.h.

◆ SetDashboardId() [3/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetDashboardId ( const char *  value)
inline

The ID for the dashboard.

Definition at line 110 of file UpdateDashboardRequest.h.

◆ SetDashboardPublishOptions() [1/2]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetDashboardPublishOptions ( const DashboardPublishOptions value)
inline

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption

    • This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Definition at line 402 of file UpdateDashboardRequest.h.

◆ SetDashboardPublishOptions() [2/2]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetDashboardPublishOptions ( DashboardPublishOptions &&  value)
inline

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption

    • This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Definition at line 420 of file UpdateDashboardRequest.h.

◆ SetName() [1/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetName ( const Aws::String value)
inline

The display name of the dashboard.

Definition at line 141 of file UpdateDashboardRequest.h.

◆ SetName() [2/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetName ( Aws::String &&  value)
inline

The display name of the dashboard.

Definition at line 146 of file UpdateDashboardRequest.h.

◆ SetName() [3/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetName ( const char *  value)
inline

The display name of the dashboard.

Definition at line 151 of file UpdateDashboardRequest.h.

◆ SetParameters() [1/2]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetParameters ( const Parameters value)
inline

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 285 of file UpdateDashboardRequest.h.

◆ SetParameters() [2/2]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetParameters ( Parameters &&  value)
inline

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 292 of file UpdateDashboardRequest.h.

◆ SetSourceEntity() [1/2]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetSourceEntity ( const DashboardSourceEntity value)
inline

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 215 of file UpdateDashboardRequest.h.

◆ SetSourceEntity() [2/2]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetSourceEntity ( DashboardSourceEntity &&  value)
inline

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 231 of file UpdateDashboardRequest.h.

◆ SetThemeArn() [1/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetThemeArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 481 of file UpdateDashboardRequest.h.

◆ SetThemeArn() [2/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetThemeArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 489 of file UpdateDashboardRequest.h.

◆ SetThemeArn() [3/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetThemeArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 497 of file UpdateDashboardRequest.h.

◆ SetVersionDescription() [1/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetVersionDescription ( const Aws::String value)
inline

A description for the first version of the dashboard being created.

Definition at line 322 of file UpdateDashboardRequest.h.

◆ SetVersionDescription() [2/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetVersionDescription ( Aws::String &&  value)
inline

A description for the first version of the dashboard being created.

Definition at line 327 of file UpdateDashboardRequest.h.

◆ SetVersionDescription() [3/3]

void Aws::QuickSight::Model::UpdateDashboardRequest::SetVersionDescription ( const char *  value)
inline

A description for the first version of the dashboard being created.

Definition at line 332 of file UpdateDashboardRequest.h.

◆ SourceEntityHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::SourceEntityHasBeenSet ( ) const
inline

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 199 of file UpdateDashboardRequest.h.

◆ ThemeArnHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::ThemeArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 473 of file UpdateDashboardRequest.h.

◆ VersionDescriptionHasBeenSet()

bool Aws::QuickSight::Model::UpdateDashboardRequest::VersionDescriptionHasBeenSet ( ) const
inline

A description for the first version of the dashboard being created.

Definition at line 317 of file UpdateDashboardRequest.h.

◆ WithAwsAccountId() [1/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithAwsAccountId ( const Aws::String value)
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 72 of file UpdateDashboardRequest.h.

◆ WithAwsAccountId() [2/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithAwsAccountId ( Aws::String &&  value)
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 78 of file UpdateDashboardRequest.h.

◆ WithAwsAccountId() [3/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithAwsAccountId ( const char *  value)
inline

The ID of the AWS account that contains the dashboard that you're updating.

Definition at line 84 of file UpdateDashboardRequest.h.

◆ WithDashboardId() [1/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithDashboardId ( const Aws::String value)
inline

The ID for the dashboard.

Definition at line 115 of file UpdateDashboardRequest.h.

◆ WithDashboardId() [2/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithDashboardId ( Aws::String &&  value)
inline

The ID for the dashboard.

Definition at line 120 of file UpdateDashboardRequest.h.

◆ WithDashboardId() [3/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithDashboardId ( const char *  value)
inline

The ID for the dashboard.

Definition at line 125 of file UpdateDashboardRequest.h.

◆ WithDashboardPublishOptions() [1/2]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithDashboardPublishOptions ( const DashboardPublishOptions value)
inline

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption

    • This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Definition at line 438 of file UpdateDashboardRequest.h.

◆ WithDashboardPublishOptions() [2/2]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithDashboardPublishOptions ( DashboardPublishOptions &&  value)
inline

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption

    • This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Definition at line 456 of file UpdateDashboardRequest.h.

◆ WithName() [1/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithName ( const Aws::String value)
inline

The display name of the dashboard.

Definition at line 156 of file UpdateDashboardRequest.h.

◆ WithName() [2/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithName ( Aws::String &&  value)
inline

The display name of the dashboard.

Definition at line 161 of file UpdateDashboardRequest.h.

◆ WithName() [3/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithName ( const char *  value)
inline

The display name of the dashboard.

Definition at line 166 of file UpdateDashboardRequest.h.

◆ WithParameters() [1/2]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithParameters ( const Parameters value)
inline

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 299 of file UpdateDashboardRequest.h.

◆ WithParameters() [2/2]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithParameters ( Parameters &&  value)
inline

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 306 of file UpdateDashboardRequest.h.

◆ WithSourceEntity() [1/2]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithSourceEntity ( const DashboardSourceEntity value)
inline

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 247 of file UpdateDashboardRequest.h.

◆ WithSourceEntity() [2/2]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithSourceEntity ( DashboardSourceEntity &&  value)
inline

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Definition at line 263 of file UpdateDashboardRequest.h.

◆ WithThemeArn() [1/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithThemeArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 505 of file UpdateDashboardRequest.h.

◆ WithThemeArn() [2/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithThemeArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 513 of file UpdateDashboardRequest.h.

◆ WithThemeArn() [3/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithThemeArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Definition at line 521 of file UpdateDashboardRequest.h.

◆ WithVersionDescription() [1/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithVersionDescription ( const Aws::String value)
inline

A description for the first version of the dashboard being created.

Definition at line 337 of file UpdateDashboardRequest.h.

◆ WithVersionDescription() [2/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithVersionDescription ( Aws::String &&  value)
inline

A description for the first version of the dashboard being created.

Definition at line 342 of file UpdateDashboardRequest.h.

◆ WithVersionDescription() [3/3]

UpdateDashboardRequest& Aws::QuickSight::Model::UpdateDashboardRequest::WithVersionDescription ( const char *  value)
inline

A description for the first version of the dashboard being created.

Definition at line 347 of file UpdateDashboardRequest.h.


The documentation for this class was generated from the following file: