Amazon Connect Connect Prompts API
The Connect Prompts API from Amazon Connect — 2 operation(s) for connect prompts.
The Connect Prompts API from Amazon Connect — 2 operation(s) for connect prompts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-prompts-api"
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.
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: 3.1.0
info:
title: Amazon Connect Service Prompts API
version: '2017-08-08'
description: Generated from AWS's published Smithy model for Amazon Connect Service. 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://connect.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/prompts/{InstanceId}:
put:
operationId: CreatePrompt
summary: Create Prompt
description: Creates a prompt. For more information about prompts, such as supported file types and maximum length,
see Create prompts in the Connect Customer Administrator Guide.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePromptResponse'
'409':
description: DuplicateResourceException
content:
application/json:
schema:
$ref: '#/components/schemas/DuplicateResourceException'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'429':
description: LimitExceededException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePromptRequest'
tags:
- Prompts
/prompts/{InstanceId}/{PromptId}:
delete:
operationId: DeletePrompt
summary: Delete Prompt
description: Deletes a prompt.
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'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/DeletePromptRequest'
tags:
- Prompts
get:
operationId: DescribePrompt
summary: Describe Prompt
description: Describes the prompt.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribePromptResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'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/DescribePromptRequest'
tags:
- Prompts
post:
operationId: UpdatePrompt
summary: Update Prompt
description: Updates a prompt.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePromptResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'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/UpdatePromptRequest'
tags:
- Prompts
components:
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: connect
schemas:
CreatePromptRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
Name:
type: string
description: The name of the prompt.
Description:
type: string
description: The description of the prompt.
S3Uri:
type: string
description: The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by
the GetPromptFile API instead of providing S3 URIs.
Tags:
type: object
additionalProperties:
type: string
description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
"key2":"value2"} }.'
required:
- InstanceId
- Name
- S3Uri
CreatePromptResponse:
type: object
properties:
PromptARN:
type: string
description: The Amazon Resource Name (ARN) of the prompt.
PromptId:
type: string
description: A unique identifier for the prompt.
DeletePromptRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
PromptId:
type: string
description: A unique identifier for the prompt.
required:
- InstanceId
- PromptId
DescribePromptRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
PromptId:
type: string
description: A unique identifier for the prompt.
required:
- InstanceId
- PromptId
DescribePromptResponse:
type: object
properties:
Prompt:
$ref: '#/components/schemas/Prompt'
DuplicateResourceException:
type: object
properties:
Message:
type: string
InternalServiceException:
type: object
properties:
Message:
type: string
description: The message.
InvalidParameterException:
type: object
properties:
Message:
type: string
description: The message about the parameters.
LimitExceededException:
type: object
properties:
Message:
type: string
description: The message about the limit.
Prompt:
type: object
properties:
PromptARN:
type: string
description: The Amazon Resource Name (ARN) of the prompt.
PromptId:
type: string
description: A unique identifier for the prompt.
Name:
type: string
description: The name of the prompt.
Description:
type: string
description: The description of the prompt.
Tags:
type: object
additionalProperties:
type: string
description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
"key2":"value2"} }.'
LastModifiedTime:
type: string
format: date-time
description: The timestamp when this resource was last modified.
LastModifiedRegion:
type: string
description: The Amazon Web Services Region where this resource was last modified.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
description: The message about the resource.
ThrottlingException:
type: object
properties:
Message:
type: string
UpdatePromptRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
Name (ARN) of the instance.
PromptId:
type: string
description: A unique identifier for the prompt.
Name:
type: string
description: The name of the prompt.
Description:
type: string
description: A description of the prompt.
S3Uri:
type: string
description: The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by
the GetPromptFile API instead of providing S3 URIs.
required:
- InstanceId
- PromptId
UpdatePromptResponse:
type: object
properties:
PromptARN:
type: string
description: The Amazon Resource Name (ARN) of the prompt.
PromptId:
type: string
description: A unique identifier for the prompt.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)