amazon-connect-service

name	amazon-connect-service
description	Amazon Connect Service API skill. Use when working with Amazon Connect Service for evaluation-forms, analytics-data, instance. Covers 255 endpoints.
version	1.0.0
generator	lapsh

Amazon Connect Service

API version: 2017-08-08

Auth

AWS SigV4

Base URL

Not specified.

Setup

1. Configure auth: AWS SigV4
2. GET /instance -- verify access
3. POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate -- create first activate

Endpoints

255 endpoints across 66 groups. See references/api-spec.lap for full details.

evaluation-forms

Method	Path	Description
POST	/evaluation-forms/{InstanceId}/{EvaluationFormId}/activate	Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
PUT	/evaluation-forms/{InstanceId}	Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
POST	/evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate	Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
DELETE	/evaluation-forms/{InstanceId}/{EvaluationFormId}	Deletes an evaluation form in the specified Amazon Connect instance. If the version property is provided, only the specified version of the evaluation form is deleted. If no version is provided, then the full form (all versions) is deleted.
GET	/evaluation-forms/{InstanceId}/{EvaluationFormId}	Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
GET	/evaluation-forms/{InstanceId}/{EvaluationFormId}/versions	Lists versions of an evaluation form in the specified Amazon Connect instance.
GET	/evaluation-forms/{InstanceId}	Lists evaluation forms in the specified Amazon Connect instance.
PUT	/evaluation-forms/{InstanceId}/{EvaluationFormId}	Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content.

analytics-data

Method	Path	Description
PUT	/analytics-data/instance/{InstanceId}/association	This API is in preview release for Amazon Connect and is subject to change. Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
PUT	/analytics-data/instance/{InstanceId}/associations	This API is in preview release for Amazon Connect and is subject to change. Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
POST	/analytics-data/instance/{InstanceId}/associations	This API is in preview release for Amazon Connect and is subject to change. Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
POST	/analytics-data/instance/{InstanceId}/association	This API is in preview release for Amazon Connect and is subject to change. Removes the dataset ID associated with a given Amazon Connect instance.
GET	/analytics-data/instance/{InstanceId}/association	This API is in preview release for Amazon Connect and is subject to change. Lists the association status of requested dataset ID for a given Amazon Connect instance.

instance

Method	Path	Description
PUT	/instance/{InstanceId}/approved-origin	This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance.
PUT	/instance/{InstanceId}/bot	This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
PUT	/instance/{InstanceId}/storage-config	This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
PUT	/instance/{InstanceId}/lambda-function	This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function.
PUT	/instance/{InstanceId}/lex-bot	This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
PUT	/instance/{InstanceId}/security-key	This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.
PUT	/instance	This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
PUT	/instance/{InstanceId}/integration-associations

default-vocabulary

Method	Path	Description
PUT	/default-vocabulary/{InstanceId}/{LanguageCode}	Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

flow-associations

Method	Path	Description
PUT	/flow-associations/{InstanceId}	Associates a connect resource to a flow.
DELETE	/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}	Disassociates a connect resource from a flow.
GET	/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}	Retrieves the flow associated for a given resource.

phone-number

Method	Path	Description
PUT	/phone-number/{PhoneNumberId}/contact-flow	Associates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.
POST	/phone-number/claim	Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
GET	/phone-number/{PhoneNumberId}	Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

queues

Method	Path	Description
POST	/queues/{InstanceId}/{QueueId}/associate-quick-connects	This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue.
PUT	/queues/{InstanceId}	This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
DELETE	/queues/{InstanceId}/{QueueId}	Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
GET	/queues/{InstanceId}/{QueueId}	This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue.
POST	/queues/{InstanceId}/{QueueId}/disassociate-quick-connects	This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue.
GET	/queues/{InstanceId}/{QueueId}/quick-connects	This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue.
POST	/queues/{InstanceId}/{QueueId}/hours-of-operation	This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue.
POST	/queues/{InstanceId}/{QueueId}/max-contacts	This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full.

