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

ListBrands

Lists all brands in an Amazon QuickSight account.

Request Syntax


GET /accounts/AwsAccountId/brands?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 owns the brands that you want to list.

Length Constraints: Fixed length of 12.

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

Required: Yes

MaxResults

The maximum number of results to be returned in a single request.

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

NextToken

The token for the next set of results, or null if there are no more results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Brands": [ 
      { 
         "Arn": "string",
         "BrandId": "string",
         "BrandName": "string",
         "BrandStatus": "string",
         "CreatedTime": number,
         "Description": "string",
         "LastUpdatedTime": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Brands

A list of all brands in your AWS account. This structure provides basic information about each brand.

Type: Array of BrandSummary objects

NextToken

The token for the next set of results, or null if there are no more results.

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

InternalServerException

An internal service exception.

HTTP Status Code: 500

InvalidRequestException

You don't have this feature activated for your account. To fix this issue, contact AWS support.

HTTP Status Code: 400

ThrottlingException

Access is throttled.

HTTP Status Code: 429