Describe Analysis

quicksight_describe_analysis

R Documentation

Provides a summary of the metadata for an analysis

Description

Provides a summary of the metadata for an analysis.

Usage

quicksight_describe_analysis(AwsAccountId, AnalysisId)

Arguments

AwsAccountId

[required] The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

AnalysisId

[required] The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

Value

A list with the following syntax:

list(
  Analysis = list(
    AnalysisId = "string",
    Arn = "string",
    Name = "string",
    Status = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
    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"
          )
        )
      )
    ),
    DataSetArns = list(
      "string"
    ),
    ThemeArn = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    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"
                            )
                          )
                        )
                      )
                    )
                  )
                )
              )
            )
          )
        )
      )
    )
  ),
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$describe_analysis(
  AwsAccountId = "string",
  AnalysisId = "string"
)