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

DescribeAccountSettings

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon account.

Request Syntax


GET /accounts/AwsAccountId/settings HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the Amazon account that contains the settings that you want to list.

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

{
   "AccountSettings": { 
      "AccountName": "string",
      "DefaultNamespace": "string",
      "Edition": "string",
      "NotificationEmail": "string",
      "PublicSharingEnabled": boolean,
      "TerminationProtectionEnabled": boolean
   },
   "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.

AccountSettings

The Amazon QuickSight settings for this Amazon account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

Type: AccountSettings object

RequestId

The Amazon 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

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429