Amazon Connect Connect Versions API
The Connect Versions API from Amazon Connect — 5 operation(s) for connect versions.
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-versions-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 Versions API
version: '2017-08-08'
description: Generated from AWS's published Smithy model for Amazon Connect Service. 6 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:
/views/{InstanceId}/{ViewId}/versions:
put:
operationId: CreateViewVersion
summary: Create View Version
description: Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It
returns the highest version if there is no change in content compared to that version. An error is displayed if the
supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateViewVersionResponse'
'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'
'409':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateViewVersionRequest'
tags:
- Versions
get:
operationId: ListViewVersions
summary: List View Versions
description: Returns all the available versions for the specified Connect Customer instance and view identifier. Results
will be sorted from highest to lowest.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListViewVersionsResponse'
'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: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListViewVersionsRequest'
tags:
- Versions
/views/{InstanceId}/{ViewId}/versions/{ViewVersion}:
delete:
operationId: DeleteViewVersion
summary: Delete View Version
description: Deletes the particular version specified in ViewVersion identifier.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteViewVersionResponse'
'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'
'409':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteViewVersionRequest'
tags:
- Versions
/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/versions:
get:
operationId: ListContactFlowModuleVersions
summary: List Contact Flow Module Versions
description: Retrieves a paginated list of all versions for a specific contact flow module.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListContactFlowModuleVersionsResponse'
'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/ListContactFlowModuleVersionsRequest'
tags:
- Versions
/contact-flows/{InstanceId}/{ContactFlowId}/versions:
get:
operationId: ListContactFlowVersions
summary: List Contact Flow Versions
description: Returns all the available versions for the specified Connect Customer instance and flow identifier.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListContactFlowVersionsResponse'
'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/ListContactFlowVersionsRequest'
tags:
- Versions
/evaluation-forms/{InstanceId}/{EvaluationFormId}/versions:
get:
operationId: ListEvaluationFormVersions
summary: List Evaluation Form Versions
description: Lists versions of an evaluation form in the specified Connect Customer instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListEvaluationFormVersionsResponse'
'500':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
'400':
description: InvalidParameterException
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/ListEvaluationFormVersionsRequest'
tags:
- Versions
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
ContactFlowModuleVersionSummary:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the flow module version.
VersionDescription:
type: string
description: The description of the flow module version.
Version:
type: integer
description: The version of the flow module.
ContactFlowVersionSummary:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the flow version.
VersionDescription:
type: string
description: The description of the flow version.
Version:
type: integer
description: The identifier of the flow version.
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.
CreateViewVersionRequest:
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.
ViewId:
type: string
description: The identifier of the view. Both ViewArn and ViewId can be used.
VersionDescription:
type: string
description: The description for the version being published.
ViewContentSha256:
type: string
description: Indicates the checksum value of the latest published view content.
required:
- InstanceId
- ViewId
CreateViewVersionResponse:
type: object
properties:
View:
$ref: '#/components/schemas/View'
DeleteViewVersionRequest:
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.
ViewId:
type: string
description: The identifier of the view. Both ViewArn and ViewId can be used.
ViewVersion:
type: integer
description: The version number of the view.
required:
- InstanceId
- ViewId
- ViewVersion
DeleteViewVersionResponse:
type: object
properties: {}
EvaluationFormVersionSummary:
type: object
properties:
EvaluationFormArn:
type: string
description: The Amazon Resource Name (ARN) for the evaluation form resource.
EvaluationFormId:
type: string
description: The unique identifier for the evaluation form.
EvaluationFormVersion:
type: integer
description: A version of the evaluation form.
Locked:
type: boolean
description: The flag indicating whether the evaluation form is locked for changes.
Status:
type: string
enum:
- DRAFT
- ACTIVE
description: The status of the evaluation form.
CreatedTime:
type: string
format: date-time
description: The timestamp for when the evaluation form was created.
CreatedBy:
type: string
description: The Amazon Resource Name (ARN) of the user who created the evaluation form.
LastModifiedTime:
type: string
format: date-time
description: The timestamp for when the evaluation form was last updated.
LastModifiedBy:
type: string
description: The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
required:
- EvaluationFormArn
- EvaluationFormId
- EvaluationFormVersion
- Locked
- Status
- CreatedTime
- CreatedBy
- LastModifiedTime
- LastModifiedBy
InternalServiceException:
type: object
properties:
Message:
type: string
description: The message.
InvalidParameterException:
type: object
properties:
Message:
type: string
description: The message about the parameters.
ListContactFlowModuleVersionsRequest:
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.
ContactFlowModuleId:
type: string
description: The identifier of the flow module.
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.
required:
- InstanceId
- ContactFlowModuleId
ListContactFlowModuleVersionsResponse:
type: object
properties:
ContactFlowModuleVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/ContactFlowModuleVersionSummary'
description: Information about the flow module versions.
NextToken:
type: string
description: If there are additional results, this is the token for the next set of results.
ListContactFlowVersionsRequest:
type: object
properties:
InstanceId:
type: string
description: The identifier of the Connect Customer instance.
ContactFlowId:
type: string
description: The identifier of the flow.
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. The default MaxResult size is 100.
required:
- InstanceId
- ContactFlowId
ListContactFlowVersionsResponse:
type: object
properties:
ContactFlowVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/ContactFlowVersionSummary'
description: A list of flow version summaries.
NextToken:
type: string
description: If there are additional results, this is the token for the next set of results.
ListEvaluationFormVersionsRequest:
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.
EvaluationFormId:
type: string
description: The unique identifier for the evaluation form.
MaxResults:
type: integer
description: The maximum number of results to return per page.
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:
- InstanceId
- EvaluationFormId
ListEvaluationFormVersionsResponse:
type: object
properties:
EvaluationFormVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/EvaluationFormVersionSummary'
description: Provides details about a list of evaluation forms belonging to an instance.
NextToken:
type: string
description: If there are additional results, this is the token for the next set of results.
required:
- EvaluationFormVersionSummaryList
ListViewVersionsRequest:
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.
ViewId:
type: string
description: The identifier of the view. Both ViewArn and ViewId can be used.
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. The default MaxResult size is 100.
required:
- InstanceId
- ViewId
ListViewVersionsResponse:
type: object
properties:
ViewVersionSummaryList:
type: array
items:
$ref: '#/components/schemas/ViewVersionSummary'
description: A list of view version summaries.
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.
ResourceInUseException:
type: object
properties:
Message:
type: string
ResourceType:
type: string
enum:
- CONTACT
- CONTACT_FLOW
- INSTANCE
- PARTICIPANT
- HIERARCHY_LEVEL
- HIERARCHY_GROUP
- USER
- PHONE_NUMBER
description: The type of resource.
ResourceId:
type: string
description: The identifier for the resource.
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.
ThrottlingException:
type: object
properties:
Message:
type: string
TooManyRequestsException:
type: object
properties:
Message:
type: string
View:
type: object
properties:
Id:
type: string
description: The identifier of the view.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the view.
Name:
type: string
description: The name of the view.
Status:
type: string
enum:
- PUBLISHED
- SAVED
description: Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation
on the content.
Type:
type: string
enum:
- CUSTOMER_MANAGED
- AWS_MANAGED
description: The type of the view - CUSTOMER_MANAGED.
Description:
type: string
description: The description of the view.
Version:
type: integer
description: Current version of the view.
VersionDescription:
type: string
description: The description of the version.
Content:
$ref: '#/components/schemas/ViewContent'
Tags:
type: object
additionalProperties:
type: string
description: The tags associated with the view resource (not specific to view version).
CreatedTime:
type: string
format: date-time
description: The timestamp of when the view was created.
LastModifiedTime:
type: string
format: date-time
description: Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
ViewContentSha256:
type: string
description: Indicates the checksum value of the latest published view content.
ViewContent:
type: object
properties:
InputSchema:
type: string
description: The data schema matching data that the view template must be provided to render.
Template:
type: string
description: The view template representing the structure of the view.
Actions:
type: array
items:
type: string
description: A list of possible actions from the view.
ViewVersionSummary:
type: object
properties:
Id:
type: string
description: The identifier of the view version.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the view version.
Description:
type: string
description: The description of the view version.
Name:
type: string
description: The name of the view version.
Type:
type: string
enum:
- CUSTOMER_MANAGED
- AWS_MANAGED
description: The type of the view version.
Version:
type: integer
description: The sequentially incremented version of the view version.
VersionDescription:
type: string
description: The description of the view version.
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)