Describe Dashboard

quicksight_describe_dashboard

R Documentation

Provides a summary for a dashboard

Description

Provides a summary for a dashboard.

Usage

quicksight_describe_dashboard(AwsAccountId, DashboardId, VersionNumber,
  AliasName)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account that contains the dashboard that you're describing.

DashboardId

[required] The ID for the dashboard.

VersionNumber

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

AliasName

The alias name.

Value

A list with the following syntax:

list(
  Dashboard = list(
    DashboardId = "string",
    Arn = "string",
    Name = "string",
    Version = list(
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      Errors = list(
        list(
          Type = "ACCESS_DENIED"|"SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"PARAMETER_VALUE_INCOMPATIBLE"|"PARAMETER_TYPE_INVALID"|"PARAMETER_NOT_FOUND"|"COLUMN_TYPE_MISMATCH"|"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"|"COLUMN_REPLACEMENT_MISSING",
          Message = "string",
          ViolatedEntities = list(
            list(
              Path = "string"
            )
          )
        )
      ),
      VersionNumber = 123,
      Status = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
      Arn = "string",
      SourceEntityArn = "string",
      DataSetArns = list(
        "string"
      ),
      Description = "string",
      ThemeArn = "string",
      Sheets = list(
        list(
          SheetId = "string",
          Name = "string",
          Images = list(
            list(
              SheetImageId = "string",
              Source = list(
                SheetImageStaticFileSource = list(
                  StaticFileId = "string"
                )
              ),
              Scaling = list(
                ScalingType = "SCALE_TO_WIDTH"|"SCALE_TO_HEIGHT"|"SCALE_TO_CONTAINER"|"SCALE_NONE"
              ),
              Tooltip = list(
                TooltipText = list(
                  PlainText = "string"
                ),
                Visibility = "HIDDEN"|"VISIBLE"
              ),
              ImageContentAltText = "string",
              Interactions = list(
                ImageMenuOption = list(
                  AvailabilityStatus = "ENABLED"|"DISABLED"
                )
              ),
              Actions = list(
                list(
                  CustomActionId = "string",
                  Name = "string",
                  Status = "ENABLED"|"DISABLED",
                  Trigger = "CLICK"|"MENU",
                  ActionOperations = list(
                    list(
                      NavigationOperation = list(
                        LocalNavigationConfiguration = list(
                          TargetSheetId = "string"
                        )
                      ),
                      URLOperation = list(
                        URLTemplate = "string",
                        URLTarget = "NEW_TAB"|"NEW_WINDOW"|"SAME_TAB"
                      ),
                      SetParametersOperation = list(
                        ParameterValueConfigurations = list(
                          list(
                            DestinationParameterName = "string",
                            Value = list(
                              CustomValuesConfiguration = list(
                                IncludeNullValue = TRUE|FALSE,
                                CustomValues = list(
                                  StringValues = list(
                                    "string"
                                  ),
                                  IntegerValues = list(
                                    123
                                  ),
                                  DecimalValues = list(
                                    123.0
                                  ),
                                  DateTimeValues = list(
                                    as.POSIXct(
                                      "2015-01-01"
                                    )
                                  )
                                )
                              ),
                              SelectAllValueOptions = "ALL_VALUES",
                              SourceParameterName = "string",
                              SourceField = "string",
                              SourceColumn = list(
                                DataSetIdentifier = "string",
                                ColumnName = "string"
                              )
                            )
                          )
                        )
                      )
                    )
                  )
                )
              )
            )
          )
        )
      )
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastPublishedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LinkEntities = list(
      "string"
    )
  ),
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$describe_dashboard(
  AwsAccountId = "string",
  DashboardId = "string",
  VersionNumber = 123,
  AliasName = "string"
)