Provides a detailed description of the definition of an analysis.
Note
If you do not need to know details about the content of an Analysis, for instance if you
are trying to check the status of a recently created or updated Analysis, use the
DescribeAnalysis instead.
Request Syntax
GET /accounts/AwsAccountId/analyses/AnalysisId/definition HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AnalysisId
-
The ID of the analysis that you're describing. The ID is part of 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. You must be using the AWS account that the analysis is in.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"AnalysisId": "string",
"Definition": {
"AnalysisDefaults": {
"DefaultNewSheetConfiguration": { ... }
},
"CalculatedFields": [
{ ... }
],
"ColumnConfigurations": [
{ ... }
],
"DataSetIdentifierDeclarations": [
{ ... }
],
"FilterGroups": [
{ ... }
],
"Options": {
"CustomActionDefaults": { ... },
"ExcludedDataSetArns": [ "string" ],
"QBusinessInsightsStatus": "string",
"Timezone": "string",
"WeekStart": "string"
},
"ParameterDeclarations": [
{ ... }
],
"QueryExecutionOptions": {
"QueryExecutionMode": "string"
},
"Sheets": [
{ ... }
],
"StaticFiles": [
{ ... }
]
},
"Errors": [
{
"Message": "string",
"Type": "string",
"ViolatedEntities": [
{
"Path": "string"
}
]
}
],
"Name": "string",
"RequestId": "string",
"ResourceStatus": "string",
"ThemeArn": "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 described.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+ - Definition
-
The definition of an analysis.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Type: AnalysisDefinition object
- Errors
-
Errors associated with the analysis.
Type: Array of AnalysisError objects
Array Members: Minimum number of 1 item.
- Name
-
The descriptive name of the analysis.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- RequestId
-
The AWS request ID for this operation.
Type: String
- ResourceStatus
-
Status associated with the analysis.
-
CREATION_IN_PROGRESS -
CREATION_SUCCESSFUL -
CREATION_FAILED -
UPDATE_IN_PROGRESS -
UPDATE_SUCCESSFUL -
UPDATE_FAILED -
DELETED
Type: String
Valid Values:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED -
- ThemeArn
-
The ARN of the theme of the analysis.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
HTTP Status Code: 401
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
