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-tags-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 Tags API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 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://qbusiness.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Tags
paths:
  /v1/tags/{resourceARN}:
    get:
      operationId: ListTagsForResource
      summary: List Tags For Resource
      description: Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTagsForResourceResponse'
        '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/ListTagsForResourceRequest'
      tags:
      - Tags
    post:
      operationId: TagResource
      summary: Tag Resource
      description: Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '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/TagResourceRequest'
      tags:
      - Tags
    delete:
      operationId: UntagResource
      summary: Untag Resource
      description: Removes a tag from an Amazon Q Business application or a data source.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '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/UntagResourceRequest'
      tags:
      - Tags
  /tags/{resourceArn}:
    get:
      operationId: getTagsByResourceArn
      summary: List Tags For Resource
      description: Lists the tags for the specified resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomListTagsForResourceResponse'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WisdomListTagsForResourceRequest'
      tags:
      - Tags
      servers:
      - url: https://wisdom.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_wisdom: []
      x-operation-id-source: normalized
      x-operation-id-original: ListTagsForResource
    post:
      operationId: postTagsByResourceArn
      summary: Tag Resource
      description: Adds the specified tags to the specified resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResourceResponse'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
        '400':
          description: TooManyTagsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyTagsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WisdomTagResourceRequest'
      tags:
      - Tags
      servers:
      - url: https://wisdom.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_wisdom: []
      x-operation-id-source: normalized
      x-operation-id-original: TagResource
    delete:
      operationId: deleteTagsByResourceArn
      summary: Untag Resource
      description: Removes the specified tags from the specified resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UntagResourceResponse'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WisdomResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WisdomUntagResourceRequest'
      tags:
      - Tags
      servers:
      - url: https://wisdom.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_wisdom: []
      x-operation-id-source: normalized
      x-operation-id-original: UntagResource
components:
  schemas:
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
        value:
          type: string
          description: The value associated with the tag. The value may be an empty string but it can't be null.
      required:
      - key
      - value
    WisdomListTagsForResourceResponse:
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
    TagResourceRequest:
      type: object
      properties:
        resourceARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.
      required:
      - resourceARN
      - tags
    WisdomListTagsForResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource.
      required:
      - resourceArn
    TooManyTagsException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    ListTagsForResourceRequest:
      type: object
      properties:
        resourceARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
      required:
      - resourceARN
    WisdomResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The specified resource name.
    TagResourceResponse:
      type: object
      properties: {}
    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
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    WisdomUntagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource.
        tagKeys:
          type: array
          items:
            type: string
          description: The tag keys.
      required:
      - resourceArn
      - tagKeys
    WisdomTagResourceRequest:
      type: object
      properties:
        resourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - resourceArn
      - tags
    UntagResourceResponse:
      type: object
      properties: {}
    UntagResourceRequest:
      type: object
      properties:
        resourceARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
        tagKeys:
          type: array
          items:
            type: string
          description: A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.
      required:
      - resourceARN
      - tagKeys
    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
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListTagsForResourceResponse:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags associated with the Amazon Q Business application or data source.
    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
    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
  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
    sigv4_wisdom:
      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: wisdom
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)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json
  - https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qconnect/service/2020-10-19/qconnect-2020-10-19.json