paws.analytics (version 0.1.7)

quicksight_update_dashboard: Updates a dashboard in an AWS account

Description

Updates a dashboard in an AWS account.

Usage

quicksight_update_dashboard(AwsAccountId, DashboardId, Name,
  SourceEntity, Parameters, VersionDescription, DashboardPublishOptions)

Arguments

AwsAccountId

[required] The ID of the AWS account that contains the dashboard that you\'re updating.

DashboardId

[required] The ID for the dashboard.

Name

[required] The display name of the dashboard.

SourceEntity

[required] The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

Parameters

A structure that contains the parameters of the dashboard.

VersionDescription

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

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, 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. The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.

Request syntax

svc$update_dashboard(
  AwsAccountId = "string",
  DashboardId = "string",
  Name = "string",
  SourceEntity = list(
    SourceTemplate = list(
      DataSetReferences = list(
        list(
          DataSetPlaceholder = "string",
          DataSetArn = "string"
        )
      ),
      Arn = "string"
    )
  ),
  Parameters = list(
    StringParameters = list(
      list(
        Name = "string",
        Values = list(
          "string"
        )
      )
    ),
    IntegerParameters = list(
      list(
        Name = "string",
        Values = list(
          123
        )
      )
    ),
    DecimalParameters = list(
      list(
        Name = "string",
        Values = list(
          123.0
        )
      )
    ),
    DateTimeParameters = list(
      list(
        Name = "string",
        Values = list(
          as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  VersionDescription = "string",
  DashboardPublishOptions = list(
    AdHocFilteringOption = list(
      AvailabilityStatus = "ENABLED"|"DISABLED"
    ),
    ExportToCSVOption = list(
      AvailabilityStatus = "ENABLED"|"DISABLED"
    ),
    SheetControlsOption = list(
      VisibilityState = "EXPANDED"|"COLLAPSED"
    )
  )
)