Amazon QuickSight Quicksight Customizations API

openapi: 3.1.0
info:
  title: Amazon QuickSight Customizations API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 4 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}/customizations:
    post:
      operationId: CreateAccountCustomization
      summary: Create Account Customization
      description: Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization
        or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight
        sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You
        can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace
        instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services
        account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use
        the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share
        the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even
        if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions
        API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountCustomizationResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountCustomizationRequest'
      tags:
      - Customizations
    delete:
      operationId: DeleteAccountCustomization
      summary: Delete Account Customization
      description: 'This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account
        and namespace. When you delete account customizations: All customizations are removed including themes, branding,
        and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after
        customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you
        may want to recreate. Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account
        and Quick Sight namespace.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAccountCustomizationResponse'
        '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: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAccountCustomizationRequest'
      tags:
      - Customizations
    get:
      operationId: DescribeAccountCustomization
      summary: Describe Account Customization
      description: Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick
        Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with
        the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize
        the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at
        the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services
        Services. When you subscribe to Quick Sight, you choose one Amazon Web Services Region to use as your home Region.
        That's where your free SPICE capacity is located. You can use Quick Sight in any supported Amazon Web Services Region.
        Amazon Web Services Region - You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user
        directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to
        Quick Sight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a
        different Amazon Web Services Region, you change y
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAccountCustomizationResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAccountCustomizationRequest'
      tags:
      - Customizations
    put:
      operationId: UpdateAccountCustomization
      summary: Update Account Customization
      description: Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme.
        You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight
        namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services
        account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAccountCustomizationResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountCustomizationRequest'
      tags:
      - Customizations
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.
    AccountCustomization:
      type: object
      properties:
        DefaultTheme:
          type: string
          description: The default theme for this Quick Sight subscription.
        DefaultEmailCustomizationTemplate:
          type: string
          description: The default email customization template.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    CreateAccountCustomizationRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to customize Quick Sight for.
        Namespace:
          type: string
          description: The Quick Sight namespace that you want to add customizations to.
        AccountCustomization:
          $ref: '#/components/schemas/AccountCustomization'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of the tags that you want to attach to this resource.
      required:
      - AwsAccountId
      - AccountCustomization
    CreateAccountCustomizationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services
            account.
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to customize Quick Sight for.
        Namespace:
          type: string
          description: The namespace associated with the customization you're creating.
        AccountCustomization:
          $ref: '#/components/schemas/AccountCustomization'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DeleteAccountCustomizationRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to delete Quick Sight customizations from.
        Namespace:
          type: string
          description: The Quick Sight namespace that you're deleting the customizations from.
      required:
      - AwsAccountId
    DeleteAccountCustomizationResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeAccountCustomizationRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to describe Quick Sight customizations for.
        Namespace:
          type: string
          description: The Quick Sight namespace that you want to describe Quick Sight customizations for.
        Resolved:
          type: boolean
          description: The Resolved flag works with the other parameters to determine which view of Quick Sight customizations
            is returned. You can add this flag to your command to use the same view that Quick Sight uses to identify which
            customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that
            are configured at different levels.
      required:
      - AwsAccountId
    DescribeAccountCustomizationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services
            account.
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you're describing.
        Namespace:
          type: string
          description: The Quick Sight namespace that you're describing.
        AccountCustomization:
          $ref: '#/components/schemas/AccountCustomization'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidParameterValueException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    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.
    ResourceUnavailableException:
      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.
    UpdateAccountCustomizationRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to update Quick Sight customizations for.
        Namespace:
          type: string
          description: The namespace that you want to update Quick Sight customizations for.
        AccountCustomization:
          $ref: '#/components/schemas/AccountCustomization'
      required:
      - AwsAccountId
      - AccountCustomization
    UpdateAccountCustomizationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to update Quick Sight customizations for.
        Namespace:
          type: string
          description: The namespace associated with the customization that you're updating.
        AccountCustomization:
          $ref: '#/components/schemas/AccountCustomization'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
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)