routing-profiles

Method	Path	Description
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues	Associates a set of queues with a routing profile.
PUT	/routing-profiles/{InstanceId}	Creates a new routing profile.
DELETE	/routing-profiles/{InstanceId}/{RoutingProfileId}	Deletes a routing profile.
GET	/routing-profiles/{InstanceId}/{RoutingProfileId}	Describes the specified routing profile.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues	Disassociates a set of queues from a routing profile.
GET	/routing-profiles/{InstanceId}/{RoutingProfileId}/queues	Lists the queues associated with a routing profile.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer	Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency	Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue	Updates the default outbound queue of a routing profile.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/name	Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/queues	Updates the properties associated with a set of queues for a routing profile.

traffic-distribution-group

Method	Path	Description
PUT	/traffic-distribution-group/{TrafficDistributionGroupId}/user	Associates an agent with a traffic distribution group.
PUT	/traffic-distribution-group	Creates a traffic distribution group given an Amazon Connect instance that has been replicated. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
DELETE	/traffic-distribution-group/{TrafficDistributionGroupId}	Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
GET	/traffic-distribution-group/{TrafficDistributionGroupId}	Gets details and status of a traffic distribution group.
DELETE	/traffic-distribution-group/{TrafficDistributionGroupId}/user	Disassociates an agent from a traffic distribution group.
GET	/traffic-distribution-group/{TrafficDistributionGroupId}/user	Lists traffic distribution group users.

users

Method	Path	Description
POST	/users/{InstanceId}/{UserId}/associate-proficiencies	>Associates a set of proficiencies with a user.
PUT	/users/{InstanceId}	Creates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management. For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
DELETE	/users/{InstanceId}/{UserId}	Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide. After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
GET	/users/{InstanceId}/{UserId}	Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
POST	/users/{InstanceId}/{UserId}/disassociate-proficiencies	Disassociates a set of proficiencies from a user.
POST	/users/{InstanceId}/{UserId}/contact	Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
GET	/users/{InstanceId}/{UserId}/proficiencies	Lists proficiencies associated with a user.
PUT	/users/{InstanceId}/{UserId}/status	Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
POST	/users/{InstanceId}/{UserId}/hierarchy	Assigns the specified hierarchy group to the specified user.

attached-files

Method	Path	Description
POST	/attached-files/{InstanceId}	Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
POST	/attached-files/{InstanceId}/{FileId}	Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
DELETE	/attached-files/{InstanceId}/{FileId}	Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.
GET	/attached-files/{InstanceId}/{FileId}	Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
PUT	/attached-files/{InstanceId}	Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to an Amazon Connect Case.

flow-associations-batch

Method	Path	Description
POST	/flow-associations-batch/{InstanceId}	Retrieve the flow associations for the given resources.

contact

Method	Path	Description
PUT	/contact/batch/{InstanceId}	Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
POST	/contact/create-participant	Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
POST	/contact/persistent-contact-association/{InstanceId}/{InitialContactId}	Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
GET	/contact/attributes/{InstanceId}/{InitialContactId}	Retrieves the contact attributes for the specified contact.
GET	/contact/references/{InstanceId}/{ContactId}	This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
POST	/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}	Provides a list of analysis segments for a real-time analysis session.
POST	/contact/monitor	Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
POST	/contact/pause	Allows pausing an ongoing task contact.
POST	/contact/resume	Allows resuming a task contact in a paused state.
POST	/contact/resume-recording	When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported.
PUT

agent-status

Method	Path	Description
PUT	/agent-status/{InstanceId}	This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance.
GET	/agent-status/{InstanceId}/{AgentStatusId}	This API is in preview release for Amazon Connect and is subject to change. Describes an agent status.
GET	/agent-status/{InstanceId}	This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses.
POST	/agent-status/{InstanceId}/{AgentStatusId}	This API is in preview release for Amazon Connect and is subject to change. Updates agent status.

