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-q:amazon-q-subscriptions-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.2.0
info:
  title: QBusiness Subscriptions API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 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://qbusiness.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Subscriptions
paths:
  /applications/{applicationId}/subscriptions/{subscriptionId}:
    delete:
      operationId: CancelSubscription
      summary: Cancel Subscription
      description: Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelSubscriptionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSubscriptionRequest'
      tags:
      - Subscriptions
    put:
      operationId: UpdateSubscription
      summary: Update Subscription
      description: Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubscriptionResponse'
        '403':
          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'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionRequest'
      tags:
      - Subscriptions
  /applications/{applicationId}/subscriptions:
    post:
      operationId: CreateSubscription
      summary: Create Subscription
      description: 'Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionResponse'
        '403':
          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'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionRequest'
      tags:
      - Subscriptions
    get:
      operationId: ListSubscriptions
      summary: List Subscriptions
      description: Lists all subscriptions created in an Amazon Q Business application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionsResponse'
        '403':
          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'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSubscriptionsRequest'
      tags:
      - Subscriptions
components:
  schemas:
    CreateSubscriptionRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application the subscription should be added to.
        principal:
          $ref: '#/components/schemas/SubscriptionPrincipal'
        type:
          type: string
          enum:
          - Q_LITE
          - Q_BUSINESS
          description: The type of Amazon Q Business subscription you want to create.
        clientToken:
          type: string
          description: A token that you provide to identify the request to create a subscription for your Amazon Q Business application.
      required:
      - applicationId
      - principal
      - type
    Subscription:
      type: object
      properties:
        subscriptionId:
          type: string
          description: The identifier of the Amazon Q Business subscription to be updated.
        subscriptionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.
        principal:
          $ref: '#/components/schemas/SubscriptionPrincipal'
        currentSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
        nextSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
    ListSubscriptionsResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: An array of summary information on the subscriptions configured for an Amazon Q Business application.
    CreateSubscriptionResponse:
      type: object
      properties:
        subscriptionId:
          type: string
          description: The identifier of the Amazon Q Business subscription created.
        subscriptionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.
        currentSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
        nextSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
    UpdateSubscriptionResponse:
      type: object
      properties:
        subscriptionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.
        currentSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
        nextSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
    CancelSubscriptionRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application for which the subscription is being cancelled.
        subscriptionId:
          type: string
          description: The identifier of the Amazon Q Business subscription being cancelled.
      required:
      - applicationId
      - subscriptionId
    SubscriptionPrincipal:
      type: object
      properties:
        user:
          type: string
          description: The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.
        group:
          type: string
          description: The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.
      description: Exactly one member is set.
    SubscriptionDetails:
      type: object
      properties:
        type:
          type: string
          enum:
          - Q_LITE
          - Q_BUSINESS
          description: The type of an Amazon Q Business subscription.
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ConflictException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The field name where the invalid entry was detected.
        message:
          type: string
          description: A message about the validation exception.
      required:
      - name
      - message
    UpdateSubscriptionRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application where the subscription update should take effect.
        subscriptionId:
          type: string
          description: The identifier of the Amazon Q Business subscription to be updated.
        type:
          type: string
          enum:
          - Q_LITE
          - Q_BUSINESS
          description: The type of the Amazon Q Business subscription to be updated.
      required:
      - applicationId
      - subscriptionId
      - type
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ResourceNotFoundException.
        resourceId:
          type: string
          description: The identifier of the resource affected.
        resourceType:
          type: string
          description: The type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CancelSubscriptionResponse:
      type: object
      properties:
        subscriptionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.
        currentSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
        nextSubscription:
          $ref: '#/components/schemas/SubscriptionDetails'
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: The message describing the ValidationException.
        reason:
          type: string
          enum:
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - UNKNOWN_OPERATION
          description: The reason for the ValidationException.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The input field(s) that failed validation.
      required:
      - message
      - reason
    ListSubscriptionsRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application linked to the subscription.
        nextToken:
          type: string
          description: If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.
        maxResults:
          type: integer
          description: The maximum number of Amazon Q Business subscriptions to return.
      required:
      - applicationId
  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: qbusiness
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)