ListAnalyses - Amazon QuickSight

ListAnalyses

Lists Amazon QuickSight analyses that exist in the specified AWS account.

Request Syntax

GET /accounts/AwsAccountId/analyses?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the analyses.

Length Constraints: Fixed length of 12.

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

Required: Yes

MaxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

A pagination token that can be used in a subsequent request.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 Status Content-type: application/json { "AnalysisSummaryList": [ { "AnalysisId": "string", "Arn": "string", "CreatedTime": number, "LastUpdatedTime": number, "Name": "string", "Status": "string" } ], "NextToken": "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.

AnalysisSummaryList

Metadata describing each of the analyses that are listed.

Type: Array of AnalysisSummary objects

Array Members: Maximum number of 100 items.

NextToken

A pagination token that can be used in a subsequent request.

Type: String

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.

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidNextTokenException

The NextToken value isn't valid.

HTTP Status Code: 400

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: