paws.analytics (version 0.1.11)

quicksight_create_analysis: Creates an analysis in Amazon QuickSight

Description

Creates an analysis in Amazon QuickSight.

Usage

quicksight_create_analysis(AwsAccountId, AnalysisId, Name, Parameters,
  Permissions, SourceEntity, ThemeArn, Tags)

Arguments

AwsAccountId

[required] The ID of the AWS account where you are creating an analysis.

AnalysisId

[required] The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Name

[required] A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.

Parameters

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Permissions

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

SourceEntity

[required] A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

ThemeArn

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.

Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Value

A list with the following syntax:

list(
  Arn = "string",
  AnalysisId = "string",
  CreationStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
  Status = 123,
  RequestId = "string"
)

Request syntax

svc$create_analysis(
  AwsAccountId = "string",
  AnalysisId = "string",
  Name = "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"
          )
        )
      )
    )
  ),
  Permissions = list(
    list(
      Principal = "string",
      Actions = list(
        "string"
      )
    )
  ),
  SourceEntity = list(
    SourceTemplate = list(
      DataSetReferences = list(
        list(
          DataSetPlaceholder = "string",
          DataSetArn = "string"
        )
      ),
      Arn = "string"
    )
  ),
  ThemeArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)