[ aws . quicksight ]

create-analysis

Description

Creates an analysis in Amazon QuickSight.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-analysis
--aws-account-id <value>
--analysis-id <value>
--name <value>
[--parameters <value>]
[--permissions <value>]
--source-entity <value>
[--theme-arn <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

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

--analysis-id (string)

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

--name (string)

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

--parameters (structure)

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.

StringParameters -> (list)

The parameters that have a data type of string.

(structure)

A string parameter.

Name -> (string)

A display name for a string parameter.

Values -> (list)

The values of a string parameter.

(string)

IntegerParameters -> (list)

The parameters that have a data type of integer.

(structure)

An integer parameter.

Name -> (string)

The name of the integer parameter.

Values -> (list)

The values for the integer parameter.

(long)

DecimalParameters -> (list)

The parameters that have a data type of decimal.

(structure)

A decimal parameter.

Name -> (string)

A display name for the decimal parameter.

Values -> (list)

The values for the decimal parameter.

(double)

DateTimeParameters -> (list)

The parameters that have a data type of date-time.

(structure)

A date-time parameter.

Name -> (string)

A display name for the date-time parameter.

Values -> (list)

The values for the date-time parameter.

(timestamp)

JSON Syntax:

{
  "StringParameters": [
    {
      "Name": "string",
      "Values": ["string", ...]
    }
    ...
  ],
  "IntegerParameters": [
    {
      "Name": "string",
      "Values": [long, ...]
    }
    ...
  ],
  "DecimalParameters": [
    {
      "Name": "string",
      "Values": [double, ...]
    }
    ...
  ],
  "DateTimeParameters": [
    {
      "Name": "string",
      "Values": [timestamp, ...]
    }
    ...
  ]
}

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

To specify no permissions, omit Permissions .

(structure)

Permission for the resource.

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 Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

Actions -> (list)

The IAM action to grant or revoke permissions on.

(string)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--source-entity (structure)

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.

SourceTemplate -> (structure)

The source template for the source entity of the analysis.

DataSetReferences -> (list)

The dataset references of the source template of an analysis.

(structure)

Dataset reference.

DataSetPlaceholder -> (string)

Dataset placeholder.

DataSetArn -> (string)

Dataset Amazon Resource Name (ARN).

Arn -> (string)

The Amazon Resource Name (ARN) of the source template of an analysis.

JSON Syntax:

{
  "SourceTemplate": {
    "DataSetReferences": [
      {
        "DataSetPlaceholder": "string",
        "DataSetArn": "string"
      }
      ...
    ],
    "Arn": "string"
  }
}

--theme-arn (string)

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.

--tags (list)

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

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Arn -> (string)

The ARN for the analysis.

AnalysisId -> (string)

The ID of the analysis.

CreationStatus -> (string)

The status of the creation of the analysis.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.