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

#include <CreateDashboardRequest.h>

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

Public Member Functions

 CreateDashboardRequest ()
 
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)
 
CreateDashboardRequestWithAwsAccountId (const Aws::String &value)
 
CreateDashboardRequestWithAwsAccountId (Aws::String &&value)
 
CreateDashboardRequestWithAwsAccountId (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)
 
CreateDashboardRequestWithDashboardId (const Aws::String &value)
 
CreateDashboardRequestWithDashboardId (Aws::String &&value)
 
CreateDashboardRequestWithDashboardId (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)
 
CreateDashboardRequestWithName (const Aws::String &value)
 
CreateDashboardRequestWithName (Aws::String &&value)
 
CreateDashboardRequestWithName (const char *value)
 
const ParametersGetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Parameters &value)
 
void SetParameters (Parameters &&value)
 
CreateDashboardRequestWithParameters (const Parameters &value)
 
CreateDashboardRequestWithParameters (Parameters &&value)
 
const Aws::Vector< ResourcePermission > & GetPermissions () const
 
bool PermissionsHasBeenSet () const
 
void SetPermissions (const Aws::Vector< ResourcePermission > &value)
 
void SetPermissions (Aws::Vector< ResourcePermission > &&value)
 
CreateDashboardRequestWithPermissions (const Aws::Vector< ResourcePermission > &value)
 
CreateDashboardRequestWithPermissions (Aws::Vector< ResourcePermission > &&value)
 
CreateDashboardRequestAddPermissions (const ResourcePermission &value)
 
CreateDashboardRequestAddPermissions (ResourcePermission &&value)
 
const DashboardSourceEntityGetSourceEntity () const
 
bool SourceEntityHasBeenSet () const
 
void SetSourceEntity (const DashboardSourceEntity &value)
 
void SetSourceEntity (DashboardSourceEntity &&value)
 
CreateDashboardRequestWithSourceEntity (const DashboardSourceEntity &value)
 
