Analysis
quicksight.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | quicksight-controller/apis/v1alpha1#Analysis |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Analysis |
| ListKind | AnalysisList |
| Plural | analyses |
| Singular | analysis |
Metadata structure for an analysis in Quick Sight
Spec
awsAccountID: string
folderARNs:
- string
id: string
name: string
parameters:
dateTimeParameters:
- name: string
values:
- string
decimalParameters:
- name: string
values:
- number
integerParameters:
- name: string
values:
- integer
stringParameters:
- name: string
values:
- string
permissions:
actions:
- string
principal: string
sourceEntity:
sourceTemplate:
arn: string
dataSetReferences:
- dataSetARN: string
dataSetPlaceholder: string
dataSetRef:
from:
name: string
namespace: string
tags:
- key: string
value: string
themeARN: string
validationStrategy:
mode: string
| Field | Description |
|---|---|
| awsAccountID Required | string The ID of the Amazon Web Services account where you are creating an analysis. Regex Pattern: ^[0-9]{12}$ |
| folderARNs Optional | array When you create the analysis, Amazon Quick Sight adds the analysis to these folders. |
| folderARNs.[] Required | string |
| name Required | string A descriptive name for the analysis that you’re creating. This name displays for the analysis in the Amazon Quick Sight console. |
| parameters Optional | object 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. |
| parameters.dateTimeParameters Optional | array |
| parameters.dateTimeParameters.[] Required | object A date-time parameter. |
| parameters.dateTimeParameters.[].values Optional | array |
| parameters.dateTimeParameters.[].values.[] Required | string |
| parameters.decimalParameters.[] Required | object A decimal parameter. |
| parameters.decimalParameters.[].values Optional | array |
| parameters.decimalParameters.[].values.[] Required | number |
| parameters.integerParameters.[] Required | object An integer parameter. |
| parameters.integerParameters.[].values Optional | array |
| parameters.integerParameters.[].values.[] Required | integer |
| parameters.stringParameters.[] Required | object A string parameter. |
| parameters.stringParameters.[].values Optional | array |
| parameters.stringParameters.[].values.[] Required | string |
| permissions.[] Required | object Permission for the resource. |
| permissions.[].actions.[] Required | string |
| sourceEntity Optional | object 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. Either a SourceEntity or a Definition must be provided in order for the request to be valid. |
| sourceEntity.sourceTemplate Optional | object The source template of an analysis. |
| sourceEntity.sourceTemplate.arn Optional | string |
| sourceEntity.sourceTemplate.dataSetReferences Optional | array |
| sourceEntity.sourceTemplate.dataSetReferences.[] Required | object Dataset reference. |
| sourceEntity.sourceTemplate.dataSetReferences.[].dataSetPlaceholder Optional | string |
| sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef Optional | object Reference field for DataSetARN |
| sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef.from.name Optional | string |
| sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef.from.namespace Optional | string |
| tags Optional | array Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis. |
| tags.[] Required | object The key or keys of the key-value pairs for the resource tag or tags assigned |
| to the resource. | |
| tags.[].value Optional | string |
| themeARN Optional | string The ARN for the theme to apply to the analysis that you’re creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it. |
| validationStrategy Optional | object The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors. |
| validationStrategy.mode Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdTime: string
errors:
- message: string
type: string
violatedEntities:
- path: string
lastUpdatedTime: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdTime Optional | string The time that the analysis was created. |
| errors Optional | array Errors associated with the analysis. |
| errors.[] Required | object Analysis error. |
| errors.[].type Optional | string |
| errors.[].violatedEntities Optional | array |
| errors.[].violatedEntities.[] Required | object An object, structure, or sub-structure of an analysis, template, or dashboard. |
| lastUpdatedTime Optional | string The time that the analysis was last updated. |
| status Optional | string Status associated with the analysis. |