POST

/accounts/{AwsAccountId}/analyses/{AnalysisId}

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/analyses/{AnalysisId}

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an <code>AnalysisDefinition</code>.

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

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

AnalysisIdstringrequired

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

Body Params

Namestringrequired

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

Tagsarray

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

ThemeArnstring

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.

Definitionobject

The definition of an analysis.

Parametersobject

A list of Amazon QuickSight parameters and the list's override values.

Permissionsarray

<p>A structure that describes the principals and the resource-level permissions on an analysis. You can use the <code>Permissions</code> 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). </p> <p>To specify no permissions, omit <code>Permissions</code>.</p>

SourceEntityobject

The source entity of an analysis.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/analyses/{AnalysisId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}