Describe Template

quicksight_describe_template

R Documentation

Describes a template's metadata

Description

Describes a template's metadata.

Usage

quicksight_describe_template(AwsAccountId, TemplateId, VersionNumber,
  AliasName)

Arguments

AwsAccountId

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

TemplateId

[required] The ID for the template.

VersionNumber

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

AliasName

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword ⁠$LATEST⁠ in the AliasName parameter. The keyword ⁠$PUBLISHED⁠ doesn't apply to templates.

Value

A list with the following syntax:

list(
  Template = list(
    Arn = "string",
    Name = "string",
    Version = list(
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      Errors = list(
        list(
          Type = "SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"ACCESS_DENIED",
          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",
      DataSetConfigurations = list(
        list(
          Placeholder = "string",
          DataSetSchema = list(
            ColumnSchemaList = list(
              list(
                Name = "string",
                DataType = "string",
                GeographicRole = "string"
              )
            )
          ),
          ColumnGroupSchemaList = list(
            list(
              Name = "string",
              ColumnGroupColumnSchemaList = list(
                list(
                  Name = "string"
                )
              )
            )
          )
        )
      ),
      Description = "string",
      SourceEntityArn = "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"
                              )
                            )
                          )
                        )
                      )
                    )
                  )
                )
              )
            )
          )
        )
      )
    ),
    TemplateId = "string",
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$describe_template(
  AwsAccountId = "string",
  TemplateId = "string",
  VersionNumber = 123,
  AliasName = "string"
)