Amazon QuickSight

Amazon QuickSight Quicksight Custom Permission API

The Quicksight Custom Permission API from Amazon QuickSight — 3 operation(s) for quicksight custom permission.

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 8

DELETE /accounts/{AwsAccountId}/custom-permission Delete Account Custom Permission #

GET /accounts/{AwsAccountId}/custom-permission Describe Account Custom Permission #

PUT /accounts/{AwsAccountId}/custom-permission Update Account Custom Permission #

DELETE /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission Delete Role Custom Permission #

GET /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission Describe Role Custom Permission #

PUT /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission Update Role Custom Permission #

DELETE /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission Delete User Custom Permission #

PUT /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission Update User Custom Permission #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-custom-permission-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-custom-permission-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

openapi: 3.1.0
info:
  title: Amazon QuickSight Custom Permission API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 8 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}/custom-permission:
    delete:
      operationId: DeleteAccountCustomPermission
      summary: Delete Account Custom Permission
      description: Unapplies a custom permissions profile from an account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAccountCustomPermissionResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAccountCustomPermissionRequest'
      tags:
      - Custom Permission
    get:
      operationId: DescribeAccountCustomPermission
      summary: Describe Account Custom Permission
      description: Describes the custom permissions profile that is applied to an account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAccountCustomPermissionResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAccountCustomPermissionRequest'
      tags:
      - Custom Permission
    put:
      operationId: UpdateAccountCustomPermission
      summary: Update Account Custom Permission
      description: Applies a custom permissions profile to an account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAccountCustomPermissionResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountCustomPermissionRequest'
      tags:
      - Custom Permission
  /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission:
    delete:
      operationId: DeleteRoleCustomPermission
      summary: Delete Role Custom Permission
      description: Removes custom permissions from the role.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRoleCustomPermissionResponse'
        '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; 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/DeleteRoleCustomPermissionRequest'
      tags:
      - Custom Permission
    get:
      operationId: DescribeRoleCustomPermission
      summary: Describe Role Custom Permission
      description: Describes all custom permissions that are mapped to a role.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRoleCustomPermissionResponse'
        '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; 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/DescribeRoleCustomPermissionRequest'
      tags:
      - Custom Permission
    put:
      operationId: UpdateRoleCustomPermission
      summary: Update Role Custom Permission
      description: Updates the custom permissions that are associated with a role.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRoleCustomPermissionResponse'
        '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; 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/UpdateRoleCustomPermissionRequest'
      tags:
      - Custom Permission
  /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/custom-permission:
    delete:
      operationId: DeleteUserCustomPermission
      summary: Delete User Custom Permission
      description: Deletes a custom permissions profile from a user.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserCustomPermissionResponse'
        '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; 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/DeleteUserCustomPermissionRequest'
      tags:
      - Custom Permission
    put:
      operationId: UpdateUserCustomPermission
      summary: Update User Custom Permission
      description: Updates a custom permissions profile for a user.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUserCustomPermissionResponse'
        '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; 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/UpdateUserCustomPermissionRequest'
      tags:
      - Custom Permission
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.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    DeleteAccountCustomPermissionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account from which you want to unapply the custom permissions profile.
      required:
      - AwsAccountId
    DeleteAccountCustomPermissionResponse:
      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.
    DeleteRoleCustomPermissionRequest:
      type: object
      properties:
        Role:
          type: string
          enum:
          - ADMIN
          - AUTHOR
          - READER
          - ADMIN_PRO
          - AUTHOR_PRO
          - READER_PRO
          description: The role that you want to remove permissions from.
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
            Amazon Web Services account that contains your Amazon Quick Sight account.
        Namespace:
          type: string
          description: The namespace that includes the role.
      required:
      - Role
      - AwsAccountId
      - Namespace
    DeleteRoleCustomPermissionResponse:
      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.
    DeleteUserCustomPermissionRequest:
      type: object
      properties:
        UserName:
          type: string
          description: The username of the user that you want to remove custom permissions from.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the custom permission configuration that you
            want to delete.
        Namespace:
          type: string
          description: The namespace that the user belongs to.
      required:
      - UserName
      - AwsAccountId
      - Namespace
    DeleteUserCustomPermissionResponse:
      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.
    DescribeAccountCustomPermissionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account for which you want to describe the applied custom permissions
            profile.
      required:
      - AwsAccountId
    DescribeAccountCustomPermissionResponse:
      type: object
      properties:
        CustomPermissionsName:
          type: string
          description: The name of the custom permissions profile.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeRoleCustomPermissionRequest:
      type: object
      properties:
        Role:
          type: string
          enum:
          - ADMIN
          - AUTHOR
          - READER
          - ADMIN_PRO
          - AUTHOR_PRO
          - READER_PRO
          description: The name of the role whose permissions you want described.
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services
            account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight
            account.
        Namespace:
          type: string
          description: The namespace that contains the role.
      required:
      - Role
      - AwsAccountId
      - Namespace
    DescribeRoleCustomPermissionResponse:
      type: object
      properties:
        CustomPermissionsName:
          type: string
          description: The name of the custom permission that is described.
        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.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateAccountCustomPermissionRequest:
      type: object
      properties:
        CustomPermissionsName:
          type: string
          description: The name of the custom permissions profile that you want to apply to an account.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account for which you want to apply a custom permissions profile.
      required:
      - CustomPermissionsName
      - AwsAccountId
    UpdateAccountCustomPermissionResponse:
      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.
    UpdateRoleCustomPermissionRequest:
      type: object
      properties:
        CustomPermissionsName:
          type: string
          description: The name of the custom permission that you want to update the role with.
        Role:
          type: string
          enum:
          - ADMIN
          - AUTHOR
          - READER
          - ADMIN_PRO
          - AUTHOR_PRO
          - READER_PRO
          description: The name of role tht you want to update.
        AwsAccountId:
          type: string
          description: The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services
            account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight
            account.
        Namespace:
          type: string
          description: The namespace that contains the role that you want to update.
      required:
      - CustomPermissionsName
      - Role
      - AwsAccountId
      - Namespace
    UpdateRoleCustomPermissionResponse:
      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.
    UpdateUserCustomPermissionRequest:
      type: object
      properties:
        UserName:
          type: string
          description: The username of the user that you want to update custom permissions for.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the custom permission configuration that you
            want to update.
        Namespace:
          type: string
          description: The namespace that the user belongs to.
        CustomPermissionsName:
          type: string
          description: The name of the custom permissions that you want to update.
      required:
      - UserName
      - AwsAccountId
      - Namespace
      - CustomPermissionsName
    UpdateUserCustomPermissionResponse:
      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.
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)