Amazon Connect Connect Agent Status API
The Connect Agent Status API from Amazon Connect — 2 operation(s) for connect agent status.
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-agent-status-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 Agent Status 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:
/agent-status/{InstanceId}:
put:
operationId: CreateAgentStatus
summary: Create Agent Status
description: Creates an agent status for the specified Connect Customer instance.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentStatusResponse'
'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'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentStatusRequest'
tags:
- Agent Status
get:
operationId: ListAgentStatuses
summary: List Agent Statuses
description: Lists agent statuses.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAgentStatusResponse'
'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/ListAgentStatusRequest'
tags:
- Agent Status
/agent-status/{InstanceId}/{AgentStatusId}:
get:
operationId: DescribeAgentStatus
summary: Describe Agent Status
description: Describes an agent status.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAgentStatusResponse'
'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/DescribeAgentStatusRequest'
tags:
- Agent Status
post:
operationId: UpdateAgentStatus
summary: Update Agent Status
description: Updates agent status.
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
'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'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAgentStatusRequest'
tags:
- Agent Status
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:
AgentStatus:
type: object
properties:
AgentStatusARN:
type: string
description: The Amazon Resource Name (ARN) of the agent status.
AgentStatusId:
type: string
description: The identifier of the agent status.
Name:
type: string
description: The name of the agent status.
Description:
type: string
description: The description of the agent status.
Type:
type: string
enum:
- ROUTABLE
- CUSTOM
- OFFLINE
description: The type of agent status.
DisplayOrder:
type: integer
description: The display order of the agent status.
State:
type: string
enum:
- ENABLED
- DISABLED
description: The state of the agent status.
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.
AgentStatusSummary:
type: object
properties:
Id:
type: string
description: The identifier for an agent status.
Arn:
type: string
description: The Amazon Resource Name (ARN) for the agent status.
Name:
type: string
description: The name of the agent status.
Type:
type: string
enum:
- ROUTABLE
- CUSTOM
- OFFLINE
description: The type of the agent status.
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.
CreateAgentStatusRequest:
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 status.
Description:
type: string
description: The description of the status.
State:
type: string
enum:
- ENABLED
- DISABLED
description: The state of the status.
DisplayOrder:
type: integer
description: The display order of the status.
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
- State
CreateAgentStatusResponse:
type: object
properties:
AgentStatusARN:
type: string
description: The Amazon Resource Name (ARN) of the agent status.
AgentStatusId:
type: string
description: The identifier of the agent status.
DescribeAgentStatusRequest:
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.
AgentStatusId:
type: string
description: The identifier for the agent status.
required:
- InstanceId
- AgentStatusId
DescribeAgentStatusResponse:
type: object
properties:
AgentStatus:
$ref: '#/components/schemas/AgentStatus'
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.
ListAgentStatusRequest:
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.
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.
AgentStatusTypes:
type: array
items:
type: string
enum:
- ROUTABLE
- CUSTOM
- OFFLINE
description: Available agent status types.
required:
- InstanceId
ListAgentStatusResponse:
type: object
properties:
NextToken:
type: string
description: If there are additional results, this is the token for the next set of results.
AgentStatusSummaryList:
type: array
items:
$ref: '#/components/schemas/AgentStatusSummary'
description: A summary of agent statuses.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
description: The message about the resource.
ThrottlingException:
type: object
properties:
Message:
type: string
UpdateAgentStatusRequest:
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.
AgentStatusId:
type: string
description: The identifier of the agent status.
Name:
type: string
description: The name of the agent status.
Description:
type: string
description: The description of the agent status.
State:
type: string
enum:
- ENABLED
- DISABLED
description: The state of the agent status.
DisplayOrder:
type: integer
description: The display order of the agent status.
ResetOrderNumber:
type: boolean
description: A number indicating the reset order of the agent status.
required:
- InstanceId
- AgentStatusId
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)