CreateDashboardRequestWithSourceEntity (DashboardSourceEntity &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDashboardRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDashboardRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDashboardRequestAddTags (const Tag &value)
 
CreateDashboardRequestAddTags (Tag &&value)
 
const Aws::StringGetVersionDescription () const
 
bool VersionDescriptionHasBeenSet () const
 
void SetVersionDescription (const Aws::String &value)
 
void SetVersionDescription (Aws::String &&value)
 
void SetVersionDescription (const char *value)
 
CreateDashboardRequestWithVersionDescription (const Aws::String &value)
 
CreateDashboardRequestWithVersionDescription (Aws::String &&value)
 
CreateDashboardRequestWithVersionDescription (const char *value)
 
const DashboardPublishOptionsGetDashboardPublishOptions () const
 
bool DashboardPublishOptionsHasBeenSet () const
 
void SetDashboardPublishOptions (const DashboardPublishOptions &value)
 
void SetDashboardPublishOptions (DashboardPublishOptions &&value)
 
CreateDashboardRequestWithDashboardPublishOptions (const DashboardPublishOptions &value)
 
CreateDashboardRequestWithDashboardPublishOptions (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)
 
CreateDashboardRequestWithThemeArn (const Aws::String &value)
 
CreateDashboardRequestWithThemeArn (Aws::String &&value)
 
CreateDashboardRequestWithThemeArn (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 27 of file CreateDashboardRequest.h.

Constructor & Destructor Documentation

◆ CreateDashboardRequest()

Aws::QuickSight::Model::CreateDashboardRequest::CreateDashboardRequest ( )

Member Function Documentation

◆ AddPermissions() [1/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::AddPermissions ( const ResourcePermission value)
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 269 of file CreateDashboardRequest.h.

◆ AddPermissions() [2/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::AddPermissions ( ResourcePermission &&  value)
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 277 of file CreateDashboardRequest.h.

◆ AddTags() [1/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::AddTags ( const Tag value)
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 417 of file CreateDashboardRequest.h.

◆ AddTags() [2/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::AddTags ( Tag &&  value)
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 423 of file CreateDashboardRequest.h.

◆ AwsAccountIdHasBeenSet()

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 51 of file CreateDashboardRequest.h.

◆ DashboardIdHasBeenSet()

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 98 of file CreateDashboardRequest.h.

◆ DashboardPublishOptionsHasBeenSet()

bool Aws::QuickSight::Model::CreateDashboardRequest::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, Amazon 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 501 of file CreateDashboardRequest.h.

◆ GetAwsAccountId()

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 45 of file CreateDashboardRequest.h.

◆ GetDashboardId()

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 93 of file CreateDashboardRequest.h.

◆ GetDashboardPublishOptions()

const DashboardPublishOptions& Aws::QuickSight::Model::CreateDashboardRequest::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, Amazon 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 483 of file CreateDashboardRequest.h.

◆ GetName()

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

The display name of the dashboard.

Definition at line 134 of file CreateDashboardRequest.h.

◆ GetParameters()

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 177 of file CreateDashboardRequest.h.

◆ GetPermissions()

const Aws::Vector<ResourcePermission>& Aws::QuickSight::Model::CreateDashboardRequest::GetPermissions ( ) const
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 221 of file CreateDashboardRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateDashboardRequest.h.

◆ GetSourceEntity()

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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 294 of file CreateDashboardRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::QuickSight::Model::CreateDashboardRequest::GetTags ( ) const
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 381 of file CreateDashboardRequest.h.

◆ GetThemeArn()

const Aws::String& Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 582 of file CreateDashboardRequest.h.

◆ GetVersionDescription()

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

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

Definition at line 429 of file CreateDashboardRequest.h.

◆ NameHasBeenSet()

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

The display name of the dashboard.

Definition at line 139 of file CreateDashboardRequest.h.

◆ ParametersHasBeenSet()

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 184 of file CreateDashboardRequest.h.

◆ PermissionsHasBeenSet()

bool Aws::QuickSight::Model::CreateDashboardRequest::PermissionsHasBeenSet ( ) const
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 229 of file CreateDashboardRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAwsAccountId() [1/3]

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 63 of file CreateDashboardRequest.h.

◆ SetAwsAccountId() [2/3]

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 57 of file CreateDashboardRequest.h.

◆ SetAwsAccountId() [3/3]

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 69 of file CreateDashboardRequest.h.

◆ SetDashboardId() [1/3]

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 108 of file CreateDashboardRequest.h.

◆ SetDashboardId() [2/3]

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 103 of file CreateDashboardRequest.h.

◆ SetDashboardId() [3/3]

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 113 of file CreateDashboardRequest.h.

◆ SetDashboardPublishOptions() [1/2]

void Aws::QuickSight::Model::CreateDashboardRequest::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, Amazon 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 519 of file CreateDashboardRequest.h.

◆ SetDashboardPublishOptions() [2/2]

void Aws::QuickSight::Model::CreateDashboardRequest::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, Amazon 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 537 of file CreateDashboardRequest.h.

◆ SetName() [1/3]

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

The display name of the dashboard.

Definition at line 149 of file CreateDashboardRequest.h.

◆ SetName() [2/3]

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

The display name of the dashboard.

Definition at line 144 of file CreateDashboardRequest.h.

◆ SetName() [3/3]

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

The display name of the dashboard.

Definition at line 154 of file CreateDashboardRequest.h.

◆ SetParameters() [1/2]

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 191 of file CreateDashboardRequest.h.

◆ SetParameters() [2/2]

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 198 of file CreateDashboardRequest.h.

◆ SetPermissions() [1/2]

void Aws::QuickSight::Model::CreateDashboardRequest::SetPermissions ( Aws::Vector< ResourcePermission > &&  value)
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 245 of file CreateDashboardRequest.h.

◆ SetPermissions() [2/2]

void Aws::QuickSight::Model::CreateDashboardRequest::SetPermissions ( const Aws::Vector< ResourcePermission > &  value)
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 237 of file CreateDashboardRequest.h.

◆ SetSourceEntity() [1/2]

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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 326 of file CreateDashboardRequest.h.

◆ SetSourceEntity() [2/2]

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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 342 of file CreateDashboardRequest.h.

◆ SetTags() [1/2]

void Aws::QuickSight::Model::CreateDashboardRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 399 of file CreateDashboardRequest.h.

◆ SetTags() [2/2]

void Aws::QuickSight::Model::CreateDashboardRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 393 of file CreateDashboardRequest.h.

◆ SetThemeArn() [1/3]

void Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 606 of file CreateDashboardRequest.h.

◆ SetThemeArn() [2/3]

void Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 598 of file CreateDashboardRequest.h.

◆ SetThemeArn() [3/3]

void Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 614 of file CreateDashboardRequest.h.

◆ SetVersionDescription() [1/3]

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

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

Definition at line 444 of file CreateDashboardRequest.h.

◆ SetVersionDescription() [2/3]

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

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

Definition at line 439 of file CreateDashboardRequest.h.

◆ SetVersionDescription() [3/3]

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

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

Definition at line 449 of file CreateDashboardRequest.h.

◆ SourceEntityHasBeenSet()

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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 310 of file CreateDashboardRequest.h.

◆ TagsHasBeenSet()

bool Aws::QuickSight::Model::CreateDashboardRequest::TagsHasBeenSet ( ) const
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 387 of file CreateDashboardRequest.h.

◆ ThemeArnHasBeenSet()

bool Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 590 of file CreateDashboardRequest.h.

◆ VersionDescriptionHasBeenSet()

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

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

Definition at line 434 of file CreateDashboardRequest.h.

◆ WithAwsAccountId() [1/3]

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 81 of file CreateDashboardRequest.h.

◆ WithAwsAccountId() [2/3]

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 75 of file CreateDashboardRequest.h.

◆ WithAwsAccountId() [3/3]

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

The ID of the Amazon Web Services account where you want to create the dashboard.

Definition at line 87 of file CreateDashboardRequest.h.

◆ WithDashboardId() [1/3]

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 123 of file CreateDashboardRequest.h.

◆ WithDashboardId() [2/3]

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 118 of file CreateDashboardRequest.h.

◆ WithDashboardId() [3/3]

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

The ID for the dashboard, also added to the IAMpolicy.

Definition at line 128 of file CreateDashboardRequest.h.

◆ WithDashboardPublishOptions() [1/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::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, Amazon 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 555 of file CreateDashboardRequest.h.

◆ WithDashboardPublishOptions() [2/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::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, Amazon 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 573 of file CreateDashboardRequest.h.

◆ WithName() [1/3]

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

The display name of the dashboard.

Definition at line 164 of file CreateDashboardRequest.h.

◆ WithName() [2/3]

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

The display name of the dashboard.

Definition at line 159 of file CreateDashboardRequest.h.

◆ WithName() [3/3]

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

The display name of the dashboard.

Definition at line 169 of file CreateDashboardRequest.h.

◆ WithParameters() [1/2]

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 205 of file CreateDashboardRequest.h.

◆ WithParameters() [2/2]

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Definition at line 212 of file CreateDashboardRequest.h.

◆ WithPermissions() [1/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::WithPermissions ( Aws::Vector< ResourcePermission > &&  value)
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 261 of file CreateDashboardRequest.h.

◆ WithPermissions() [2/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::WithPermissions ( const Aws::Vector< ResourcePermission > &  value)
inline

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

Definition at line 253 of file CreateDashboardRequest.h.

◆ WithSourceEntity() [1/2]

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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 358 of file CreateDashboardRequest.h.

◆ WithSourceEntity() [2/2]

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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 374 of file CreateDashboardRequest.h.

◆ WithTags() [1/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 411 of file CreateDashboardRequest.h.

◆ WithTags() [2/2]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Definition at line 405 of file CreateDashboardRequest.h.

◆ WithThemeArn() [1/3]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 630 of file CreateDashboardRequest.h.

◆ WithThemeArn() [2/3]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 622 of file CreateDashboardRequest.h.

◆ WithThemeArn() [3/3]

CreateDashboardRequest& Aws::QuickSight::Model::CreateDashboardRequest::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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Definition at line 638 of file CreateDashboardRequest.h.

◆ WithVersionDescription() [1/3]

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

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

Definition at line 459 of file CreateDashboardRequest.h.

◆ WithVersionDescription() [2/3]

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

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

Definition at line 454 of file CreateDashboardRequest.h.

◆ WithVersionDescription() [3/3]

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

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

Definition at line 464 of file CreateDashboardRequest.h.


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