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

DescribeAnalysis

Provides a summary of the metadata for an analysis.

Request Syntax


GET /accounts/AwsAccountId/analyses/AnalysisId 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

{
   "Analysis": { 
      "AnalysisId": "string",
      "Arn": "string",
      "CreatedTime": number,
      "DataSetArns": [ "string" ],
      "Errors": [ 
         { 
            "Message": "string",
            "Type": "string",
            "ViolatedEntities": [ 
               { 
                  "Path": "string"
               }
            ]
         }
      ],
      "LastUpdatedTime": number,
      "Name": "string",
      "Sheets": [ 
         { 
            "Name": "string",
            "SheetId": "string"
         }
      ],
      "Status": "string",
      "ThemeArn": "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.

Analysis

A metadata structure that contains summary information for the analysis that you're describing.

Type: Analysis object

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.

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

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

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