Amazon Q Q Experiences API

openapi: 3.2.0
info:
  title: QBusiness Experiences 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: Experiences
paths:
  /applications/{applicationId}/experiences:
    post:
      operationId: CreateWebExperience
      summary: Create Web Experience
      description: Creates an Amazon Q Business web experience.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebExperienceResponse'
        '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/CreateWebExperienceRequest'
      tags:
      - Experiences
    get:
      operationId: ListWebExperiences
      summary: List Web Experiences
      description: Lists one or more Amazon Q Business Web Experiences.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebExperiencesResponse'
        '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/ListWebExperiencesRequest'
      tags:
      - Experiences
  /applications/{applicationId}/experiences/{webExperienceId}:
    get:
      operationId: GetWebExperience
      summary: Get Web Experience
      description: Gets information about an existing Amazon Q Business web experience.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebExperienceResponse'
        '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/GetWebExperienceRequest'
      tags:
      - Experiences
    put:
      operationId: UpdateWebExperience
      summary: Update Web Experience
      description: Updates an Amazon Q Business web experience.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWebExperienceResponse'
        '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/UpdateWebExperienceRequest'
      tags:
      - Experiences
    delete:
      operationId: DeleteWebExperience
      summary: Delete Web Experience
      description: Deletes an Amazon Q Business web experience.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWebExperienceResponse'
        '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/DeleteWebExperienceRequest'
      tags:
      - Experiences
