Amazon Web Services, Inc.

Amazon Connect Service

Amazon Connect now refers to a portfolio of agentic solutions for business functions. The legacy product is now called Amazon Connect Customer, or simply…

Communication#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Connect now refers to a portfolio of agentic solutions for business functions. The
legacy product is now called Amazon Connect Customer, or simply Customer. The legacy name
is used interchangeably in this documentation.

Connect Customer Customer actions

Connect Customer Customer data types

Connect Customer Customer engages customers at every touchpoint and creates deeper
relationships with AI powered capabilities.
Build and manage customer communication experiences. Connect customers to agents, enable
intelligent routing, and track performance in real-time.
There are limits to the number of Connect Customer resources that you can create. There are also limits to the
number of requests that you can make per second. For more information, see Connect Customer Service Quotas in the
Connect Customer Administrator Guide .
You can use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Connect Customer endpoints, see Connect Customer
Endpoints .

Endpoints 400

  • POSTActivate evaluation form/evaluation-forms/:InstanceId/:EvaluationFormId/activateActivates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations…
  • GETList analytics data associations/analytics-data/instance/:InstanceId/association?DataSetId=string&nextToken=string&maxResults=0Lists the association status of requested dataset ID for a given Connect Customer instance.
  • PUTAssociate analytics data set/analytics-data/instance/:InstanceId/associationAssociates the specified dataset for a Connect Customer instance with the target account. You can associate only one dataset in a single call.
  • POSTDisassociate analytics data set/analytics-data/instance/:InstanceId/associationRemoves the dataset ID associated with a given Connect Customer instance.
  • PUTAssociate approved origin/instance/:InstanceId/approved-originThis API is in preview release for Connect Customer and is subject to change. Associates an approved origin to an Connect Customer instance.
  • DELETEDisassociate approved origin/instance/:InstanceId/approved-origin?origin=string&clientToken=stringThis API is in preview release for Connect Customer and is subject to change. Revokes access to integrated applications from Connect Customer.
  • PUTAssociate bot/instance/:InstanceId/botThis API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon…
  • POSTDisassociate bot/instance/:InstanceId/botThis API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon…
  • POSTAssociate contact with user/contacts/:InstanceId/:ContactId/associate-userAssociates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users.…
  • PUTAssociate default vocabulary/default-vocabulary/:InstanceId/:LanguageCodeAssociates an existing vocabulary as the default. Contact Lens for Connect Customer uses the vocabulary in post-call and real-time analysis sessions for the…
  • POSTAssociate email address alias/email-addresses/:InstanceId/:EmailAddressId/associate-aliasAssociates an email address alias with an existing email address in an Connect Customer instance. This creates a forwarding relationship where emails sent to…
  • PUTAssociate flow/flow-associations/:InstanceIdAssociates a connect resource to a flow.
  • POSTAssociate hours of operations/hours-of-operations/:InstanceId/:HoursOfOperationId/associate-hoursAssociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see…
  • PUTAssociate instance storage config/instance/:InstanceId/storage-configThis API is in preview release for Connect Customer and is subject to change. Associates a storage resource type for the first time. You can only associate…
  • PUTAssociate lambda function/instance/:InstanceId/lambda-functionThis API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Lambda…
  • DELETEDisassociate lambda function/instance/:InstanceId/lambda-function?functionArn=string&clientToken=stringThis API is in preview release for Connect Customer and is subject to change. Remove the Lambda function from the dropdown options available in the relevant…
  • PUTAssociate lex bot/instance/:InstanceId/lex-botThis API is in preview release for Connect Customer and is subject to change. Allows the specified Connect Customer instance to access the specified Amazon…
  • DELETEDisassociate lex bot/instance/:InstanceId/lex-bot?botName=string&lexRegion=string&clientToken=stringThis API is in preview release for Connect Customer and is subject to change. Revokes authorization from the specified instance to access the specified Amazon…
  • PUTAssociate phone number contact flow/phone-number/:PhoneNumberId/contact-flowAssociates a flow with a phone number claimed to your Connect Customer instance. If the number is claimed to a traffic distribution group, and you are calling…
  • DELETEDisassociate phone number contact flow/phone-number/:PhoneNumberId/contact-flow?instanceId=stringRemoves the flow association from a phone number claimed to your Connect Customer instance. If the number is claimed to a traffic distribution group, and you…
  • POSTAssociate queue email addresses/queues/:InstanceId/:QueueId/associate-email-addressesAssociates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts…
  • POSTAssociate queue quick connects/queues/:InstanceId/:QueueId/associate-quick-connectsAssociates a set of quick connects with a queue.
  • POSTAssociate routing profile queues/routing-profiles/:InstanceId/:RoutingProfileId/associate-queuesAssociates a set of queues with a routing profile.
  • PUTAssociate security key/instance/:InstanceId/security-keyThis API is in preview release for Connect Customer and is subject to change. Associates a security key to the instance.
  • POSTAssociate security profiles/associate-security-profiles/:InstanceIdAssociate security profiles with an Entity in an Amazon Connect instance.
  • GETList traffic distribution group users/traffic-distribution-group/:TrafficDistributionGroupId/user?maxResults=0&nextToken=stringLists traffic distribution group users.
  • PUTAssociate traffic distribution group user/traffic-distribution-group/:TrafficDistributionGroupId/userAssociates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
  • DELETEDisassociate traffic distribution group user/traffic-distribution-group/:TrafficDistributionGroupId/user?UserId=string&InstanceId=stringDisassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
  • POSTAssociate user proficiencies/users/:InstanceId/:UserId/associate-proficienciesAssociates a set of proficiencies with a user.
  • POSTAssociate workspace/workspaces/:InstanceId/:WorkspaceId/associateAssociates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
  • PUTBatch associate analytics data set/analytics-data/instance/:InstanceId/associationsAssociates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call.
  • POSTBatch disassociate analytics data set/analytics-data/instance/:InstanceId/associationsRemoves a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call.
  • POSTBatch create data table value/data-tables/:InstanceId/:DataTableId/values/createCreates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer…
  • POSTBatch delete data table value/data-tables/:InstanceId/:DataTableId/values/deleteDeletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown…
  • POSTBatch describe data table value/data-tables/:InstanceId/:DataTableId/values/describeRetrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and…
  • PUTStart attached file upload/attached-files/:InstanceId?associatedResourceArn=stringProvides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to a Connect Customer Case ,…
  • POSTBatch get attached file metadata/attached-files/:InstanceId?associatedResourceArn=stringAllows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with…
  • POSTBatch get flow association/flow-associations-batch/:InstanceIdRetrieve the flow associations for the given resources.
  • PUTBatch put contact/contact/batch/:InstanceIdOnly the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of…
  • POSTBatch update data table value/data-tables/:InstanceId/:DataTableId/values/updateUpdates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation…
  • POSTClaim phone number/phone-number/claimClaims an available phone number to your Connect Customer instance or traffic distribution group. You can call this API only in the same Amazon Web Services…
  • GETGet attached file/attached-files/:InstanceId/:FileId?urlExpiryInSeconds=0&associatedResourceArn=string&urlContentDisposition=stringProvides 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…
  • POSTComplete attached file upload/attached-files/:InstanceId/:FileId?associatedResourceArn=stringAllows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
  • DELETEDelete attached file/attached-files/:InstanceId/:FileId?associatedResourceArn=stringDeletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.
  • GETList agent statuses/agent-status/:InstanceId?nextToken=string&maxResults=0&AgentStatusTypes=Lists agent statuses.
  • PUTCreate agent status/agent-status/:InstanceIdCreates an agent status for the specified Connect Customer instance.
  • PUTCreate attached file/attached-files/:InstanceId/files?associatedResourceArn=stringCreates an attached file for a completed voice contact by copying a recording from a source S3 URI into Connect Customer managed storage. Use this API to…
  • POSTCreate auth code/auth/code/:InstanceIdCreates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions…
  • PUTCreate contact/contact/create-contactOnly the VOICE, EMAIL, and TASK channels are supported. For VOICE: The supported initiation method is TRANSFER . The contacts created with this initiation…
  • PUTCreate contact flow/contact-flows/:InstanceIdCreates a flow for the specified Connect Customer instance. You can also create and update flows using the Connect Customer Flow language .
  • PUTCreate contact flow alias/contact-flows/:InstanceId/:ContactFlowId/aliasCreates a named alias that points to a specific version of a flow.
  • PUTCreate contact flow module/contact-flow-modules/:InstanceIdCreates a flow module for the specified Connect Customer instance.
  • PUTCreate contact flow module alias/contact-flow-modules/:InstanceId/:ContactFlowModuleId/aliasCreates a named alias that points to a specific version of a contact flow module.
  • PUTCreate contact flow module version/contact-flow-modules/:InstanceId/:ContactFlowModuleId/versionCreates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback…
  • PUTCreate contact flow version/contact-flows/:InstanceId/:ContactFlowId/versionPublishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the…
  • GETList data tables/data-tables/:InstanceId?nextToken=string&maxResults=0Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.
  • PUTCreate data table/data-tables/:InstanceIdCreates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no…
  • PUTCreate data table attribute/data-tables/:InstanceId/:DataTableId/attributesAdds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This…
  • POSTList data table attributes/data-tables/:InstanceId/:DataTableId/attributes?nextToken=string&maxResults=0Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon…
  • PUTCreate email address/email-addresses/:InstanceIdCreate new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect…
  • GETList evaluation forms/evaluation-forms/:InstanceId?maxResults=0&nextToken=stringLists evaluation forms in the specified Connect Customer instance.
  • PUTCreate evaluation form/evaluation-forms/:InstanceIdCreates an evaluation form in the specified Connect Customer instance. The form can be used to define questions related to agent performance, and create…
  • GETList extraction definitions/extraction-definitions/:InstanceId?maxResults=0&nextToken=stringLists extraction definitions in the specified Connect Customer instance.
  • POSTCreate extraction definition/extraction-definitions/:InstanceIdCreates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer…
  • PUTCreate hours of operation/hours-of-operations/:InstanceIdCreates hours of operation.
  • GETList hours of operation overrides/hours-of-operations/:InstanceId/:HoursOfOperationId/overrides?nextToken=string&maxResults=0List the hours of operation overrides.
  • PUTCreate hours of operation override/hours-of-operations/:InstanceId/:HoursOfOperationId/overridesCreates an hours of operation override in an Connect Customer hours of operation resource.
  • GETList instances/instance?nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Return a list of instances which are in active state, creation-in-progress…
  • PUTCreate instance/instanceThis API is in preview release for Connect Customer and is subject to change. Initiates an Connect Customer instance with all the supported channels enabled.…
  • GETList integration associations/instance/:InstanceId/integration-associations?integrationType=string&nextToken=string&maxResults=0&integrationArn=stringProvides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance.
  • PUTCreate integration association/instance/:InstanceId/integration-associationsCreates an Amazon Web Services resource association with an Connect Customer instance.
  • GETList metrics/metrics/definitions/:InstanceId?type=string&maxResults=0&nextToken=stringRetrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and…
  • PUTCreate metric/metrics/definitions/:InstanceIdCreates a new metric definition for the specified Connect Customer instance. You can create custom metrics that use formulas referencing existing Amazon Web…
  • GETList notifications/notifications/:InstanceId?nextToken=string&maxResults=0Retrieves a paginated list of all notifications in the Amazon Connect instance.
  • PUTCreate notification/notifications/:InstanceIdCreates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time.…
  • POSTCreate participant/contact/create-participantAdds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom…
  • POSTCreate persistent contact association/contact/persistent-contact-association/:InstanceId/:InitialContactIdEnables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Connect Customer…
  • GETList predefined attributes/predefined-attributes/:InstanceId?nextToken=string&maxResults=0Lists predefined attributes for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined…
  • PUTCreate predefined attribute/predefined-attributes/:InstanceIdCreates a new predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined…
  • PUTCreate prompt/prompts/:InstanceIdCreates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer…
  • PUTCreate push notification registration/push-notification/:InstanceId/registrationsCreates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up…
  • PUTCreate queue/queues/:InstanceIdCreates a new queue for the specified Connect Customer instance. If the phone number is claimed to a traffic distribution group that was created in the same…
  • GETList quick connects/quick-connects/:InstanceId?nextToken=string&maxResults=0&QuickConnectTypes=Provides information about the quick connects for the specified Connect Customer instance.
  • PUTCreate quick connect/quick-connects/:InstanceIdCreates a quick connect for the specified Connect Customer instance.
  • PUTCreate routing profile/routing-profiles/:InstanceIdCreates a new routing profile.
  • GETList rules/rules/:InstanceId?publishStatus=string&eventSourceName=string&maxResults=0&nextToken=stringList all rules for the specified Connect Customer instance.
  • POSTCreate rule/rules/:InstanceIdCreates a rule for the specified Connect Customer instance. Use the Rules Function language to code conditions for the rule.
  • PUTCreate security profile/security-profiles/:InstanceIdCreates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the…
  • GETList task templates/instance/:InstanceId/task/template?nextToken=string&maxResults=0&status=string&name=stringLists task templates for the specified Connect Customer instance.
  • PUTCreate task template/instance/:InstanceId/task/templateCreates a new task template in the specified Connect Customer instance.
  • PUTCreate test case/test-cases/:InstanceIdCreates a test case with its content and metadata for the specified Amazon Connect instance.
  • PUTCreate traffic distribution group/traffic-distribution-groupCreates a traffic distribution group given an Connect Customer instance that has been replicated. The SignInConfig distribution is available only on a default…
  • GETList use cases/instance/:InstanceId/integration-associations/:IntegrationAssociationId/use-cases?nextToken=string&maxResults=0Lists the use cases for the integration association.
  • PUTCreate use case/instance/:InstanceId/integration-associations/:IntegrationAssociationId/use-casesCreates a use case for an integration association.
  • PUTCreate user/users/:InstanceIdCreates a user account for the specified Connect Customer instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email ,…
  • PUTCreate user hierarchy group/user-hierarchy-groups/:InstanceIdCreates a new user hierarchy group.
  • GETList views/views/:InstanceId?type=string&nextToken=string&maxResults=0Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.
  • PUTCreate view/views/:InstanceIdCreates 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…
  • GETList view versions/views/:InstanceId/:ViewId/versions?nextToken=string&maxResults=0Returns all the available versions for the specified Connect Customer instance and view identifier. Results will be sorted from highest to lowest.
  • PUTCreate view version/views/:InstanceId/:ViewId/versionsPublishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in…
  • POSTCreate vocabulary/vocabulary/:InstanceIdCreates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given…
  • GETList workspaces/workspaces/:InstanceId?nextToken=string&maxResults=0Lists the workspaces in an Amazon Connect instance.
  • PUTCreate workspace/workspaces/:InstanceIdCreates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.
  • GETList workspace pages/workspaces/:InstanceId/:WorkspaceId/pages?nextToken=string&maxResults=0Lists the page configurations in a workspace, including the views assigned to each page.
  • PUTCreate workspace page/workspaces/:InstanceId/:WorkspaceId/pagesAssociates a view with a page in a workspace, defining what users see when they navigate to that page.
  • POSTDeactivate evaluation form/evaluation-forms/:InstanceId/:EvaluationFormId/deactivateDeactivates an evaluation form in the specified Connect Customer instance. After a form is deactivated, it is no longer available for users to start new…
  • POSTDelete all entity sessions/auth/sessions/delete-all-entity-sessionsDeletes all active sessions for the specified entity in the specified Connect Customer instance. The operation supports only the USER entity type, so you can…
  • POSTDelete contact data/contact/delete/:InstanceId/:ContactIdDeletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII…
  • GETDescribe contact evaluation/contact-evaluations/:InstanceId/:EvaluationIdDescribes a contact evaluation in the specified Connect Customer instance.
  • POSTUpdate contact evaluation/contact-evaluations/:InstanceId/:EvaluationIdUpdates details about a contact evaluation in the specified Connect Customer instance. A contact evaluation must be in draft state. Answers included in the…
  • DELETEDelete contact evaluation/contact-evaluations/:InstanceId/:EvaluationIdDeletes a contact evaluation in the specified Connect Customer instance.
  • GETDescribe contact flow/contact-flows/:InstanceId/:ContactFlowIdDescribes the specified flow. You can also create and update flows using the Connect Customer Flow language . Use the $SAVED alias in the request to describe…
  • DELETEDelete contact flow/contact-flows/:InstanceId/:ContactFlowIdDeletes a flow for the specified Connect Customer instance.
  • GETDescribe contact flow alias/contact-flows/:InstanceId/:ContactFlowId/alias/:AliasIdReturns information about a specific flow alias, including the version that it points to.
  • POSTUpdate contact flow alias/contact-flows/:InstanceId/:ContactFlowId/alias/:AliasIdUpdates the name, description, or flow version associated with an alias.
  • DELETEDelete contact flow alias/contact-flows/:InstanceId/:ContactFlowId/alias/:AliasIdDeletes an alias from a flow without deleting the version that the alias points to.
  • GETDescribe contact flow module/contact-flow-modules/:InstanceId/:ContactFlowModuleIdDescribes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example,…
  • DELETEDelete contact flow module/contact-flow-modules/:InstanceId/:ContactFlowModuleIdDeletes the specified flow module.
  • GETDescribe contact flow module alias/contact-flow-modules/:InstanceId/:ContactFlowModuleId/alias/:AliasIdRetrieves detailed information about a specific alias, including which version it currently points to and its metadata.
  • POSTUpdate contact flow module alias/contact-flow-modules/:InstanceId/:ContactFlowModuleId/alias/:AliasIdUpdates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
  • DELETEDelete contact flow module alias/contact-flow-modules/:InstanceId/:ContactFlowModuleId/alias/:AliasIdRemoves an alias reference, breaking the named connection to the underlying module version without affecting the version itself.
  • DELETEDelete contact flow module version/contact-flow-modules/:InstanceId/:ContactFlowModuleId/version/:ContactFlowModuleVersionRemoves a specific version of a contact flow module.
  • DELETEDelete contact flow version/contact-flows/:InstanceId/:ContactFlowId/version/:ContactFlowVersionDeletes the particular version specified in flow version identifier.
  • GETDescribe data table/data-tables/:InstanceId/:DataTableIdReturns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region…
  • POSTUpdate data table metadata/data-tables/:InstanceId/:DataTableIdUpdates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update…
  • DELETEDelete data table/data-tables/:InstanceId/:DataTableIdDeletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data…
  • GETDescribe data table attribute/data-tables/:InstanceId/:DataTableId/attributes/:AttributeNameReturns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term…
  • POSTUpdate data table attribute/data-tables/:InstanceId/:DataTableId/attributes/:AttributeNameUpdates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a…
  • DELETEDelete data table attribute/data-tables/:InstanceId/:DataTableId/attributes/:AttributeNameDeletes an attribute and all its values from a data table.
  • GETDescribe email address/email-addresses/:InstanceId/:EmailAddressIdDescribe email address form the specified Connect Customer instance.
  • POSTUpdate email address metadata/email-addresses/:InstanceId/:EmailAddressIdUpdates an email address metadata. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.
  • DELETEDelete email address/email-addresses/:InstanceId/:EmailAddressIdDeletes email address from the specified Connect Customer instance.
  • GETDescribe evaluation form/evaluation-forms/:InstanceId/:EvaluationFormId?version=0Describes an evaluation form in the specified Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is…
  • PUTUpdate evaluation form/evaluation-forms/:InstanceId/:EvaluationFormIdUpdates details about a specific evaluation form version in the specified Connect Customer instance. Question and section identifiers cannot be duplicated…
  • DELETEDelete evaluation form/evaluation-forms/:InstanceId/:EvaluationFormId?version=0Deletes an evaluation form in the specified Connect Customer instance. If the version property is provided, only the specified version of the evaluation form…
  • GETDescribe extraction definition/extraction-definitions/:InstanceId/:ExtractionDefinitionIdDescribes an extraction definition in the specified Connect Customer instance.
  • PUTUpdate extraction definition/extraction-definitions/:InstanceId/:ExtractionDefinitionIdUpdates an extraction definition in the specified Connect Customer instance.
  • DELETEDelete extraction definition/extraction-definitions/:InstanceId/:ExtractionDefinitionIdDeletes an extraction definition from the specified Connect Customer instance.
  • GETDescribe hours of operation/hours-of-operations/:InstanceId/:HoursOfOperationIdDescribes the hours of operation.
  • POSTUpdate hours of operation/hours-of-operations/:InstanceId/:HoursOfOperationIdUpdates the hours of operation.
  • DELETEDelete hours of operation/hours-of-operations/:InstanceId/:HoursOfOperationIdDeletes an hours of operation.
  • GETDescribe hours of operation override/hours-of-operations/:InstanceId/:HoursOfOperationId/overrides/:HoursOfOperationOverrideIdDescribes the hours of operation override.
  • POSTUpdate hours of operation override/hours-of-operations/:InstanceId/:HoursOfOperationId/overrides/:HoursOfOperationOverrideIdUpdate the hours of operation override.
  • DELETEDelete hours of operation override/hours-of-operations/:InstanceId/:HoursOfOperationId/overrides/:HoursOfOperationOverrideIdDeletes an hours of operation override in an Connect Customer hours of operation resource.
  • GETDescribe instance/instance/:InstanceIdThis API is in preview release for Connect Customer and is subject to change. Returns the current state of the specified instance identifier. It tracks the…
  • DELETEDelete instance/instance/:InstanceId?clientToken=stringThis API is in preview release for Connect Customer and is subject to change. Deletes the Connect Customer instance. For more information, see Delete your…
  • DELETEDelete integration association/instance/:InstanceId/integration-associations/:IntegrationAssociationIdDeletes an Amazon Web Services resource association from an Connect Customer instance. The association must not have any use cases associated with it.
  • GETDescribe metric/metrics/definitions/:InstanceId/:MetricIdRetrieves the full definition of an existing metric from the specified Connect Customer instance.
  • DELETEDelete metric/metrics/definitions/:InstanceId/:MetricIdDeletes an existing metric from the specified Connect Customer instance. This operation fails with ResourceConflictException if the metric is currently in use…
  • GETDescribe notification/notifications/:InstanceId/:NotificationIdRetrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
  • POSTUpdate notification content/notifications/:InstanceId/:NotificationIdUpdates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.
  • DELETEDelete notification/notifications/:InstanceId/:NotificationIdDeletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.
  • GETDescribe predefined attribute/predefined-attributes/:InstanceId/:NameDescribes a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. You can use predefined…
  • POSTUpdate predefined attribute/predefined-attributes/:InstanceId/:NameUpdates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value. For the predefined…
  • DELETEDelete predefined attribute/predefined-attributes/:InstanceId/:NameDeletes a predefined attribute from the specified Connect Customer instance.
  • GETDescribe prompt/prompts/:InstanceId/:PromptIdDescribes the prompt.
  • POSTUpdate prompt/prompts/:InstanceId/:PromptIdUpdates a prompt.
  • DELETEDelete prompt/prompts/:InstanceId/:PromptIdDeletes a prompt.
  • DELETEDelete push notification registration/push-notification/:InstanceId/registrations/:RegistrationId?contactId=stringDeletes registration for a device token and a chat contact.
  • GETDescribe queue/queues/:InstanceId/:QueueIdDescribes the specified queue.
  • DELETEDelete queue/queues/:InstanceId/:QueueIdDeletes a queue.
  • GETDescribe quick connect/quick-connects/:InstanceId/:QuickConnectIdDescribes the quick connect.
  • DELETEDelete quick connect/quick-connects/:InstanceId/:QuickConnectIdDeletes a quick connect. After calling DeleteUser , it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will…
  • GETDescribe routing profile/routing-profiles/:InstanceId/:RoutingProfileIdDescribes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on…
  • DELETEDelete routing profile/routing-profiles/:InstanceId/:RoutingProfileIdDeletes a routing profile.
  • GETDescribe rule/rules/:InstanceId/:RuleIdDescribes a rule for the specified Connect Customer instance.
  • PUTUpdate rule/rules/:InstanceId/:RuleIdUpdates a rule for the specified Connect Customer instance. Use the Rules Function language to code conditions for the rule.
  • DELETEDelete rule/rules/:InstanceId/:RuleIdDeletes a rule for the specified Connect Customer instance.
  • GETDescribe security profile/security-profiles/:InstanceId/:SecurityProfileIdGets basic information about the security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide…
  • POSTUpdate security profile/security-profiles/:InstanceId/:SecurityProfileIdUpdates a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator Guide . For a mapping of the…
  • DELETEDelete security profile/security-profiles/:InstanceId/:SecurityProfileIdDeletes a security profile.
  • DELETEDelete session/auth/sessions/:InstanceId/:SessionIdDeletes a session for the specified Connect Customer instance.
  • GETGet task template/instance/:InstanceId/task/template/:TaskTemplateId?snapshotVersion=stringGets details about a specific task template in the specified Connect Customer instance.
  • POSTUpdate task template/instance/:InstanceId/task/template/:TaskTemplateIdUpdates details about a specific task template in the specified Connect Customer instance. This operation does not support partial updates. Instead it does a…
  • DELETEDelete task template/instance/:InstanceId/task/template/:TaskTemplateIdDeletes the task template.
  • GETDescribe test case/test-cases/:InstanceId/:TestCaseId?status=stringDescribes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.
  • POSTUpdate test case/test-cases/:InstanceId/:TestCaseIdUpdates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers…
  • DELETEDelete test case/test-cases/:InstanceId/:TestCaseIdDeletes the test case that has already been created for the specified Amazon Connect instance.
  • GETDescribe traffic distribution group/traffic-distribution-group/:TrafficDistributionGroupIdGets details and status of a traffic distribution group.
  • DELETEDelete traffic distribution group/traffic-distribution-group/:TrafficDistributionGroupIdDeletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about…
  • DELETEDelete use case/instance/:InstanceId/integration-associations/:IntegrationAssociationId/use-cases/:UseCaseIdDeletes a use case from an integration association.
  • GETDescribe user/users/:InstanceId/:UserIdDescribes the specified user. You can find the instance ID in the Connect Customer console (it’s the final part of the ARN). The console does not display the…
  • DELETEDelete user/users/:InstanceId/:UserIdDeletes a user account from the specified Connect Customer instance. For information about what happens to a user's data when their account is deleted, see…
  • GETDescribe user hierarchy group/user-hierarchy-groups/:InstanceId/:HierarchyGroupIdDescribes the specified hierarchy group.
  • DELETEDelete user hierarchy group/user-hierarchy-groups/:InstanceId/:HierarchyGroupIdDeletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
  • GETDescribe view/views/:InstanceId/:ViewIdRetrieves 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…
  • POSTUpdate view content/views/:InstanceId/:ViewIdUpdates 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…
  • DELETEDelete view/views/:InstanceId/:ViewIdDeletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
  • DELETEDelete view version/views/:InstanceId/:ViewId/versions/:ViewVersionDeletes the particular version specified in ViewVersion identifier.
  • POSTDelete vocabulary/vocabulary-remove/:InstanceId/:VocabularyIdDeletes the vocabulary that has the given identifier.
  • GETDescribe workspace/workspaces/:InstanceId/:WorkspaceIdRetrieves details about a workspace, including its configuration and metadata.
  • DELETEDelete workspace/workspaces/:InstanceId/:WorkspaceIdDeletes a workspace and removes all associated view and resource assignments.
  • GETList workspace media/workspaces/:InstanceId/:WorkspaceId/mediaLists media assets (such as logos) associated with a workspace.
  • POSTImport workspace media/workspaces/:InstanceId/:WorkspaceId/mediaImports a media asset (such as a logo) for use in a workspace.
  • DELETEDelete workspace media/workspaces/:InstanceId/:WorkspaceId/media?mediaType=stringDeletes a media asset (such as a logo) from a workspace.
  • POSTUpdate workspace page/workspaces/:InstanceId/:WorkspaceId/pages/:PageUpdates the configuration of a page in a workspace, including the associated view and input data.
  • DELETEDelete workspace page/workspaces/:InstanceId/:WorkspaceId/pages/:PageRemoves the association between a view and a page in a workspace. The page will display the default view after deletion.
  • GETDescribe agent status/agent-status/:InstanceId/:AgentStatusIdDescribes an agent status.
  • POSTUpdate agent status/agent-status/:InstanceId/:AgentStatusIdUpdates agent status.
  • GETDescribe attached files configuration/attached-files-configurations/:InstanceId/:AttachmentScopeDescribes the attached files configuration for the specified Connect Customer instance and attachment scope. If a custom configuration exists for the…
  • POSTUpdate attached files configuration/attached-files-configurations/:InstanceId/:AttachmentScopeUpdates the attached files configuration for the specified Connect Customer instance and attachment scope. If no instance-specific configuration exists, this…
  • GETDescribe authentication profile/authentication-profiles/:InstanceId/:AuthenticationProfileIdThis API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes…
  • POSTUpdate authentication profile/authentication-profiles/:InstanceId/:AuthenticationProfileIdThis API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the…
  • GETDescribe contact/contacts/:InstanceId/:ContactIdThis API is in preview release for Connect Customer and is subject to change. Describes the specified contact. Use cases Following are common uses cases for…
  • POSTUpdate contact/contacts/:InstanceId/:ContactIdThis API is in preview release for Connect Customer and is subject to change. Adds or updates user-defined contact information associated with the specified…
  • GETDescribe instance attribute/instance/:InstanceId/attribute/:AttributeTypeThis API is in preview release for Connect Customer and is subject to change. Describes the specified instance attribute.
  • POSTUpdate instance attribute/instance/:InstanceId/attribute/:AttributeTypeThis API is in preview release for Connect Customer and is subject to change. Updates the value for the specified attribute type.
  • GETDescribe instance storage config/instance/:InstanceId/storage-config/:AssociationId?resourceType=stringThis API is in preview release for Connect Customer and is subject to change. Retrieves the current storage configurations for the specified resource type,…
  • POSTUpdate instance storage config/instance/:InstanceId/storage-config/:AssociationId?resourceType=stringThis API is in preview release for Connect Customer and is subject to change. Updates an existing configuration for a resource type. This API is idempotent.
  • DELETEDisassociate instance storage config/instance/:InstanceId/storage-config/:AssociationId?resourceType=string&clientToken=stringThis API is in preview release for Connect Customer and is subject to change. Removes the storage type configurations for the specified resource type and…
  • GETDescribe phone number/phone-number/:PhoneNumberIdGets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group. If the number is claimed to a…
  • PUTUpdate phone number/phone-number/:PhoneNumberIdUpdates your claimed phone number from its current Connect Customer instance or traffic distribution group to another Connect Customer instance or traffic…
  • DELETERelease phone number/phone-number/:PhoneNumberId?clientToken=stringReleases a phone number previously claimed to an Connect Customer instance or traffic distribution group. You can call this API only in the Amazon Web…
  • GETDescribe user hierarchy structure/user-hierarchy-structure/:InstanceIdDescribes the hierarchy structure of the specified Connect Customer instance.
  • POSTUpdate user hierarchy structure/user-hierarchy-structure/:InstanceIdUpdates the user hierarchy structure: add, remove, and rename user hierarchy levels.
  • GETDescribe vocabulary/vocabulary/:InstanceId/:VocabularyIdDescribes the specified vocabulary.
  • POSTDisassociate email address alias/email-addresses/:InstanceId/:EmailAddressId/disassociate-aliasRemoves the alias association between two email addresses in an Connect Customer instance. After disassociation, emails sent to the former alias email address…
  • GETGet flow association/flow-associations/:InstanceId/:ResourceId/:ResourceTypeRetrieves the flow associated for a given resource.
  • DELETEDisassociate flow/flow-associations/:InstanceId/:ResourceId/:ResourceTypeDisassociates a connect resource from a flow.
  • POSTDisassociate hours of operations/hours-of-operations/:InstanceId/:HoursOfOperationId/disassociate-hoursDisassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation,…
  • POSTDisassociate queue email addresses/queues/:InstanceId/:QueueId/disassociate-email-addressesRemoves the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as…
  • POSTDisassociate queue quick connects/queues/:InstanceId/:QueueId/disassociate-quick-connectsDisassociates a set of quick connects from a queue.
  • POSTDisassociate routing profile queues/routing-profiles/:InstanceId/:RoutingProfileId/disassociate-queuesDisassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references…
  • DELETEDisassociate security key/instance/:InstanceId/security-key/:AssociationId?clientToken=stringThis API is in preview release for Connect Customer and is subject to change. Deletes the specified security key.
  • POSTDisassociate security profiles/disassociate-security-profiles/:InstanceIdDisassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.
  • POSTDisassociate user proficiencies/users/:InstanceId/:UserId/disassociate-proficienciesDisassociates a set of proficiencies from a user.
  • POSTDisassociate workspace/workspaces/:InstanceId/:WorkspaceId/disassociateRemoves the association between a workspace and one or more users or routing profiles.
  • POSTDismiss user contact/users/:InstanceId/:UserId/contactDismisses 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…
  • POSTEvaluate data table values/data-tables/:InstanceId/:DataTableId/values/evaluate?nextToken=string&maxResults=0Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time…
  • GETGet contact attributes/contact/attributes/:InstanceId/:InitialContactIdRetrieves the contact attributes for the specified contact.
  • POSTGet contact metrics/metrics/contactRetrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing…
  • GETGet cross region routing/cross-region-routing/:InstanceIdRetrieves the current cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing. This operation returns…
  • PUTUpdate cross region routing/cross-region-routing/:InstanceIdUpdates the cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing. When invoked with IsolatedAll set…
  • POSTGet current metric data/metrics/current/:InstanceIdGets the real-time metric data from the specified Connect Customer instance. For a description of each metric, see Metrics definitions in the Connect Customer…
  • POSTGet current user data/metrics/userdata/:InstanceIdGets the real-time active user data from the specified Connect Customer instance.
  • GETGet effective hours of operations/effective-hours-of-operations/:InstanceId/:HoursOfOperationId?fromDate=string&toDate=stringGet the hours of operations with the effective override applied.
  • GETGet evaluation form validation/evaluation-forms/:InstanceId/:EvaluationFormId/validation-results?version=0Retrieves the status and results of a validation process started by StartEvaluationFormValidation . Returns the current execution status ( IN_PROGRESS ,…
  • GETGet federation token/user/federate/:InstanceIdSupports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM…
  • POSTGet metric data/metrics/historical/:InstanceIdGets historical metric data from the specified Connect Customer instance. For a description of each historical metric, see Metrics definitions in the Connect…
  • POSTGet metric data v2/metrics/dataGets metric data from the specified Connect Customer instance. GetMetricDataV2 offers more features than GetMetricData , the previous version of this API. It…
  • GETGet prompt file/prompts/:InstanceId/:PromptId/fileGets the prompt file.
  • GETGet test case execution summary/test-cases/:InstanceId/:TestCaseId/:TestCaseExecutionId/summaryRetrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.
  • GETGet traffic distribution/traffic-distribution/:IdRetrieves the current traffic distribution for a given traffic distribution group.
  • PUTUpdate traffic distribution/traffic-distribution/:IdUpdates the traffic distribution for a given traffic distribution group. When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure…
  • POSTImport phone number/phone-number/importImports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Connect Customer instance. You can call this…
  • GETList analytics data lake data sets/analytics-data/instance/:InstanceId/datasets?nextToken=string&maxResults=0Lists the data lake datasets available to associate with for a given Connect Customer instance.
  • GETList approved origins/instance/:InstanceId/approved-origins?nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all approved origins associated with the instance.
  • GETList associated contacts/contact/associated/:InstanceId?contactId=string&maxResults=0&nextToken=stringProvides information about contact tree, a list of associated contacts with a unique identifier.
  • GETList attached files configurations/attached-files-configurations/:InstanceId?maxResults=0&nextToken=stringProvides summary information about the attached files configurations for the specified Connect Customer instance. This API returns effective configurations…
  • GETList authentication profiles/authentication-profiles-summary/:InstanceId?maxResults=0&nextToken=stringThis API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides…
  • GETList bots/instance/:InstanceId/bots?nextToken=string&maxResults=0&lexVersion=stringThis API is in preview release for Connect Customer and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the…
  • GETList child hours of operations/hours-of-operations/:InstanceId/:HoursOfOperationId/hours?nextToken=string&maxResults=0Provides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations,…
  • GETList contact evaluations/contact-evaluations/:InstanceId?contactId=string&nextToken=stringLists contact evaluations in the specified Connect Customer instance.
  • PUTStart contact evaluation/contact-evaluations/:InstanceIdStarts an empty evaluation in the specified Connect Customer instance, using the given evaluation form for the particular contact. The evaluation form version…
  • GETList contact flow aliases/contact-flows/:InstanceId/:ContactFlowId/aliases?nextToken=string&maxResults=0Lists the aliases associated with a flow, including the version that each alias points to.
  • GETList contact flow module aliases/contact-flow-modules/:InstanceId/:ContactFlowModuleId/aliases?nextToken=string&maxResults=0Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.
  • GETList contact flow module versions/contact-flow-modules/:InstanceId/:ContactFlowModuleId/versions?nextToken=string&maxResults=0Retrieves a paginated list of all versions for a specific contact flow module.
  • GETList contact flow modules/contact-flow-modules-summary/:InstanceId?nextToken=string&maxResults=0&state=stringProvides information about the flow modules for the specified Connect Customer instance.
  • GETList contact flow versions/contact-flows/:InstanceId/:ContactFlowId/versions?nextToken=string&maxResults=0Returns all the available versions for the specified Connect Customer instance and flow identifier.
  • GETList contact flows/contact-flows-summary/:InstanceId?contactFlowTypes=&nextToken=string&maxResults=0Provides information about the flows for the specified Connect Customer instance. You can also create and update flows using the Connect Customer Flow…
  • GETList contact references/contact/references/:InstanceId/:ContactId?referenceTypes=&nextToken=stringThis API is in preview release for Connect Customer and is subject to change. For the specified referenceTypes , returns a list of references associated with…
  • POSTList data table primary values/data-tables/:InstanceId/:DataTableId/values/list-primary?nextToken=string&maxResults=0Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table.…
  • POSTList data table values/data-tables/:InstanceId/:DataTableId/values/list?nextToken=string&maxResults=0Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such…
  • POSTList default vocabularies/default-vocabulary-summary/:InstanceIdLists the default vocabularies for the specified Connect Customer instance.
  • POSTList entity security profiles/entity-security-profiles-summary/:InstanceIdLists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.
  • GETList evaluation form aI versions/instances/:InstanceId/evaluation-form-ai-versions?contactInteractionType=string&maxResults=0&nextToken=stringLists the available AI versions for evaluation forms in the specified Connect Customer instance.
  • GETList evaluation form versions/evaluation-forms/:InstanceId/:EvaluationFormId/versions?maxResults=0&nextToken=stringLists versions of an evaluation form in the specified Connect Customer instance.
  • GETList flow associations/flow-associations-summary/:InstanceId?ResourceType=string&nextToken=string&maxResults=0List the flow association based on the filters.
  • GETList hours of operations/hours-of-operations-summary/:InstanceId?nextToken=string&maxResults=0Provides information about the hours of operation for the specified Connect Customer instance. For more information about hours of operation, see Set the…
  • GETList instance attributes/instance/:InstanceId/attributes?nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all attribute types for the given instance.
  • GETList instance storage configs/instance/:InstanceId/storage-configs?resourceType=string&nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of storage configs for the identified instance and…
  • GETList lambda functions/instance/:InstanceId/lambda-functions?nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown…
  • GETList lex bots/instance/:InstanceId/lex-bots?nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with…
  • GETList phone numbers/phone-numbers-summary/:InstanceId?phoneNumberTypes=&phoneNumberCountryCodes=&nextToken=string&maxResults=0Provides information about the phone numbers for the specified Connect Customer instance. For more information about phone numbers, see Set Up Phone Numbers…
  • POSTList phone numbers v2/phone-number/listLists phone numbers claimed to your Connect Customer instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you…
  • GETList prompts/prompts-summary/:InstanceId?nextToken=string&maxResults=0Provides information about the prompts for the specified Connect Customer instance.
  • GETList queue email addresses/queues/:InstanceId/:QueueId/email-addresses?nextToken=string&maxResults=0Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when…
  • GETList queue quick connects/queues/:InstanceId/:QueueId/quick-connects?nextToken=string&maxResults=0Lists the quick connects associated with a queue.
  • GETList queues/queues-summary/:InstanceId?queueTypes=&nextToken=string&maxResults=0Provides information about the queues for the specified Connect Customer instance. If you do not specify a QueueTypes parameter, both standard and agent…
  • POSTList realtime contact analysis segments v2/contact/list-real-time-analysis-segments-v2/:InstanceId/:ContactIdProvides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. This API does not support VOICE. If you…
  • GETList replication findings/replication-findings/:InstanceId?resourceType=string&maxResults=0&nextToken=stringLists replication findings for resources of a specified resource type in a specified Connect Customer instance. A replication finding describes a single…
  • GETList routing profile manual assignment queues/routing-profiles/:InstanceId/:RoutingProfileId/manual-assignment-queues?nextToken=string&maxResults=0Lists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues…
  • GETList routing profile queues/routing-profiles/:InstanceId/:RoutingProfileId/queues?nextToken=string&maxResults=0Lists the queues associated with a routing profile.
  • POSTUpdate routing profile queues/routing-profiles/:InstanceId/:RoutingProfileId/queuesUpdates the properties associated with a set of queues for a routing profile.
  • GETList routing profiles/routing-profiles-summary/:InstanceId?nextToken=string&maxResults=0Provides summary information about the routing profiles for the specified Connect Customer instance. For more information about routing profiles, see Routing…
  • GETList security keys/instance/:InstanceId/security-keys?nextToken=string&maxResults=0This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all security keys associated with the instance.
  • GETList security profile aI agents/security-profiles-ai-agents/:InstanceId/:SecurityProfileId?nextToken=string&maxResults=0Returns a list of the allowed AI agents in a specific security profile.
  • GETList security profile applications/security-profiles-applications/:InstanceId/:SecurityProfileId?nextToken=string&maxResults=0Returns a list of third-party applications or MCP Servers in a specific security profile.
  • GETList security profile flow modules/security-profiles-flow-modules/:InstanceId/:SecurityProfileId?nextToken=string&maxResults=0A list of Flow Modules an AI Agent can invoke as a tool
  • GETList security profile permissions/security-profiles-permissions/:InstanceId/:SecurityProfileId?nextToken=string&maxResults=0Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Connect Customer Administrator…
  • GETList security profiles/security-profiles-summary/:InstanceId?nextToken=string&maxResults=0Provides summary information about the security profiles for the specified Connect Customer instance. For more information about security profiles, see…
  • GETList tags for resource/tags/:resourceArnLists the tags for the specified resource. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer…
  • POSTTag resource/tags/:resourceArnAdds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent…
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource.
  • GETList test case execution records/test-cases/:InstanceId/:TestCaseId/:TestCaseExecutionId/records?status=string&nextToken=string&maxResults=0Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect…
  • GETList test case executions/test-case-executions/:InstanceId?testCaseId=string&testCaseName=string&startTime=0&endTime=0&status=string&nextToken=string&maxResults=0Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon…
  • GETList test cases/test-cases-summary/:InstanceId?nextToken=string&maxResults=0Lists the test cases present in the specific Amazon Connect instance.
  • GETList traffic distribution groups/traffic-distribution-groups?maxResults=0&nextToken=string&instanceId=stringLists traffic distribution groups.
  • GETList user hierarchy groups/user-hierarchy-groups-summary/:InstanceId?nextToken=string&maxResults=0Provides summary information about the hierarchy groups for the specified Connect Customer instance. For more information about agent hierarchies, see Set Up…
  • GETList user notifications/users/:InstanceId/:UserId/notifications?nextToken=string&maxResults=0Retrieves a paginated list of notifications for a specific user, including the notification status for that user.

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://connect.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
405 operations on 305 pathsPOST 167GET 116PUT 72DELETE 50
Description format
AWS Smithy model, API version 2017-08-08

How to test the Amazon Connect Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Connect Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Activate evaluation form” (POST /evaluation-forms/:InstanceId/:EvaluationFormId/activate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Connect Service?

Amazon Connect now refers to a portfolio of agentic solutions for business functions. The legacy product is now called Amazon Connect Customer, or simply… It is listed under Communication and has 405 endpoints.

Who publishes the Amazon Connect Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Connect Service?

Requests go to https://connect.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Connect Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Connect Service have?

405 operations on 305 paths (167 POST, 116 GET, 72 PUT, 50 DELETE). This listing's collection holds the first 400.

Is forking the Amazon Connect Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.