contact-flows

Method	Path	Description
PUT	/contact-flows/{InstanceId}	Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language.
DELETE	/contact-flows/{InstanceId}/{ContactFlowId}	Deletes a flow for the specified Amazon Connect instance.
GET	/contact-flows/{InstanceId}/{ContactFlowId}	Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED
POST	/contact-flows/{InstanceId}/{ContactFlowId}/content	Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
POST	/contact-flows/{InstanceId}/{ContactFlowId}/metadata	Updates metadata about specified flow.
POST	/contact-flows/{InstanceId}/{ContactFlowId}/name	The name of the flow. You can also create and update flows using the Amazon Connect Flow language.

contact-flow-modules

Method	Path	Description
PUT	/contact-flow-modules/{InstanceId}	Creates a flow module for the specified Amazon Connect instance.
DELETE	/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}	Deletes the specified flow module.
GET	/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}	Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
POST	/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content	Updates specified flow module for the specified Amazon Connect instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.
POST	/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata	Updates metadata about specified flow module.

hours-of-operations

Method	Path	Description
PUT	/hours-of-operations/{InstanceId}	This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation.
DELETE	/hours-of-operations/{InstanceId}/{HoursOfOperationId}	This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation.
GET	/hours-of-operations/{InstanceId}/{HoursOfOperationId}	This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation.
POST	/hours-of-operations/{InstanceId}/{HoursOfOperationId}	This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation.

predefined-attributes

Method	Path	Description
PUT	/predefined-attributes/{InstanceId}	Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
DELETE	/predefined-attributes/{InstanceId}/{Name}	Deletes a predefined attribute from the specified Amazon Connect instance.
GET	/predefined-attributes/{InstanceId}/{Name}	Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
GET	/predefined-attributes/{InstanceId}	Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
POST	/predefined-attributes/{InstanceId}/{Name}	Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

prompts

Method	Path	Description
PUT	/prompts/{InstanceId}	Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
DELETE	/prompts/{InstanceId}/{PromptId}	Deletes a prompt.
GET	/prompts/{InstanceId}/{PromptId}	Describes the prompt.
GET	/prompts/{InstanceId}/{PromptId}/file	Gets the prompt file.
POST	/prompts/{InstanceId}/{PromptId}	Updates a prompt.

quick-connects

Method	Path	Description
PUT	/quick-connects/{InstanceId}	Creates a quick connect for the specified Amazon Connect instance.
DELETE	/quick-connects/{InstanceId}/{QuickConnectId}	Deletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
GET	/quick-connects/{InstanceId}/{QuickConnectId}	Describes the quick connect.
GET	/quick-connects/{InstanceId}	Provides information about the quick connects for the specified Amazon Connect instance.
POST	/quick-connects/{InstanceId}/{QuickConnectId}/config	Updates the configuration settings for the specified quick connect.
POST	/quick-connects/{InstanceId}/{QuickConnectId}/name	Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

rules

Method	Path	Description
POST	/rules/{InstanceId}	Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.
DELETE	/rules/{InstanceId}/{RuleId}	Deletes a rule for the specified Amazon Connect instance.
GET	/rules/{InstanceId}/{RuleId}	Describes a rule for the specified Amazon Connect instance.
GET	/rules/{InstanceId}	List all rules for the specified Amazon Connect instance.
PUT	/rules/{InstanceId}/{RuleId}	Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.

security-profiles

Method	Path	Description
PUT	/security-profiles/{InstanceId}	Creates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
DELETE	/security-profiles/{InstanceId}/{SecurityProfileId}	Deletes a security profile.
GET	/security-profiles/{InstanceId}/{SecurityProfileId}	Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
POST	/security-profiles/{InstanceId}/{SecurityProfileId}	Updates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

user-hierarchy-groups