components:
  schemas:
    CreateWebExperienceResponse:
      type: object
      properties:
        webExperienceId:
          type: string
          description: The identifier of the Amazon Q Business web experience.
        webExperienceArn:
          type: string
          description: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
    DeleteWebExperienceResponse:
      type: object
      properties: {}
    ErrorDetail:
      type: object
      properties:
        errorMessage:
          type: string
          description: The message explaining the Amazon Q Business request error.
        errorCode:
          type: string
          enum:
          - InternalError
          - InvalidRequest
          - ResourceInactive
          - ResourceNotFound
          description: The code associated with the Amazon Q Business request error.
    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
    IdentityProviderConfiguration:
      type: object
      properties:
        samlConfiguration:
          $ref: '#/components/schemas/SamlProviderConfiguration'
        openIDConnectConfiguration:
          $ref: '#/components/schemas/OpenIDConnectProviderConfiguration'
      description: Exactly one member is set.
    CreateWebExperienceRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business web experience.
        title:
          type: string
          description: The title for your Amazon Q Business web experience.
        subtitle:
          type: string
          description: A subtitle to personalize your Amazon Q Business web experience.
        welcomeMessage:
          type: string
          description: The customized welcome message for end users of an Amazon Q Business web experience.
        samplePromptsControlMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Determines whether sample prompts are enabled in the web experience for an end user.
        origins:
          type: array
          items:
            type: string
          description: Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified). You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the service role attached to your web experience. The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.'
        clientToken:
          type: string
          description: A token you provide to identify a request to create an Amazon Q Business web experience.
        identityProviderConfiguration:
          $ref: '#/components/schemas/IdentityProviderConfiguration'
        browserExtensionConfiguration:
          $ref: '#/components/schemas/BrowserExtensionConfiguration'
        customizationConfiguration:
          $ref: '#/components/schemas/CustomizationConfiguration'
      required:
      - applicationId
    UpdateWebExperienceRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application attached to the web experience.
        webExperienceId:
          type: string
          description: The identifier of the Amazon Q Business web experience.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
        authenticationConfiguration:
          $ref: '#/components/schemas/WebExperienceAuthConfiguration'
        title:
          type: string
          description: The title of the Amazon Q Business web experience.
        subtitle:
          type: string
          description: The subtitle of the Amazon Q Business web experience.
        welcomeMessage:
          type: string
          description: A customized welcome message for an end user in an Amazon Q Business web experience.
        samplePromptsControlMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Determines whether sample prompts are enabled in the web experience for an end user.
        identityProviderConfiguration:
          $ref: '#/components/schemas/IdentityProviderConfiguration'
        origins:
          type: array
          items:
            type: string
          description: Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified). Any values except null submitted as part of this update will replace all previous values. You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
        browserExtensionConfiguration:
          $ref: '#/components/schemas/BrowserExtensionConfiguration'
        customizationConfiguration:
          $ref: '#/components/schemas/CustomizationConfiguration'
      required:
      - applicationId
      - webExperienceId
    UpdateWebExperienceResponse:
      type: object
      properties: {}
    WebExperienceAuthConfiguration:
      type: object
      properties:
        samlConfiguration:
          $ref: '#/components/schemas/SamlConfiguration'
      description: Exactly one member is set.
    GetWebExperienceRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application linked to the web experience.
        webExperienceId:
          type: string
          description: The identifier of the Amazon Q Business web experience.
      required:
      - applicationId
      - webExperienceId
    BrowserExtensionConfiguration:
      type: object
      properties:
        enabledBrowserExtensions:
          type: array
          items:
            type: string
          description: Specify the browser extensions allowed for your Amazon Q web experience. CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.). FIREFOX — Enables the extension for Mozilla Firefox. CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
      required:
      - enabledBrowserExtensions
    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
    GetWebExperienceResponse:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application linked to the web experience.
        webExperienceId:
          type: string
          description: The identifier of the Amazon Q Business web experience.
        webExperienceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
        defaultEndpoint:
          type: string
          description: The endpoint of your Amazon Q Business web experience.
        status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          - PENDING_AUTH_CONFIG
          description: The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp when the Amazon Q Business web experience was last created.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the Amazon Q Business web experience was last updated.
        title:
          type: string
          description: The title for your Amazon Q Business web experience.
        subtitle:
          type: string
          description: The subtitle for your Amazon Q Business web experience.
        welcomeMessage:
          type: string
          description: The customized welcome message for end users of an Amazon Q Business web experience.
        samplePromptsControlMode:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Determines whether sample prompts are enabled in the web experience for an end user.
        origins:
          type: array
          items:
            type: string
          description: Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the service role attached to your web experience.
        identityProviderConfiguration:
          $ref: '#/components/schemas/IdentityProviderConfiguration'
        authenticationConfiguration:
          $ref: '#/components/schemas/WebExperienceAuthConfiguration'
        error:
          $ref: '#/components/schemas/ErrorDetail'
        browserExtensionConfiguration:
          $ref: '#/components/schemas/BrowserExtensionConfiguration'
        customizationConfiguration:
          $ref: '#/components/schemas/CustomizationConfiguration'
    ListWebExperiencesResponse:
      type: object
      properties:
        webExperiences:
          type: array
          items:
            $ref: '#/components/schemas/WebExperience'
          description: An array of summary information for one or more Amazon Q Business experiences.
        nextToken:
          type: string
          description: If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
    DeleteWebExperienceRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
        webExperienceId:
          type: string
          description: The identifier of the Amazon Q Business web experience being deleted.
      required:
      - applicationId
      - webExperienceId
    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
    SamlProviderConfiguration:
      type: object
      properties:
        authenticationUrl:
          type: string
          description: The URL where Amazon Q Business end users will be redirected for authentication.
      required:
      - authenticationUrl
    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
    WebExperience:
      type: object
      properties:
        webExperienceId:
          type: string
          description: The identifier of your Amazon Q Business web experience.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp when the Amazon Q Business application was last updated.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when your Amazon Q Business web experience was updated.
        defaultEndpoint:
          type: string
          description: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
        status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - FAILED
          - PENDING_AUTH_CONFIG
          description: The status of your Amazon Q Business web experience.
    OpenIDConnectProviderConfiguration:
      type: object
      properties:
        secretsArn:
          type: string
          description: The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
        secretsRole:
          type: string
          description: An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
      required:
      - secretsArn
      - secretsRole
    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
    SamlConfiguration:
      type: object
      properties:
        metadataXML:
          type: string
          description: The metadata XML that your IdP generated.
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
        userIdAttribute:
          type: string
          description: The user attribute name in your IdP that maps to the user email.
        userGroupAttribute:
          type: string
          description: The group attribute name in your IdP that maps to user groups.
      required:
      - metadataXML
      - roleArn
      - userIdAttribute
    CustomizationConfiguration:
      type: object
      properties:
        customCSSUrl:
          type: string
          description: Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
        logoUrl:
          type: string
          description: Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
        fontUrl:
          type: string
          description: Provides the URL where the custom font file is hosted for an Amazon Q web experience.
        faviconUrl:
          type: string
          description: Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
    ListWebExperiencesRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The identifier of the Amazon Q Business application linked to the listed web experiences.
        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 conversations.
        maxResults:
          type: integer
          description: The maximum number of Amazon Q Business Web Experiences 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)