CreateAnalysis -

CreateAnalysis

Creates an analysis in Amazon QuickSight.

Request Syntax

POST /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1 Content-type: application/json { "Name": "string", "Parameters": { "DateTimeParameters": [ { "Name": "string", "Values": [ number ] } ], "DecimalParameters": [ { "Name": "string", "Values": [ number ] } ], "IntegerParameters": [ { "Name": "string", "Values": [ number ] } ], "StringParameters": [ { "Name": "string", "Values": [ "string" ] } ] }, "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThemeArn": "string" }

URI Request Parameters

The request uses the following URI parameters.

AnalysisId

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

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

Required: Yes

AwsAccountId

The ID of the AWS account where you are creating an analysis.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\u0020-\u00FF]+

Required: Yes

SourceEntity

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.

Type: AnalysisSourceEntity object

Required: Yes

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.

Type: Parameters object

Required: No

Permissions

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.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

ThemeArn

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.

Type: String

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "AnalysisId": "string", "Arn": "string", "CreationStatus": "string", "RequestId": "string" }

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status

The HTTP status of the request.

The following data is returned in JSON format by the service.

AnalysisId

The ID of the analysis.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

Arn

The ARN for the analysis.

Type: String

CreationStatus

The status of the creation of the analysis.

Type: String

Valid Values: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: