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

DescribeAccountSubscription

Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

Request Syntax


GET /account/AwsAccountId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID associated with your Quick Sight account.

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

{
   "AccountInfo": { 
      "AccountName": "string",
      "AccountSubscriptionStatus": "string",
      "AuthenticationType": "string",
      "Edition": "string",
      "IAMIdentityCenterInstanceArn": "string",
      "NotificationEmail": "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.

AccountInfo

A structure that contains the following elements:

Your Quick Sight account name.
The edition of Quick Sight that your account is using.
The notification email address that is associated with the Amazon Quick Sight account.
The authentication type of the Quick Sight account.
The status of the Quick Sight account's subscription.

Type: AccountInfo 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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429