Method	Path	Description
PUT	/user-hierarchy-groups/{InstanceId}	Creates a new user hierarchy group.
DELETE	/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}	Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
GET	/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}	Describes the specified hierarchy group.
POST	/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name	Updates the name of the user hierarchy group.

views

Method	Path	Description
PUT	/views/{InstanceId}	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.
PUT	/views/{InstanceId}/{ViewId}/versions	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.
DELETE	/views/{InstanceId}/{ViewId}	Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
DELETE	/views/{InstanceId}/{ViewId}/versions/{ViewVersion}	Deletes the particular version specified in ViewVersion identifier.
GET	/views/{InstanceId}/{ViewId}	Retrieves the view for the specified Amazon Connect 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, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED
GET	/views/{InstanceId}/{ViewId}/versions	Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest.
GET	/views/{InstanceId}	Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.
POST	/views/{InstanceId}/{ViewId}	Updates the view content of the given view identifier in the specified Amazon Connect 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.
POST	/views/{InstanceId}/{ViewId}/metadata	Updates the view metadata. Note that either Name or Description must be provided.

vocabulary

Method	Path	Description
POST	/vocabulary/{InstanceId}	Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
GET	/vocabulary/{InstanceId}/{VocabularyId}	Describes the specified vocabulary.

contact-evaluations

Method	Path	Description
DELETE	/contact-evaluations/{InstanceId}/{EvaluationId}	Deletes a contact evaluation in the specified Amazon Connect instance.
GET	/contact-evaluations/{InstanceId}/{EvaluationId}	Describes a contact evaluation in the specified Amazon Connect instance.
GET	/contact-evaluations/{InstanceId}	Lists contact evaluations in the specified Amazon Connect instance.
PUT	/contact-evaluations/{InstanceId}	Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. Evaluations created through the public API do not contain answer values suggested from automation.
POST	/contact-evaluations/{InstanceId}/{EvaluationId}/submit	Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier. If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
POST	/contact-evaluations/{InstanceId}/{EvaluationId}	Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

vocabulary-remove

Method	Path	Description
POST	/vocabulary-remove/{InstanceId}/{VocabularyId}	Deletes the vocabulary that has the given identifier.

authentication-profiles

Method	Path	Description
GET	/authentication-profiles/{InstanceId}/{AuthenticationProfileId}	This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.
POST	/authentication-profiles/{InstanceId}/{AuthenticationProfileId}	This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile.

contacts

Method	Path	Description
GET	/contacts/{InstanceId}/{ContactId}	This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API.
POST	/contacts/{InstanceId}/{ContactId}	This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts.
POST	/contacts/{InstanceId}/{ContactId}/routing-data	Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block. Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

user-hierarchy-structure

Method	Path	Description
GET	/user-hierarchy-structure/{InstanceId}	Describes the hierarchy structure of the specified Amazon Connect instance.
POST	/user-hierarchy-structure/{InstanceId}	Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

metrics

Method	Path	Description
POST	/metrics/current/{InstanceId}	Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
POST	/metrics/userdata/{InstanceId}	Gets the real-time active user data from the specified Amazon Connect instance.
POST	/metrics/historical/{InstanceId}	Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
POST	/metrics/data	Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.

user

Method	Path	Description
GET	/user/federate/{InstanceId}	Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

traffic-distribution

Method	Path	Description
GET	/traffic-distribution/{Id}	Retrieves the current traffic distribution for a given traffic distribution group.
PUT	/traffic-distribution/{Id}	Updates the traffic distribution for a given traffic distribution group. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

authentication-profiles-summary

Method	Path	Description
GET	/authentication-profiles-summary/{InstanceId}	This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.

contact-flow-modules-summary

Method	Path	Description
GET	/contact-flow-modules-summary/{InstanceId}	Provides information about the flow modules for the specified Amazon Connect instance.

contact-flows-summary

Method	Path	Description
GET	/contact-flows-summary/{InstanceId}	Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide.

