Amazon Q Q Importjobs API
The Q Importjobs API from Amazon Q — 2 operation(s) for q importjobs.
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-importjobs-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 Importjobs 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://wisdom.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Importjobs
paths:
/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}:
delete:
operationId: DeleteImportJob
summary: Delete Import Job
description: Deletes the quick response import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteImportJobResponse'
'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'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteImportJobRequest'
tags:
- Importjobs
get:
operationId: GetImportJob
summary: Get Import Job
description: Retrieves the started import job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetImportJobResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomResourceNotFoundException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetImportJobRequest'
tags:
- Importjobs
/knowledgeBases/{knowledgeBaseId}/importJobs:
get:
operationId: ListImportJobs
summary: List Import Jobs
description: Lists information about import jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListImportJobsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomAccessDeniedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListImportJobsRequest'
tags:
- Importjobs
post:
operationId: StartImportJob
summary: Start Import Job
description: Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartImportJobResponse'
'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'
'401':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/WisdomValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartImportJobRequest'
tags:
- Importjobs
components:
schemas:
DeleteImportJobRequest:
type: object
properties:
knowledgeBaseId:
type: string
description: The identifier of the knowledge base.
importJobId:
type: string
description: The identifier of the import job to be deleted.
required:
- knowledgeBaseId
- importJobId
GetImportJobRequest:
type: object
properties:
importJobId:
type: string
description: The identifier of the import job to retrieve.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base that the import job belongs to.
required:
- importJobId
- knowledgeBaseId
StartImportJobRequest:
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. For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.
importJobType:
type: string
description: The type of the import job. For importing quick response resource, set the value to QUICK_RESPONSES.
uploadId:
type: string
description: A pointer to the uploaded asset. This value is returned by StartContentUpload.
clientToken:
type: string
description: The tags used to organize, track, or control access for this resource.
metadata:
type: object
additionalProperties:
type: string
description: The metadata fields of the imported Amazon Q in Connect resources.
externalSourceConfiguration:
$ref: '#/components/schemas/ExternalSourceConfiguration'
required:
- knowledgeBaseId
- importJobType
- uploadId
WisdomAccessDeniedException:
type: object
properties:
message:
type: string
StartImportJobResponse:
type: object
properties:
importJob:
$ref: '#/components/schemas/ImportJobData'
WisdomResourceNotFoundException:
type: object
properties:
message:
type: string
resourceName:
type: string
description: The specified resource name.
WisdomValidationException:
type: object
properties:
message:
type: string
ImportJobData:
type: object
properties:
importJobId:
type: string
description: The identifier of the import job.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base.
uploadId:
type: string
description: A pointer to the uploaded asset. This value is returned by StartContentUpload.
knowledgeBaseArn:
type: string
description: The Amazon Resource Name (ARN) of the knowledge base.
importJobType:
type: string
description: The type of the import job.
status:
type: string
description: The status of the import job.
url:
type: string
description: The download link to the resource file that is uploaded to the import job.
failedRecordReport:
type: string
description: The link to download the information of resource data that failed to be imported.
urlExpiry:
type: string
description: The expiration time of the URL as an epoch timestamp.
createdTime:
type: string
description: The timestamp when the import job was created.
lastModifiedTime:
type: string
description: The timestamp when the import job data was last modified.
metadata:
type: object
additionalProperties:
type: string
description: The metadata fields of the imported Amazon Q in Connect resources.
externalSourceConfiguration:
$ref: '#/components/schemas/ExternalSourceConfiguration'
required:
- importJobId
- knowledgeBaseId
- uploadId
- knowledgeBaseArn
- importJobType
- status
- url
- urlExpiry
- createdTime
- lastModifiedTime
ListImportJobsRequest:
type: object
properties:
nextToken:
type: string
description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
maxResults:
type: integer
description: The maximum number of results to return per page.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
required:
- knowledgeBaseId
ImportJobSummary:
type: object
properties:
importJobId:
type: string
description: The identifier of the import job.
knowledgeBaseId:
type: string
description: The identifier of the knowledge base.
uploadId:
type: string
description: A pointer to the uploaded asset. This value is returned by StartContentUpload.
knowledgeBaseArn:
type: string
description: The Amazon Resource Name (ARN) of the knowledge base.
importJobType:
type: string
description: The type of import job.
status:
type: string
description: The status of the import job.
createdTime:
type: string
description: The timestamp when the import job was created.
lastModifiedTime:
type: string
description: The timestamp when the import job was last modified.
metadata:
type: object
additionalProperties:
type: string
description: The metadata fields of the imported Amazon Q in Connect resources.
externalSourceConfiguration:
$ref: '#/components/schemas/ExternalSourceConfiguration'
required:
- importJobId
- knowledgeBaseId
- uploadId
- knowledgeBaseArn
- importJobType
- status
- createdTime
- lastModifiedTime
WisdomServiceQuotaExceededException:
type: object
properties:
message:
type: string
GetImportJobResponse:
type: object
properties:
importJob:
$ref: '#/components/schemas/ImportJobData'
UnauthorizedException:
type: object
properties:
message:
type: string
Configuration:
type: object
properties:
connectConfiguration:
$ref: '#/components/schemas/ConnectConfiguration'
description: Exactly one member is set.
WisdomConflictException:
type: object
properties:
message:
type: string
ConnectConfiguration:
type: object
properties:
instanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.
ExternalSourceConfiguration:
type: object
properties:
source:
type: string
description: The type of the external data source.
configuration:
$ref: '#/components/schemas/Configuration'
required:
- source
- configuration
ListImportJobsResponse:
type: object
properties:
importJobSummaries:
type: array
items:
$ref: '#/components/schemas/ImportJobSummary'
description: Summary information about the import jobs.
nextToken:
type: string
description: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
required:
- importJobSummaries
DeleteImportJobResponse:
type: object
properties: {}
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: wisdom
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qconnect/service/2020-10-19/qconnect-2020-10-19.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)