You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::QuickSight::Types::CreateAnalysisRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::QuickSight::Types::CreateAnalysisRequest
- Defined in:
- (unknown)
Overview
When passing CreateAnalysisRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
aws_account_id: "AwsAccountId", # required
analysis_id: "RestrictiveResourceId", # required
name: "AnalysisName", # required
parameters: {
string_parameters: [
{
name: "NonEmptyString", # required
values: ["String"], # required
},
],
integer_parameters: [
{
name: "NonEmptyString", # required
values: [1], # required
},
],
decimal_parameters: [
{
name: "NonEmptyString", # required
values: [1.0], # required
},
],
date_time_parameters: [
{
name: "NonEmptyString", # required
values: [Time.now], # required
},
],
},
permissions: [
{
principal: "Principal", # required
actions: ["String"], # required
},
],
source_entity: { # required
source_template: {
data_set_references: [ # required
{
data_set_placeholder: "NonEmptyString", # required
data_set_arn: "Arn", # required
},
],
arn: "Arn", # required
},
},
theme_arn: "Arn",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#analysis_id ⇒ String
The ID for the analysis that you\'re creating.
-
#aws_account_id ⇒ String
The ID of the AWS account where you are creating an analysis.
-
#name ⇒ String
A descriptive name for the analysis that you\'re creating.
-
#parameters ⇒ Types::Parameters
The parameter names and override values that you want to use.
-
#permissions ⇒ Array<Types::ResourcePermission>
A structure that describes the principals and the resource-level permissions on an analysis.
-
#source_entity ⇒ Types::AnalysisSourceEntity
A source entity to use for the analysis that you\'re creating.
-
#tags ⇒ Array<Types::Tag>
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
-
#theme_arn ⇒ String
The ARN for the theme to apply to the analysis that you\'re creating.
Instance Attribute Details
#analysis_id ⇒ String
The ID for the analysis that you\'re creating. This ID displays in the URL of the analysis.
#aws_account_id ⇒ String
The ID of the AWS account where you are creating an analysis.
#name ⇒ String
A descriptive name for the analysis that you\'re creating. This name displays for the analysis in the QuickSight console.
#parameters ⇒ Types::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 ⇒ Array<Types::ResourcePermission>
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
.
#source_entity ⇒ Types::AnalysisSourceEntity
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.
#tags ⇒ Array<Types::Tag>
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
#theme_arn ⇒ String
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.