Amazon QuickSight API errors
Amazon QuickSight has two types of error codes:
-
Client errors – These errors are usually caused by something the client did. An example is specifying an incorrect or invalid parameter in the request. Another is using an action or resource for a user that doesn't have permission to use the action or resource. These errors are accompanied by a 400-series HTTP response code.
-
Server errors – These errors are usually caused by an AWS server-side issue. These errors are accompanied by a 500-series HTTP response code.
Common client errors
Following, you can find a list of the common client errors that all operations can return.
| Error code | Description |
|---|---|
AuthFailure |
The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service and that your credit card details are correct. Also ensure that you're using the correct access keys. |
Blocked |
Your account is currently blocked. Contact Support |
DryRunOperation |
The user has the required permissions, so the request would have
succeeded, but the DryRun parameter was used. |
IdempotentParameterMismatch |
The request uses the same client token as a previous, but nonidentical request. Don't reuse a client token with different requests, unless the requests are identical. |
IncompleteSignature |
The request signature doesn't conform to AWS standards. |
InvalidAction |
The action or operation requested isn't valid. Verify that the action is typed correctly. |
InvalidCharacter |
A specified character isn't valid. |
InvalidClientTokenId |
The X.509 certificate or AWS access key ID provided doesn't exist in our records. |
InvalidPaginationToken |
The specified pagination token isn't valid or is expired. |
InvalidParameter |
A parameter specified in a request isn't valid, is unsupported, or can't be used. The returned message provides an explanation of the error value. |
InvalidParameterCombination |
A value that indicates an incorrect combination of parameters, or a missing parameter. |
InvalidParameterValue |
A value specified in a parameter isn't valid, is unsupported, or can't be used. Ensure that you specify a resource by using its full ID. The returned message provides an explanation of the error value. |
InvalidQueryParameter |
The AWS query string is malformed or doesn't adhere to AWS standards. |
MalformedQueryString |
The query string contains a syntax error. |
MissingAction |
The request is missing an action or a required parameter. |
MissingAuthenticationToken |
The request must contain either a valid (registered) AWS access key ID or X.509 certificate. |
MissingParameter |
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request, for example the resource ID. |
OptInRequired |
You aren't authorized to use the requested service. Ensure that you have subscribed to the service you are trying to use. If you are new to AWS, your account might take some time to be activated while your credit card details are being verified. |
PendingVerification |
Your account is pending verification. Until the verification process is complete, you
might not be able to carry out requests with this account. If you
have questions, contact AWS Support |
RequestExpired |
The request reached the service more than 15 minutes after the date stamp on the request or the request expiration date (such as for presigned URLs). Or the date stamp on the request is more than 15 minutes in the future. If you're using temporary security credentials, this error can also occur if the credentials have expired. For more information, see Temporary Security Credentials in the IAM User Guide. |
UnauthorizedOperation |
You aren't authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys. |
UnknownParameter |
An unknown or unrecognized parameter was supplied. Requests that can cause this error include supplying a misspelled parameter or a parameter that isn't supported for the specified API version. |
UnsupportedInstanceAttribute |
The specified attribute can't be modified. |
UnsupportedOperation |
The specified request includes an unsupported operation. The returned message provides details of the unsupported operation. |
UnsupportedProtocol |
The protocol that you used is unsupported. |
ValidationError |
The input fails to satisfy the constraints specified by an AWS service. |
Client errors
Following, you can find a list of client errors that are specific to Amazon QuickSight API operations.
| Error code | Description |
|---|---|
| AccessDeniedException | You don't have access to this. The provided credentials can't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service and that your policies have the correct permissions. Also, ensure that you are using the correct access keys. |
| DomainNotWhiteListedException | The domain specified isn't on the allow list. Make sure that all domains for embedded dashboards are added to the approved list by an Amazon QuickSight administrator. |
| IdentityTypeNotSupportedException | The identity type specified isn't supported. Supported identity types include: IAM and QUICKSIGHT. |
| InvalidNextTokenException | The NextToken value isn't valid. |
| InvalidParameterValueException | One or more parameters doesn't have a valid value. |
| PreconditionNotMetException | One or more preconditions aren't met. |
| QuickSightUserNotFoundException | The user isn't found. This can happen in any operation that requires finding a user
based on the provided user name, such as DeleteUser,
DescribeUser, and so on. |
| ResourceExistsException | The resource specified doesn't exist. |
| ResourceNotFoundException | One or more resources couldn't be found. |
| SessionLifetimeInMinutesInvalidException | The number of minutes specified for the lifetime of a session is invalid. The session lifetime must be 15–600 minutes. |
| ThrottlingException | Access is throttled. |
| UnsupportedUserEditionException | Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition. |
Common causes of client errors
There are a number of reasons that you might encounter an error while performing a request. Some errors can be prevented or easily solved by following these guidelines:
-
Specify the AWS account ID and namespace – Make sure that the relevant AWS account ID are provided with each request. The namespace must be set to
default. -
Allow for eventual consistency – Some errors are caused because a previous request hasn't yet propagated through the system.
-
Use a sleep interval between request rates – Amazon QuickSight API requests are throttled to help maintain the performance of the service. If your requests have been throttled, you get an error.
-
Use the full ID of the resource – When specifying a resource, ensure that you use its full ID, and not its user-supplied name or description.
-
Check your services – Ensure that you have signed up for all the services you are attempting to use. You can check which services you're signed up for by going to the My Account section of the AWS home page
. -
Check your permissions – Ensure that you have the required permissions to carry out the request.
-
Check your VPC – Some resources can't be shared between virtual private clouds (VPCs), for example security groups.
-
Check your credentials – Ensure that you provide your access keys when you are making requests and that you have entered the credentials correctly. Also, if you have more than one account, ensure that you are using the correct credentials for a particular account. If the provided credentials are incorrect, you might get the following error:
Client.AuthFailure.
Server errors
Following, you can find a list of errors that can be returned by the server.
| Error code | Description |
|---|---|
| BatchClientRequestTokensNotDistinctException | The batch client request tokens aren't unique. |
| EmptyBatchRequestException | The batch request was empty. |
| InternalFailureException | An internal failure occurred. |
| InternalServiceError | There was an internal error from the service. |
| InvalidBatchClientRequestTokenException | The AWS request token for this client batch request is invalid. |
| InvalidParameterException | One or more parameters has a value that isn't valid. |
| LimitExceededException | A limit is exceeded. |
| ResourceUnavailableException | This resource is currently unavailable. |
| TooManyEntriesInBatchRequestException | There are too many entries in this batch request. |
