Class: Aws::QuickSight::Types::CreateDashboardRequest

Inherits:

Struct

Object
Struct
Aws::QuickSight::Types::CreateDashboardRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-quicksight/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#aws_account_id ⇒ String

The ID of the Amazon Web Services account where you want to create the dashboard.
#dashboard_id ⇒ String

The ID for the dashboard, also added to the IAM policy.
#dashboard_publish_options ⇒ Types::DashboardPublishOptions

Options for publishing the dashboard when you create it:.
#definition ⇒ Types::DashboardVersionDefinition

The definition of a dashboard.
#folder_arns ⇒ Array<String>

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
#link_entities ⇒ Array<String>

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
#link_sharing_configuration ⇒ Types::LinkSharingConfiguration

A structure that contains the permissions of a shareable link to the dashboard.
#name ⇒ String

The display name of the dashboard.
#parameters ⇒ Types::Parameters

The parameters for the creation of the dashboard, which you want to use to override the default settings.
#permissions ⇒ Array<Types::ResourcePermission>

A structure that contains the permissions of the dashboard.
#source_entity ⇒ Types::DashboardSourceEntity

The entity that you are using as a source when you create the dashboard.
#tags ⇒ Array<Types::Tag>

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

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
#validation_strategy ⇒ Types::ValidationStrategy

The option to relax the validation needed to create a dashboard with definition objects.
#version_description ⇒ String

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

Instance Attribute Details

#aws_account_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_publish_options ⇒ `Types::DashboardPublishOptions`

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.

Returns:

(Types::DashboardPublishOptions)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ `Types::DashboardVersionDefinition`

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a ‘SourceEntity` or a `Definition` must be provided in order for the request to be valid.

Returns:

(Types::DashboardVersionDefinition)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#folder_arns ⇒ `Array<String>`

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

Returns:

(Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#link_entities ⇒ `Array<String>`

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Returns:

(Array<String>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#link_sharing_configuration ⇒ `Types::LinkSharingConfiguration`

A structure that contains the permissions of a shareable link to the dashboard.

Returns:

(Types::LinkSharingConfiguration)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The display name of the dashboard.

Returns:

(String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ `Types::Parameters`

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.

Returns:

(Types::Parameters)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#permissions ⇒ `Array<Types::ResourcePermission>`

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

To specify no permissions, omit the permissions list.

Returns:

(Array<Types::ResourcePermission>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#source_entity ⇒ `Types::DashboardSourceEntity`

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 `SourceTemplate`ARN 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.

Either a ‘SourceEntity` or a `Definition` must be provided in order for the request to be valid.

Returns:

(Types::DashboardSourceEntity)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

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

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#theme_arn ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#validation_strategy ⇒ `Types::ValidationStrategy`

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

Returns:

(Types::ValidationStrategy)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

#version_description ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-quicksight/types.rb', line 5405

class CreateDashboardRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :tags,
  :version_description,
  :dashboard_publish_options,
  :theme_arn,
  :definition,
  :validation_strategy,
  :folder_arns,
  :link_sharing_configuration,
  :link_entities)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::QuickSight::Types::CreateDashboardRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

#dashboard_id ⇒ String

#dashboard_publish_options ⇒ Types::DashboardPublishOptions

#definition ⇒ Types::DashboardVersionDefinition

#folder_arns ⇒ Array<String>

#link_entities ⇒ Array<String>

#link_sharing_configuration ⇒ Types::LinkSharingConfiguration

#name ⇒ String

#parameters ⇒ Types::Parameters

#permissions ⇒ Array<Types::ResourcePermission>

#source_entity ⇒ Types::DashboardSourceEntity

#tags ⇒ Array<Types::Tag>

#theme_arn ⇒ String

#validation_strategy ⇒ Types::ValidationStrategy

#version_description ⇒ String

#aws_account_id ⇒ `String`

#dashboard_id ⇒ `String`

#dashboard_publish_options ⇒ `Types::DashboardPublishOptions`

#definition ⇒ `Types::DashboardVersionDefinition`

#folder_arns ⇒ `Array<String>`

#link_entities ⇒ `Array<String>`

#link_sharing_configuration ⇒ `Types::LinkSharingConfiguration`

#name ⇒ `String`

#parameters ⇒ `Types::Parameters`

#permissions ⇒ `Array<Types::ResourcePermission>`

#source_entity ⇒ `Types::DashboardSourceEntity`

#tags ⇒ `Array<Types::Tag>`

#theme_arn ⇒ `String`

#validation_strategy ⇒ `Types::ValidationStrategy`

#version_description ⇒ `String`