Class: Aws::QuickSight::Types::CreateAnalysisRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass CreateAnalysisRequest data as a 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
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_idString

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

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

The ID of the Amazon Web Services account where you are creating an analysis.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#parametersTypes::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.

Returns:



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#permissionsArray<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 Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Returns:



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_entityTypes::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.



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#theme_arnString

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

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1121

class CreateAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :name,
  :parameters,
  :permissions,
  :source_entity,
  :theme_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end