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-dataaccessors-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 Dataaccessors API
  version: '2023-11-27'
  description: Generated from AWS's published Smithy model for QBusiness. 5 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: Dataaccessors
paths:
  /applications/{applicationId}/dataaccessors:
    post:
      operationId: CreateDataAccessor
      summary: Create Data Accessor
      description: Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataAccessorResponse'
        '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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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/CreateDataAccessorRequest'
      tags:
      - Dataaccessors
    get:
      operationId: ListDataAccessors
      summary: List Data Accessors
      description: Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataAccessorsResponse'
        '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/ListDataAccessorsRequest'
      tags:
      - Dataaccessors
  /applications/{applicationId}/dataaccessors/{dataAccessorId}:
    get:
      operationId: GetDataAccessor
      summary: Get Data Accessor
      description: Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataAccessorResponse'
        '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/GetDataAccessorRequest'
      tags:
      - Dataaccessors
    put:
      operationId: UpdateDataAccessor
      summary: Update Data Accessor
      description: Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDataAccessorResponse'
        '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/UpdateDataAccessorRequest'
      tags:
      - Dataaccessors
    delete:
      operationId: DeleteDataAccessor
      summary: Delete Data Accessor
      description: Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataAccessorResponse'
        '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/DeleteDataAccessorRequest'
      tags:
      - Dataaccessors
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
    DocumentAttribute:
      type: object
      properties:
        name:
          type: string
          description: The identifier for the attribute.
        value:
          $ref: '#/components/schemas/DocumentAttributeValue'
      required:
      - name
      - value
    ActionFilterConfiguration:
      type: object
      properties:
        documentAttributeFilter:
          $ref: '#/components/schemas/AttributeFilter'
      required:
      - documentAttributeFilter
    GetDataAccessorRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q Business application.
        dataAccessorId:
          type: string
          description: The unique identifier of the data accessor to retrieve.
      required:
      - applicationId
      - dataAccessorId
    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
    ActionConfiguration:
      type: object
      properties:
        action:
          type: string
          description: The Amazon Q Business action that is allowed.
        filterConfiguration:
          $ref: '#/components/schemas/ActionFilterConfiguration'
      required:
      - action
    DocumentAttributeValue:
      type: object
      properties:
        stringValue:
          type: string
          description: A string.
        stringListValue:
          type: array
          items:
            type: string
          description: A list of strings.
        longValue:
          type: integer
          description: A long integer value.
        dateValue:
          type: string
          format: date-time
          description: A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
      description: Exactly one member is set.
    DeleteDataAccessorRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q Business application.
        dataAccessorId:
          type: string
          description: The unique identifier of the data accessor to delete.
      required:
      - applicationId
      - dataAccessorId
    ListDataAccessorsResponse:
      type: object
      properties:
        dataAccessors:
          type: array
          items:
            $ref: '#/components/schemas/DataAccessor'
          description: The list of data accessors.
        nextToken:
          type: string
          description: The token to use to retrieve the next set of results, if there are any.
    AttributeFilter:
      type: object
      properties:
        andAllFilters:
          type: array
          items:
            $ref: '#/components/schemas/AttributeFilter'
          description: Performs a logical AND operation on all supplied filters.
        orAllFilters:
          type: array
          items:
            $ref: '#/components/schemas/AttributeFilter'
          description: Performs a logical OR operation on all supplied filters.
        notFilter:
          $ref: '#/components/schemas/AttributeFilter'
        equalsTo:
          $ref: '#/components/schemas/DocumentAttribute'
        containsAll:
          $ref: '#/components/schemas/DocumentAttribute'
        containsAny:
          $ref: '#/components/schemas/DocumentAttribute'
        greaterThan:
          $ref: '#/components/schemas/DocumentAttribute'
        greaterThanOrEquals:
          $ref: '#/components/schemas/DocumentAttribute'
        lessThan:
          $ref: '#/components/schemas/DocumentAttribute'
        lessThanOrEquals:
          $ref: '#/components/schemas/DocumentAttribute'
    DeleteDataAccessorResponse:
      type: object
      properties: {}
    CreateDataAccessorRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q Business application.
        principal:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.
        actionConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ActionConfiguration'
          description: A list of action configurations specifying the allowed actions and any associated filters.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier you provide to ensure idempotency of the request.
        displayName:
          type: string
          description: A friendly name for the data accessor.
        authenticationDetail:
          $ref: '#/components/schemas/DataAccessorAuthenticationDetail'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to associate with the data accessor.
      required:
      - applicationId
      - principal
      - actionConfigurations
      - displayName
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: The message describing a ServiceQuotaExceededException.
        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
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateDataAccessorRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q Business application.
        dataAccessorId:
          type: string
          description: The unique identifier of the data accessor to update.
        actionConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ActionConfiguration'
          description: The updated list of action configurations specifying the allowed actions and any associated filters.
        authenticationDetail:
          $ref: '#/components/schemas/DataAccessorAuthenticationDetail'
        displayName:
          type: string
          description: The updated friendly name for the data accessor.
      required:
      - applicationId
      - dataAccessorId
      - actionConfigurations
    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
    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
    GetDataAccessorResponse:
      type: object
      properties:
        displayName:
          type: string
          description: The friendly name of the data accessor.
        dataAccessorId:
          type: string
          description: The unique identifier of the data accessor.
        dataAccessorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data accessor.
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q Business application associated with this data accessor.
        idcApplicationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.
        principal:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
        actionConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ActionConfiguration'
          description: The list of action configurations specifying the allowed actions and any associated filters.
        authenticationDetail:
          $ref: '#/components/schemas/DataAccessorAuthenticationDetail'
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the data accessor was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the data accessor was last updated.
    DataAccessorIdcTrustedTokenIssuerConfiguration:
      type: object
      properties:
        idcTrustedTokenIssuerArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
      required:
      - idcTrustedTokenIssuerArn
    ListDataAccessorsRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the Amazon Q Business application.
        nextToken:
          type: string
          description: The token for the next set of results. (You received this token from a previous call.)
        maxResults:
          type: integer
          description: The maximum number of results to return in a single call.
      required:
      - applicationId
    CreateDataAccessorResponse:
      type: object
      properties:
        dataAccessorId:
          type: string
          description: The unique identifier of the created data accessor.
        idcApplicationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.
        dataAccessorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created data accessor.
      required:
      - dataAccessorId
      - idcApplicationArn
      - dataAccessorArn
    DataAccessorAuthenticationConfiguration:
      type: object
      properties:
        idcTrustedTokenIssuerConfiguration:
          $ref: '#/components/schemas/DataAccessorIdcTrustedTokenIssuerConfiguration'
      description: Exactly one member is set.
    DataAccessor:
      type: object
      properties:
        displayName:
          type: string
          description: The friendly name of the data accessor.
        dataAccessorId:
          type: string
          description: The unique identifier of the data accessor.
        dataAccessorArn:
          type: string
          description: The Amazon Resource Name (ARN) of the data accessor.
        idcApplicationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
        principal:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
        authenticationDetail:
          $ref: '#/components/schemas/DataAccessorAuthenticationDetail'
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the data accessor was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the data accessor was last updated.
    UpdateDataAccessorResponse:
      type: object
      properties: {}
    DataAccessorAuthenticationDetail:
      type: object
      properties:
        authenticationType:
          type: string
          enum:
          - AWS_IAM_IDC_TTI
          - AWS_IAM_IDC_AUTH_CODE
          description: 'The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.'
        authenticationConfiguration:
          $ref: '#/components/schemas/DataAccessorAuthenticationConfiguration'
        externalIds:
          type: array
          items:
            type: string
          description: A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.
      required:
      - authenticationType
  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)