quicksight_describe_dashboard: Provides a summary for a dashboard

Description Usage Arguments Value Request syntax

View source: R/quicksight_operations.R

Description

Provides a summary for a dashboard.

Usage

1
2
quicksight_describe_dashboard(AwsAccountId, DashboardId, VersionNumber,
  AliasName)

Arguments

AwsAccountId

[required] The ID of the AWS 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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"
        )
      ),
      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"
        )
      )
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastPublishedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  Status = 123,
  RequestId = "string"
)

Request syntax

1
2
3
4
5
6
svc$describe_dashboard(
  AwsAccountId = "string",
  DashboardId = "string",
  VersionNumber = 123,
  AliasName = "string"
)

paws.analytics documentation built on March 8, 2021, 1:10 a.m.