Amazon Q Q Attachments API
The Q Attachments API from Amazon Q — 4 operation(s) for q attachments.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-q:amazon-q-attachments-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: QBusiness Attachments 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: Attachments
paths:
/applications/{applicationId}/conversations/{conversationId}/attachments/{attachmentId}:
delete:
operationId: DeleteAttachment
summary: Delete Attachment
description: Deletes an attachment associated with a specific Amazon Q Business conversation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAttachmentResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'400':
description: LicenseNotFoundException; ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/LicenseNotFoundException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAttachmentRequest'
tags:
- Attachments
/applications/{applicationId}/attachments:
get:
operationId: ListAttachments
summary: List Attachments
description: Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAttachmentsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'400':
description: LicenseNotFoundException; ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/LicenseNotFoundException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAttachmentsRequest'
tags:
- Attachments
/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/attachments:
post:
operationId: CreateMessageTemplateAttachment
summary: Create Message Template Attachment
description: Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMessageTemplateAttachmentResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomServiceQuotaExceededException'
'400':
description: ThrottlingException; ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomThrottlingException'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMessageTemplateAttachmentRequest'
tags:
- Attachments
servers:
- url: https://wisdom.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4_wisdom: []
/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/attachments/{attachmentId}:
delete:
operationId: DeleteMessageTemplateAttachment
summary: Delete Message Template Attachment
description: Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMessageTemplateAttachmentResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'400':
description: ThrottlingException; ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMessageTemplateAttachmentRequest'
tags:
- Attachments
servers:
- url: https://wisdom.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4_wisdom: []
components:
schemas:
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.
ConversationSource:
type: object
properties:
conversationId:
type: string
description: The unique identifier of the Amazon Q Business conversation.
attachmentId:
type: string
description: The unique identifier of the Amazon Q Business attachment.
required:
- conversationId
- attachmentId
WisdomAccessDeniedException:
type: object
properties:
message:
type: string
DeleteAttachmentResponse:
type: object
properties: {}
WisdomResourceNotFoundException:
type: object
properties:
message:
type: string
resourceName:
type: string
description: The specified resource name.
WisdomServiceQuotaExceededException:
type: object
properties:
message:
type: string
UnauthorizedException:
type: object
properties:
message:
type: string
ListAttachmentsRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier for the Amazon Q Business application.
conversationId:
type: string
description: The unique identifier of the Amazon Q Business web experience conversation.
userId:
type: string
description: The unique identifier of the user involved in the Amazon Q Business web experience conversation.
nextToken:
type: string
description: If the number of attachments returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.
maxResults:
type: integer
description: The maximum number of attachements to return.
required:
- applicationId
LicenseNotFoundException:
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
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
DeleteAttachmentRequest:
type: object
properties:
applicationId:
type: string
description: The unique identifier for the Amazon Q Business application environment.
conversationId:
type: string
description: The unique identifier of the conversation.
attachmentId:
type: string
description: The unique identifier for the attachment.
userId:
type: string
description: The unique identifier of the user involved in the conversation.
required:
- applicationId
- conversationId
- attachmentId
Attachment:
type: object
properties:
attachmentId:
type: string
description: The identifier of the Amazon Q Business attachment.
conversationId:
type: string
description: The identifier of the Amazon Q Business conversation the attachment is associated with.
name:
type: string
description: Filename of the Amazon Q Business attachment.
copyFrom:
$ref: '#/components/schemas/CopyFromSource'
fileType:
type: string
description: Filetype of the Amazon Q Business attachment.
fileSize:
type: integer
description: Size in bytes of the Amazon Q Business attachment.
md5chksum:
type: string
description: MD5 checksum of the Amazon Q Business attachment contents.
createdAt:
type: string
format: date-time
description: The Unix timestamp when the Amazon Q Business attachment was created.
status:
type: string
enum:
- FAILED
- SUCCESS
description: AttachmentStatus of the Amazon Q Business attachment.
error:
$ref: '#/components/schemas/ErrorDetail'
WisdomConflictException:
type: object
properties:
message:
type: string
DeleteMessageTemplateAttachmentRequest:
type: object
properties:
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
messageTemplateId:
type: string
description: The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
attachmentId:
type: string
description: The identifier of the attachment file.
required:
- knowledgeBaseId
- messageTemplateId
- attachmentId
CreateMessageTemplateAttachmentRequest:
type: object
properties:
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
messageTemplateId:
type: string
description: The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
contentDisposition:
type: string
description: The presentation information for the attachment file.
name:
type: string
description: The name of the attachment file being uploaded. The name should include the file extension.
body:
type: string
description: The body of the attachment file being uploaded. It should be encoded using base64 encoding.
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
required:
- knowledgeBaseId
- messageTemplateId
- contentDisposition
- name
- body
DeleteMessageTemplateAttachmentResponse:
type: object
properties: {}
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
MessageTemplateAttachment:
type: object
properties:
contentDisposition:
type: string
description: The presentation information for the attachment file.
name:
type: string
description: The name of the attachment file being uploaded. The name should include the file extension.
uploadedTime:
type: string
description: The timestamp when the attachment file was uploaded.
url:
type: string
description: A pre-signed Amazon S3 URL that can be used to download the attachment file.
urlExpiry:
type: string
description: The expiration time of the pre-signed Amazon S3 URL.
attachmentId:
type: string
description: The identifier of the attachment file.
required:
- contentDisposition
- name
- uploadedTime
- url
- urlExpiry
- attachmentId
CreateMessageTemplateAttachmentResponse:
type: object
properties:
attachment:
$ref: '#/components/schemas/MessageTemplateAttachment'
ListAttachmentsResponse:
type: object
properties:
attachments:
type: array
items:
$ref: '#/components/schemas/Attachment'
description: An array of information on one or more attachments.
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 attachments.
CopyFromSource:
type: object
properties:
conversation:
$ref: '#/components/schemas/ConversationSource'
description: Exactly one member is set.
WisdomThrottlingException:
type: object
properties:
message:
type: string
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