--- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_quicksight_analysis Resource - terraform-provider-awscc" subcategory: "" description: |- Definition of the AWS::QuickSight::Analysis Resource Type. --- # awscc_quicksight_analysis (Resource) Definition of the AWS::QuickSight::Analysis Resource Type. ## Schema ### Required - `analysis_id` (String) - `aws_account_id` (String) - `source_entity` (Attributes)
The source entity of an analysis.
(see [below for nested schema](#nestedatt--source_entity)) ### Optional - `errors` (Attributes List)Errors associated with the analysis.
(see [below for nested schema](#nestedatt--errors)) - `name` (String)The descriptive name of the analysis.
- `parameters` (Attributes)A list of QuickSight parameters and the list's override values.
(see [below for nested schema](#nestedatt--parameters)) - `permissions` (Attributes List)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
.
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
(see [below for nested schema](#nestedatt--tags)) - `theme_arn` (String)The ARN of the theme of the analysis.
### Read-Only - `arn` (String)The Amazon Resource Name (ARN) of the analysis.
- `created_time` (String)The time that the analysis was created.
- `data_set_arns` (List of String)The ARNs of the datasets of the analysis.
- `id` (String) Uniquely identifies the resource. - `last_updated_time` (String)The time that the analysis was last updated.
- `sheets` (Attributes List)A list of the associated sheets with the unique identifier and name of each sheet.
(see [below for nested schema](#nestedatt--sheets)) - `status` (String) ### Nested Schema for `source_entity` Required: - `source_template` (Attributes)The source template of an analysis.
(see [below for nested schema](#nestedatt--source_entity--source_template)) ### Nested Schema for `source_entity.source_template` Required: - `arn` (String)The Amazon Resource Name (ARN) of the source template of an analysis.
- `data_set_references` (Attributes List)The dataset references of the source template of an analysis.
(see [below for nested schema](#nestedatt--source_entity--source_template--data_set_references)) ### Nested Schema for `source_entity.source_template.data_set_references` Required: - `data_set_arn` (String)Dataset Amazon Resource Name (ARN).
- `data_set_placeholder` (String)Dataset placeholder.
### Nested Schema for `errors` Optional: - `message` (String)The message associated with the analysis error.
- `type` (String) ### Nested Schema for `parameters` Optional: - `date_time_parameters` (Attributes List)Date-time parameters.
(see [below for nested schema](#nestedatt--parameters--date_time_parameters)) - `decimal_parameters` (Attributes List)Decimal parameters.
(see [below for nested schema](#nestedatt--parameters--decimal_parameters)) - `integer_parameters` (Attributes List)Integer parameters.
(see [below for nested schema](#nestedatt--parameters--integer_parameters)) - `string_parameters` (Attributes List)String parameters.
(see [below for nested schema](#nestedatt--parameters--string_parameters)) ### Nested Schema for `parameters.date_time_parameters` Optional: - `name` (String)A display name for the date-time parameter.
- `values` (List of String)The values for the date-time parameter.
### Nested Schema for `parameters.decimal_parameters` Optional: - `name` (String)A display name for the decimal parameter.
- `values` (List of Number)The values for the decimal parameter.
### Nested Schema for `parameters.integer_parameters` Optional: - `name` (String)The name of the integer parameter.
- `values` (List of Number)The values for the integer parameter.
### Nested Schema for `parameters.string_parameters` Optional: - `name` (String)A display name for a string parameter.
- `values` (List of String)The values of a string parameter.
### Nested Schema for `permissions` Optional: - `actions` (List of String)The IAM action to grant or revoke permissions on.
- `principal` (String)The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Tag key.
- `value` (String)Tag value.
### Nested Schema for `sheets` Read-Only: - `name` (String)The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.
- `sheet_id` (String)The unique identifier associated with a sheet.
## Import Import is supported using the following syntax: ```shell $ terraform import awscc_quicksight_analysis.example