Amazon Connect Connect Test Cases API
The Connect Test Cases API from Amazon Connect — 2 operation(s) for connect test cases.
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-connect:amazon-connect-test-cases-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.1.0
info:
title: Amazon Connect Service Test Cases 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:
/test-cases/{InstanceId}:
put:
operationId: CreateTestCase
summary: Create Test Case
description: Creates a test case with its content and metadata for the specified Amazon Connect instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTestCaseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: DuplicateResourceException; IdempotencyException
content:
application/json:
schema:
$ref: '#/components/schemas/DuplicateResourceException'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException; InvalidRequestException; InvalidTestCaseException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'429':
description: LimitExceededException; ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTestCaseRequest'
tags:
- Test Cases
/test-cases/{InstanceId}/{TestCaseId}:
delete:
operationId: DeleteTestCase
summary: Delete Test Case
description: Deletes the test case that has already been created for the specified Amazon Connect instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTestCaseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'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/DeleteTestCaseRequest'
tags:
- Test Cases
get:
operationId: DescribeTestCase
summary: Describe Test Case
description: Describes the specified test case and allows you to get the content and metadata of the test case for the
specified Amazon Connect instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTestCaseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'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/DescribeTestCaseRequest'
tags:
- Test Cases
post:
operationId: UpdateTestCase
summary: Update Test Case
description: Updates any of the metadata for a test case, such as the name, description, and status or content of an
existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified
Amazon Connect instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTestCaseResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'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; InvalidTestCaseException
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/UpdateTestCaseRequest'
tags:
- Test Cases
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:
AccessDeniedException:
type: object
properties:
Message:
type: string
ChatEntryPointParameters:
type: object
properties:
FlowId:
type: string
description: The flow identifier for the test.
CreateTestCaseRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Amazon Connect instance.
Name:
type: string
description: The name of the test.
Description:
type: string
description: The description of the test.
Content:
type: string
description: The JSON string that represents the content of the test.
EntryPoint:
$ref: '#/components/schemas/TestCaseEntryPoint'
InitializationData:
type: string
description: Defines the initial custom attributes for your test.
Status:
type: string
enum:
- PUBLISHED
- SAVED
description: Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation
on the content. The SAVED status does not initiate validation of the content.
TestCaseId:
type: string
description: Id of the test case if you want to create it in a replica region using Amazon Connect Global Resiliency
Tags:
type: object
additionalProperties:
type: string
description: The tags used to organize, track, or control access for this resource.
LastModifiedTime:
type: string
format: date-time
description: The time at which the resource was last modified.
LastModifiedRegion:
type: string
description: The region in which the resource was last modified
required:
- InstanceId
- Name
- Content
CreateTestCaseResponse:
type: object
properties:
TestCaseId:
type: string
description: The identifier of the test.
TestCaseArn:
type: string
description: The Amazon Resource Name (ARN) of the test.
DeleteTestCaseRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Amazon Connect instance.
TestCaseId:
type: string
description: The identifier of the test case to delete.
required:
- InstanceId
- TestCaseId
DeleteTestCaseResponse:
type: object
properties: {}
DescribeTestCaseRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Amazon Connect instance.
TestCaseId:
type: string
description: The identifier of the test case.
Status:
type: string
enum:
- PUBLISHED
- SAVED
description: The status of the test case version to retrieve. If not specified, returns the published version if
available, otherwise returns the saved version.
required:
- InstanceId
- TestCaseId
DescribeTestCaseResponse:
type: object
properties:
TestCase:
$ref: '#/components/schemas/TestCase'
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.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
description: The message about the resource.
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
Reason:
$ref: '#/components/schemas/ServiceQuotaExceededExceptionReason'
ServiceQuotaExceededExceptionReason:
type: object
properties:
AttachedFileServiceQuotaExceededExceptionReason:
type: string
enum:
- TOTAL_FILE_SIZE_EXCEEDED
- TOTAL_FILE_COUNT_EXCEEDED
description: Total file size of all files or total number of files exceeds the service quota
description: Exactly one member is set.
TestCase:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the test case.
Id:
type: string
description: The identifier of the test case.
Name:
type: string
description: The name of the test case.
Content:
type: string
description: The JSON string that represents the content of the test.
EntryPoint:
$ref: '#/components/schemas/TestCaseEntryPoint'
InitializationData:
type: string
description: Defines the test attributes for precise data representation. The value must be a valid JSON string.
Description:
type: string
description: The description of the test case.
Status:
type: string
enum:
- PUBLISHED
- SAVED
description: Indicates the test status as either SAVED or PUBLISHED.
LastModifiedTime:
type: string
format: date-time
description: The time at which the test case was last modified.
LastModifiedRegion:
type: string
description: The region in which the test case was last modified.
Tags:
type: object
additionalProperties:
type: string
description: The tags used to organize, track, or control access for this resource.
TestCaseSha256:
type: string
description: The SHA256 hash of the test case content.
TestCaseEntryPoint:
type: object
properties:
Type:
type: string
enum:
- VOICE_CALL
- CHAT
description: The type of entry point.
VoiceCallEntryPointParameters:
$ref: '#/components/schemas/VoiceCallEntryPointParameters'
ChatEntryPointParameters:
$ref: '#/components/schemas/ChatEntryPointParameters'
ThrottlingException:
type: object
properties:
Message:
type: string
UpdateTestCaseRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Amazon Connect instance.
TestCaseId:
type: string
description: The identifier of the test case to update.
Content:
type: string
description: The JSON string that represents the content of the test.
EntryPoint:
$ref: '#/components/schemas/TestCaseEntryPoint'
InitializationData:
type: string
description: Defines the test attributes for precise data representation.
Name:
type: string
description: The name of the test case.
Description:
type: string
description: The description of the test case.
Status:
type: string
enum:
- PUBLISHED
- SAVED
description: Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation
on the content. The SAVED status does not initiate validation of the content.
LastModifiedTime:
type: string
format: date-time
description: The time at which the resource was last modified.
LastModifiedRegion:
type: string
description: The region in which the resource was last modified
required:
- InstanceId
- TestCaseId
UpdateTestCaseResponse:
type: object
properties: {}
VoiceCallEntryPointParameters:
type: object
properties:
SourcePhoneNumber:
type: string
description: The source phone number for the test.
DestinationPhoneNumber:
type: string
description: The destination phone number for the test.
FlowId:
type: string
description: The flow identifier for the test.
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)