Amazon Connect Connect Views API
The Connect Views API from Amazon Connect — 2 operation(s) for connect views.
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-views-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 Views API
version: '2017-08-08'
description: Generated from AWS's published Smithy model for Amazon Connect Service. 5 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}:
put:
operationId: CreateView
summary: Create View
description: Creates a new view with the possible status of SAVED or PUBLISHED. The views will have a unique name for
each connect instance. It performs basic content validation if the status is SAVED or full content validation if the
status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or
both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent
if ClientToken is provided.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateViewResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: DuplicateResourceException; ResourceInUseException
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'
'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/CreateViewRequest'
tags:
- Views
get:
operationId: ListViews
summary: List Views
description: Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListViewsResponse'
'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/ListViewsRequest'
tags:
- Views
/views/{InstanceId}/{ViewId}:
delete:
operationId: DeleteView
summary: Delete View
description: Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteViewResponse'
'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/DeleteViewRequest'
tags:
- Views
get:
operationId: DescribeView
summary: Describe View
description: Retrieves the view for the specified Connect Customer instance and view identifier. The view identifier
can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can
contain an optional qualifier, for example, :$SAVED, which is either an actual version number or an Connect Customer
managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and
an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed
views.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeViewResponse'
'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/DescribeViewRequest'
tags:
- Views
post:
operationId: UpdateViewContent
summary: Update View Content
description: Updates the view content of the given view identifier in the specified Connect Customer instance. It performs
content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that
the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is
PUBLISHED.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateViewContentResponse'
'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/UpdateViewContentRequest'
tags:
- Views
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
CreateViewRequest:
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.
ClientToken:
type: string
description: A unique Id for each create view request to avoid duplicate view creation. For example, the view is
idempotent ClientToken is provided.
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.
Content:
$ref: '#/components/schemas/ViewInputContent'
Description:
type: string
description: The description of the view.
Name:
type: string
description: The name of the view.
Tags:
type: object
additionalProperties:
type: string
description: 'The tags associated with the view resource (not specific to view version).These tags can be used to
organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"}
}.'
required:
- InstanceId
- Status
- Content
- Name
CreateViewResponse:
type: object
properties:
View:
$ref: '#/components/schemas/View'
DeleteViewRequest:
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.
required:
- InstanceId
- ViewId
DeleteViewResponse:
type: object
properties: {}
DescribeViewRequest:
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 ViewId of the view. This must be an ARN for Amazon Web Services managed views.
required:
- InstanceId
- ViewId
DescribeViewResponse:
type: object
properties:
View:
$ref: '#/components/schemas/View'
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.
ListViewsRequest:
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.
Type:
type: string
enum:
- CUSTOMER_MANAGED
- AWS_MANAGED
description: The type of the view.
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
ListViewsResponse:
type: object
properties:
ViewsSummaryList:
type: array
items:
$ref: '#/components/schemas/ViewSummary'
description: A list of view 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.
TooManyRequestsException:
type: object
properties:
Message:
type: string
UpdateViewContentRequest:
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.
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.
Content:
$ref: '#/components/schemas/ViewInputContent'
required:
- InstanceId
- ViewId
- Status
- Content
UpdateViewContentResponse:
type: object
properties:
View:
$ref: '#/components/schemas/View'
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.
ViewInputContent:
type: object
properties:
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.
ViewSummary:
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.
Type:
type: string
enum:
- CUSTOMER_MANAGED
- AWS_MANAGED
description: The type 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.
Description:
type: string
description: The description of the view.
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)