AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass CreateDashboardRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  dashboard_id: "RestrictiveResourceId", # required
  name: "DashboardName", # required
  parameters: {
    string_parameters: [
      {
        name: "NonEmptyString", # required
        values: ["String"], # required
      },
    ],
    integer_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1], # required
      },
    ],
    decimal_parameters: [
      {
        name: "NonEmptyString", # required
        values: [1.0], # required
      },
    ],
    date_time_parameters: [
      {
        name: "NonEmptyString", # required
        values: [Time.now], # required
      },
    ],
  },
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  source_entity: { # required
    source_template: {
      data_set_references: [ # required
        {
          data_set_placeholder: "NonEmptyString", # required
          data_set_arn: "Arn", # required
        },
      ],
      arn: "Arn", # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  version_description: "VersionDescription",
  dashboard_publish_options: {
    ad_hoc_filtering_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    export_to_csv_option: {
      availability_status: "ENABLED", # accepts ENABLED, DISABLED
    },
    sheet_controls_option: {
      visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
    },
  },
  theme_arn: "Arn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#dashboard_idString

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

Returns:

  • (String)


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#dashboard_publish_optionsTypes::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.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#nameString

The display name of the dashboard.

Returns:

  • (String)


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#parametersTypes::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:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#permissionsArray<Types::ResourcePermission>

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.

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#source_entityTypes::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 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.



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#tagsArray<Types::Tag>

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

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#theme_arnString

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)


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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

#version_descriptionString

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

Returns:

  • (String)


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1335

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