Amazon QuickSight

Amazon QuickSight Quicksight Brands API

The Quicksight Brands API from Amazon QuickSight — 2 operation(s) for quicksight brands.

GitHub OpenAPI

Operations 5

POST /accounts/{AwsAccountId}/brands/{BrandId} Create Brand #
DELETE /accounts/{AwsAccountId}/brands/{BrandId} Delete Brand #
GET /accounts/{AwsAccountId}/brands/{BrandId} Describe Brand #
PUT /accounts/{AwsAccountId}/brands/{BrandId} Update Brand #
GET /accounts/{AwsAccountId}/brands List Brands #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-brands-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-brands-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-quicksight-brands-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon QuickSight Brands API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://quicksight.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /accounts/{AwsAccountId}/brands/{BrandId}:
    post:
      operationId: CreateBrand
      summary: Create Brand
      description: Creates an Quick Sight brand.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBrandResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandRequest'
      tags:
      - Brands
    delete:
      operationId: DeleteBrand
      summary: Delete Brand
      description: 'This API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all
        its associated branding elements are permanently removed Any applications or dashboards using this brand will revert
        to default styling This action cannot be undone through the API Before proceeding: Verify that the brand is no longer
        needed and consider the impact on any applications currently using this brand. Deletes an Quick Sight brand.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBrandResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBrandRequest'
      tags:
      - Brands
    get:
      operationId: DescribeBrand
      summary: Describe Brand
      description: Describes a brand.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBrandResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBrandRequest'
      tags:
      - Brands
    put:
      operationId: UpdateBrand
      summary: Update Brand
      description: Updates a brand.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBrandResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBrandRequest'
      tags:
      - Brands
  /accounts/{AwsAccountId}/brands:
    get:
      operationId: ListBrands
      summary: List Brands
      description: Lists all brands in an Quick Sight account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBrandsResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBrandsRequest'
      tags:
      - Brands
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: quicksight
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ApplicationTheme:
      type: object
      properties:
        BrandColorPalette:
          $ref: '#/components/schemas/BrandColorPalette'
        ContextualAccentPalette:
          $ref: '#/components/schemas/ContextualAccentPalette'
        BrandElementStyle:
          $ref: '#/components/schemas/BrandElementStyle'
    BrandColorPalette:
      type: object
      properties:
        Primary:
          $ref: '#/components/schemas/Palette'
        Secondary:
          $ref: '#/components/schemas/Palette'
        Accent:
          $ref: '#/components/schemas/Palette'
        Measure:
          $ref: '#/components/schemas/Palette'
        Dimension:
          $ref: '#/components/schemas/Palette'
        Success:
          $ref: '#/components/schemas/Palette'
        Info:
          $ref: '#/components/schemas/Palette'
        Warning:
          $ref: '#/components/schemas/Palette'
        Danger:
          $ref: '#/components/schemas/Palette'
    BrandDefinition:
      type: object
      properties:
        BrandName:
          type: string
          description: The name of the brand.
        Description:
          type: string
          description: The description of the brand.
        ApplicationTheme:
          $ref: '#/components/schemas/ApplicationTheme'
        LogoConfiguration:
          $ref: '#/components/schemas/LogoConfiguration'
      required:
      - BrandName
    BrandDetail:
      type: object
      properties:
        BrandId:
          type: string
          description: The ID of the Quick brand.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the brand.
        BrandStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_SUCCEEDED
          - CREATE_FAILED
          - DELETE_IN_PROGRESS
          - DELETE_FAILED
          description: The status of the brand.
        CreatedTime:
          type: string
          description: The time that the brand was created.
        LastUpdatedTime:
          type: string
          description: The last time the brand was updated.
        VersionId:
          type: string
          description: The ID of the version.
        VersionStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_SUCCEEDED
          - CREATE_FAILED
          description: The status of the version.
        Errors:
          type: array
          items:
            type: string
          description: A list of errors that occurred during the most recent brand operation.
        Logo:
          $ref: '#/components/schemas/Logo'
      required:
      - BrandId
    BrandElementStyle:
      type: object
      properties:
        NavbarStyle:
          $ref: '#/components/schemas/NavbarStyle'
    BrandSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the brand.
        BrandId:
          type: string
          description: The ID of the Quick brand.
        BrandName:
          type: string
          description: The name of the brand.
        Description:
          type: string
          description: The description of the brand.
        BrandStatus:
          type: string
          enum:
          - CREATE_IN_PROGRESS
          - CREATE_SUCCEEDED
          - CREATE_FAILED
          - DELETE_IN_PROGRESS
          - DELETE_FAILED
          description: The status of the brand.
        CreatedTime:
          type: string
          description: The time that the brand was created.
        LastUpdatedTime:
          type: string
          description: The time when the brand was last updated.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ContextualAccentPalette:
      type: object
      properties:
        Connection:
          $ref: '#/components/schemas/Palette'
        Visualization:
          $ref: '#/components/schemas/Palette'
        Insight:
          $ref: '#/components/schemas/Palette'
        Automation:
          $ref: '#/components/schemas/Palette'
    CreateBrandRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the brand.
        BrandId:
          type: string
          description: The ID of the Quick brand.
        BrandDefinition:
          $ref: '#/components/schemas/BrandDefinition'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A map of the key-value pairs that are assigned to the brand.
      required:
      - AwsAccountId
      - BrandId
    CreateBrandResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        BrandDetail:
          $ref: '#/components/schemas/BrandDetail'
        BrandDefinition:
          $ref: '#/components/schemas/BrandDefinition'
    DeleteBrandRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the brand.
        BrandId:
          type: string
          description: The ID of the Quick brand.
      required:
      - AwsAccountId
      - BrandId
    DeleteBrandResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
    DescribeBrandRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the brand.
        BrandId:
          type: string
          description: The ID of the Quick brand.
        VersionId:
          type: string
          description: The ID of the specific version. The default value is the latest version.
      required:
      - AwsAccountId
      - BrandId
    DescribeBrandResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        BrandDetail:
          $ref: '#/components/schemas/BrandDetail'
        BrandDefinition:
          $ref: '#/components/schemas/BrandDefinition'
    Image:
      type: object
      properties:
        Source:
          $ref: '#/components/schemas/ImageSource'
        GeneratedImageUrl:
          type: string
          description: The URL that points to the generated logo image.
    ImageConfiguration:
      type: object
      properties:
        Source:
          $ref: '#/components/schemas/ImageSource'
    ImageSet:
      type: object
      properties:
        Original:
          $ref: '#/components/schemas/Image'
        Height64:
          $ref: '#/components/schemas/Image'
        Height32:
          $ref: '#/components/schemas/Image'
      required:
      - Original
    ImageSetConfiguration:
      type: object
      properties:
        Original:
          $ref: '#/components/schemas/ImageConfiguration'
      required:
      - Original
    ImageSource:
      type: object
      properties:
        PublicUrl:
          type: string
          description: The public URL that points to the source image.
        S3Uri:
          type: string
          description: The Amazon S3 URI that points to the source image.
      description: Exactly one member is set.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ListBrandsRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the brands that you want to list.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned in a single request.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
      required:
      - AwsAccountId
    ListBrandsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        Brands:
          type: array
          items:
            $ref: '#/components/schemas/BrandSummary'
          description: A list of all brands in your Amazon Web Services account. This structure provides basic information
            about each brand.
    Logo:
      type: object
      properties:
        AltText:
          type: string
          description: The alt text for the logo.
        LogoSet:
          $ref: '#/components/schemas/LogoSet'
      required:
      - AltText
      - LogoSet
    LogoConfiguration:
      type: object
      properties:
        AltText:
          type: string
          description: The alt text for the logo.
        LogoSet:
          $ref: '#/components/schemas/LogoSetConfiguration'
      required:
      - AltText
      - LogoSet
    LogoSet:
      type: object
      properties:
        Primary:
          $ref: '#/components/schemas/ImageSet'
        Favicon:
          $ref: '#/components/schemas/ImageSet'
      required:
      - Primary
    LogoSetConfiguration:
      type: object
      properties:
        Primary:
          $ref: '#/components/schemas/ImageSetConfiguration'
        Favicon:
          $ref: '#/components/schemas/ImageSetConfiguration'
      required:
      - Primary
    NavbarStyle:
      type: object
      properties:
        GlobalNavbar:
          $ref: '#/components/schemas/Palette'
        ContextualNavbar:
          $ref: '#/components/schemas/Palette'
    Palette:
      type: object
      properties:
        Foreground:
          type: string
          description: The foreground color.
        Background:
          type: string
          description: The background color.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - USER
          - GROUP
          - NAMESPACE
          - ACCOUNT_SETTINGS
          - IAMPOLICY_ASSIGNMENT
          - DATA_SOURCE
          - DATA_SET
          - VPC_CONNECTION
          - INGESTION
          description: The resource type for this request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Tag key.
        Value:
          type: string
          description: Tag value.
      required:
      - Key
      - Value
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateBrandRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the brand.
        BrandId:
          type: string
          description: The ID of the Quick brand.
        BrandDefinition:
          $ref: '#/components/schemas/BrandDefinition'
      required:
      - AwsAccountId
      - BrandId
    UpdateBrandResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        BrandDetail:
          $ref: '#/components/schemas/BrandDetail'
        BrandDefinition:
          $ref: '#/components/schemas/BrandDefinition'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/quicksight/service/2018-04-01/quicksight-2018-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)