Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAnalysis

Updates an analysis in Amazon QuickSight

Request Syntax


PUT /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1
Content-type: application/json

{
   "Definition": { 
      "AnalysisDefaults": { 
         "DefaultNewSheetConfiguration": { ... }
      },
      "CalculatedFields": [ 
         { ... }
      ],
      "ColumnConfigurations": [ 
         { ... }
      ],
      "DataSetIdentifierDeclarations": [ 
         { ... }
      ],
      "FilterGroups": [ 
         { ... }
      ],
      "Options": { 
         "Timezone": "string",
         "WeekStart": "string"
      },
      "ParameterDeclarations": [ 
         { ... }
      ],
      "QueryExecutionOptions": { 
         "QueryExecutionMode": "string"
      },
      "Sheets": [ 
         { ... }
      ]
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "ValidationStrategy": { 
      "Mode": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

AnalysisId

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

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

Pattern: [\w\-]+

Required: Yes

AwsAccountId

The ID of the AWS account that contains the analysis that you're updating.

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 updating. This name displays for the analysis in the Amazon QuickSight console.

Type: String

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

Required: Yes

Definition

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Type: AnalysisDefinition object

Required: No

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

SourceEntity

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

Type: AnalysisSourceEntity object

Required: No

ThemeArn

The Amazon Resource Name (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.

Type: String

Required: No

ValidationStrategy

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

Type: ValidationStrategy object

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "AnalysisId": "string",
   "Arn": "string",
   "RequestId": "string",
   "UpdateStatus": "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 512.

Pattern: [\w\-]+

Arn

The ARN of the analysis that you're updating.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

UpdateStatus

The update status of the last update that was made to the analysis.

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 Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403