default-vocabulary-summary

Method	Path	Description
POST	/default-vocabulary-summary/{InstanceId}	Lists the default vocabularies for the specified Amazon Connect instance.

flow-associations-summary

Method	Path	Description
GET	/flow-associations-summary/{InstanceId}	List the flow association based on the filters.

hours-of-operations-summary

Method	Path	Description
GET	/hours-of-operations-summary/{InstanceId}	Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

phone-numbers-summary

Method	Path	Description
GET	/phone-numbers-summary/{InstanceId}	Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID. The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

prompts-summary

Method	Path	Description
GET	/prompts-summary/{InstanceId}	Provides information about the prompts for the specified Amazon Connect instance.

queues-summary

Method	Path	Description
GET	/queues-summary/{InstanceId}	Provides information about the queues for the specified Amazon Connect instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

routing-profiles-summary

Method	Path	Description
GET	/routing-profiles-summary/{InstanceId}	Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

security-profiles-applications

Method	Path	Description
GET	/security-profiles-applications/{InstanceId}/{SecurityProfileId}	Returns a list of third-party applications in a specific security profile.

security-profiles-permissions

Method	Path	Description
GET	/security-profiles-permissions/{InstanceId}/{SecurityProfileId}	Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

security-profiles-summary

Method	Path	Description
GET	/security-profiles-summary/{InstanceId}	Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

tags

Method	Path	Description
GET	/tags/{resourceArn}	Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
POST	/tags/{resourceArn}	Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
DELETE	/tags/{resourceArn}	Removes the specified tags from the specified resource.

traffic-distribution-groups

Method	Path	Description
GET	/traffic-distribution-groups	Lists traffic distribution groups.

user-hierarchy-groups-summary

Method	Path	Description
GET	/user-hierarchy-groups-summary/{InstanceId}	Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

users-summary

Method	Path	Description
GET	/users-summary/{InstanceId}	Provides summary information about the users for the specified Amazon Connect instance.

search-agent-statuses

Method	Path	Description
POST	/search-agent-statuses	Searches AgentStatuses in an Amazon Connect instance, with optional filtering.

search-contact-flow-modules

Method	Path	Description
POST	/search-contact-flow-modules	Searches the flow modules in an Amazon Connect instance, with optional filtering.

search-contact-flows

Method	Path	Description
POST	/search-contact-flows	Searches the contact flows in an Amazon Connect instance, with optional filtering.

search-contacts

Method	Path	Description
POST	/search-contacts	Searches contacts in an Amazon Connect instance.

search-hours-of-operations

Method	Path	Description
POST	/search-hours-of-operations	Searches the hours of operation in an Amazon Connect instance, with optional filtering.

search-predefined-attributes

Method	Path	Description
POST	/search-predefined-attributes	Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

search-prompts

Method	Path	Description
POST	/search-prompts	Searches prompts in an Amazon Connect instance, with optional filtering.

search-queues

Method	Path	Description
POST	/search-queues	Searches queues in an Amazon Connect instance, with optional filtering.

search-quick-connects

Method	Path	Description
POST	/search-quick-connects	Searches quick connects in an Amazon Connect instance, with optional filtering.

search-resource-tags

Method	Path	Description
POST	/search-resource-tags	Searches tags used in an Amazon Connect instance using optional search criteria.

search-routing-profiles

Method	Path	Description
POST	/search-routing-profiles	Searches routing profiles in an Amazon Connect instance, with optional filtering.

search-security-profiles

Method	Path	Description
POST	/search-security-profiles	Searches security profiles in an Amazon Connect instance, with optional filtering. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

search-user-hierarchy-groups

Method	Path	Description
POST	/search-user-hierarchy-groups	Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

search-users

Method	Path	Description
POST	/search-users	Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.

vocabulary-summary

Method	Path	Description
POST	/vocabulary-summary/{InstanceId}	Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

chat-integration-event

Method	Path	Description