Amazon QuickSight

Amazon QuickSight Quicksight Groups API

The Quicksight Groups API from Amazon QuickSight — 3 operation(s) for quicksight groups.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 6

POST /accounts/{AwsAccountId}/namespaces/{Namespace}/groups Create Group #
GET /accounts/{AwsAccountId}/namespaces/{Namespace}/groups List Groups #
DELETE /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} Delete Group #
GET /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} Describe Group #
PUT /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} Update Group #
GET /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups List User Groups #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-groups-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-groups-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-groups-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon QuickSight Groups API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 6 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}/namespaces/{Namespace}/groups:
    post:
      operationId: CreateGroup
      summary: Create Group
      description: Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a
        namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The
        permissions resource is arn:aws:quicksight:::group/default/ . The response is a group object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGroupResponse'
        '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'
        '409':
          description: LimitExceededException; ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '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/CreateGroupRequest'
      tags:
      - Groups
    get:
      operationId: ListGroups
      summary: List Groups
      description: Lists all user groups in Amazon Quick Sight.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroupsResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidNextTokenException; InvalidParameterValueException; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '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/ListGroupsRequest'
      tags:
      - Groups
  /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}:
    delete:
      operationId: DeleteGroup
      summary: Delete Group
      description: Removes a user group from Amazon Quick Sight.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteGroupResponse'
        '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/DeleteGroupRequest'
      tags:
      - Groups
    get:
      operationId: DescribeGroup
      summary: Describe Group
      description: Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeGroupResponse'
        '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/DescribeGroupRequest'
      tags:
      - Groups
    put:
      operationId: UpdateGroup
      summary: Update Group
      description: Changes a group description.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGroupResponse'
        '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/UpdateGroupRequest'
      tags:
      - Groups
  /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups:
    get:
      operationId: ListUserGroups
      summary: List User Groups
      description: Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUserGroupsResponse'
        '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/ListUserGroupsRequest'
      tags:
      - Groups
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.
    CreateGroupRequest:
      type: object
      properties:
        GroupName:
          type: string
          description: A name for the group that you want to create.
        Description:
          type: string
          description: A description for the group that you want to create.
        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 you want the group to be a part of.
      required:
      - GroupName
      - AwsAccountId
      - Namespace
    CreateGroupResponse:
      type: object
      properties:
        Group:
          $ref: '#/components/schemas/Group'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DeleteGroupRequest:
      type: object
      properties:
        GroupName:
          type: string
          description: The name of the group that you want to delete.
        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 of the group that you want to delete.
      required:
      - GroupName
      - AwsAccountId
      - Namespace
    DeleteGroupResponse:
      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.
    DescribeGroupRequest:
      type: object
      properties:
        GroupName:
          type: string
          description: The name of the group that you want to describe.
        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 of the group that you want described.
      required:
      - GroupName
      - AwsAccountId
      - Namespace
    DescribeGroupResponse:
      type: object
      properties:
        Group:
          $ref: '#/components/schemas/Group'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    Group:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the group.
        GroupName:
          type: string
          description: The name of the group.
        Description:
          type: string
          description: The group description.
        PrincipalId:
          type: string
          description: The principal ID of the group.
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidNextTokenException:
      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.
    LimitExceededException:
      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: Limit exceeded.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ListGroupsRequest:
      type: object
      properties:
        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.
        NextToken:
          type: string
          description: A pagination token that can be used in a subsequent request.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
        Namespace:
          type: string
          description: The namespace that you want a list of groups from.
      required:
      - AwsAccountId
      - Namespace
    ListGroupsResponse:
      type: object
      properties:
        GroupList:
          type: array
          items:
            $ref: '#/components/schemas/Group'
          description: The list of the groups.
        NextToken:
          type: string
          description: A pagination token that can be used in a subsequent request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    ListUserGroupsRequest:
      type: object
      properties:
        UserName:
          type: string
          description: The Amazon Quick Sight user name that you want to list group memberships for.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID that the user 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. Currently, you should set this to default.
        NextToken:
          type: string
          description: A pagination token that can be used in a subsequent request.
        MaxResults:
          type: integer
          description: The maximum number of results to return from this request.
      required:
      - UserName
      - AwsAccountId
      - Namespace
    ListUserGroupsResponse:
      type: object
      properties:
        GroupList:
          type: array
          items:
            $ref: '#/components/schemas/Group'
          description: The list of groups the user is a member of.
        NextToken:
          type: string
          description: A pagination token that can be used in a subsequent request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the 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.
    UpdateGroupRequest:
      type: object
      properties:
        GroupName:
          type: string
          description: The name of the group that you want to update.
        Description:
          type: string
          description: The description for the group that you want to update.
        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 of the group that you want to update.
      required:
      - GroupName
      - AwsAccountId
      - Namespace
    UpdateGroupResponse:
      type: object
      properties:
        Group:
          $ref: '#/components/schemas/Group'
        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)