# Amazon Connect Service API > Amazon Connect Service API on Apizie: 197 endpoints (Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is…, This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to…, This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the…, This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-connect/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:amazonaws-connect` - Category: Cloud - Status: byok - Source: https://github.com/mermade/aws2openapi - Page: https://zieapi.vercel.app/api/cloud/amazonaws-connect - OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-connect/openapi.json Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale. Amazon Connect provides metrics and real-time… ## Endpoints ### Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/activate-evaluation-form` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationFormId | string | yes | The unique identifier for the evaluation form. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-approved-origin` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-bot` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-bot` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-default-vocabulary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | LanguageCode | string | yes | The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe? | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-instance-storage-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-lambda-function` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-lex-bot` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Associates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-phone-number-contact-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | PhoneNumberId | string | yes | A unique identifier for the phone number. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-queue-quick-connects` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | QueueId | string | yes | The identifier for the queue. | | body | object | yes | JSON request body | ### Associates a set of queues with a routing profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-routing-profile-queues` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | RoutingProfileId | string | yes | The identifier of the routing profile. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/associate-security-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/claim-phone-number` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-agent-statuses` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | AgentStatusTypes | array | no | Available agent status types. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-agent-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-contact-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. | | body | object | yes | JSON request body | ### Creates a flow module for the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-contact-flow-module` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Lists evaluation forms in the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-evaluation-forms` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | maxResults | integer | no | The maximum number of results to return per page. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-evaluation-form` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-hours-of-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | body | object | yes | JSON request body | ### Provides summary information about the Amazon Web Services resource associations for the specified Amazon… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-integration-associations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | integrationType | string | no | The integration type. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Creates an Amazon Web Services resource association with an Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-integration-association` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Adds a new participant into an on-going chat contact. For more information, see Customize chat flow… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-participant` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | body | object | yes | JSON request body | ### Creates a prompt. For more information about prompts, such as supported file types and maximum length, see… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-prompt` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-queue` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Provides information about the quick connects for the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-quick-connects` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. The default MaxResult size is 100. | | QuickConnectTypes | array | no | The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following… | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Creates a quick connect for the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-quick-connect` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Creates a new routing profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-routing-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### List all rules for the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-rules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | publishStatus | string | no | The publish status of the rule. | | eventSourceName | string | no | The name of the event source. | | maxResults | integer | no | The maximum number of results to return per page. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Creates a security profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-security-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Lists task templates for the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-task-templates` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. It is not expected that you set this. | | status | string | no | Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked… | | name | string | no | The name of the task template. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Creates a new task template in the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-task-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Creates a traffic distribution group given an Amazon Connect instance that has been replicated. For more… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-traffic-distribution-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | body | object | yes | JSON request body | ### Lists the use cases for the integration association. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-use-cases` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | IntegrationAssociationId | string | yes | The identifier for the integration association. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Creates a use case for an integration association. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-use-case` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | IntegrationAssociationId | string | yes | The identifier for the integration association. | | body | object | yes | JSON request body | ### Creates a user account for the specified Amazon Connect instance. For information about how to create user… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Creates a new user hierarchy group. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-user-hierarchy-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/create-vocabulary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/deactivate-evaluation-form` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationFormId | string | yes | The unique identifier for the evaluation form. | | body | object | yes | JSON request body | ### Describes a contact evaluation in the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-contact-evaluation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationId | string | yes | A unique identifier for the contact evaluation. | ### Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-contact-evaluation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationId | string | yes | A unique identifier for the contact evaluation. | | body | object | yes | JSON request body | ### Deletes a contact evaluation in the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-contact-evaluation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationId | string | yes | A unique identifier for the contact evaluation. | ### Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language . `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-contact-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. | | ContactFlowId | string | yes | The identifier of the flow. | ### Deletes a flow for the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-contact-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | ContactFlowId | string | yes | The identifier of the flow. | ### Describes the specified flow module. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-contact-flow-module` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | ContactFlowModuleId | string | yes | The identifier of the flow module. | ### Deletes the specified flow module. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-contact-flow-module` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | ContactFlowModuleId | string | yes | The identifier of the flow module. | ### Describes an evaluation form in the specified Amazon Connect instance. If the version property is not… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-evaluation-form` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationFormId | string | yes | A unique identifier for the contact evaluation. | | version | integer | no | A version of the evaluation form. | ### Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-evaluation-form` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationFormId | string | yes | The unique identifier for the evaluation form. | | body | object | yes | JSON request body | ### Deletes an evaluation form in the specified Amazon Connect instance. If the version property is provided,… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-evaluation-form` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | EvaluationFormId | string | yes | The unique identifier for the evaluation form. | | version | integer | no | The unique identifier for the evaluation form. | ### This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-hours-of-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | HoursOfOperationId | string | yes | The identifier for the hours of operation. | ### This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-hours-of-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | HoursOfOperationId | string | yes | The identifier of the hours of operation. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-hours-of-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | HoursOfOperationId | string | yes | The identifier for the hours of operation. | ### This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-integration-association` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | IntegrationAssociationId | string | yes | The identifier for the integration association. | ### Describes the prompt. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-prompt` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | PromptId | string | yes | A unique identifier for the prompt. | ### Updates a prompt. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-prompt` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | PromptId | string | yes | A unique identifier for the prompt. | | body | object | yes | JSON request body | ### Deletes a prompt. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-prompt` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | PromptId | string | yes | A unique identifier for the prompt. | ### This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-queue` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | QueueId | string | yes | The identifier for the queue. | ### Deletes a queue. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-queue` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | QueueId | string | yes | The identifier for the queue. | ### Describes the quick connect. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-quick-connect` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | QuickConnectId | string | yes | The identifier for the quick connect. | ### Deletes a quick connect. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-quick-connect` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | QuickConnectId | string | yes | The identifier for the quick connect. | ### Describes the specified routing profile. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-routing-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | RoutingProfileId | string | yes | The identifier of the routing profile. | ### Deletes a routing profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-routing-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | RoutingProfileId | string | yes | The identifier of the routing profile. | ### Describes a rule for the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | RuleId | string | yes | A unique identifier for the rule. | ### Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | RuleId | string | yes | A unique identifier for the rule. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Deletes a rule for the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | RuleId | string | yes | A unique identifier for the rule. | ### This API is in preview release for Amazon Connect and is subject to change. Gets basic information about the… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-security-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | SecurityProfileId | string | yes | The identifier for the security profle. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### This API is in preview release for Amazon Connect and is subject to change. Updates a security profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-security-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | SecurityProfileId | string | yes | The identifier for the security profle. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Deletes a security profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-security-profile` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | SecurityProfileId | string | yes | The identifier for the security profle. | ### Gets details about a specific task template in the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-task-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | TaskTemplateId | string | yes | A unique identifier for the task template. | | snapshotVersion | string | no | The system generated version of a task template that is associated with a task, when the task is created. | ### Updates details about a specific task template in the specified Amazon Connect instance. This operation does… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-task-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | TaskTemplateId | string | yes | A unique identifier for the task template. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Deletes the task template. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-task-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | TaskTemplateId | string | yes | A unique identifier for the task template. | ### Gets details and status of a traffic distribution group. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-traffic-distribution-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | TrafficDistributionGroupId | string | yes | The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic… | ### Deletes a traffic distribution group. This API can be called only in the Region where the traffic… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-traffic-distribution-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | TrafficDistributionGroupId | string | yes | The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic… | ### Deletes a use case from an integration association. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-use-case` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | IntegrationAssociationId | string | yes | The identifier for the integration association. | | UseCaseId | string | yes | The identifier for the use case. | ### Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | UserId | string | yes | The identifier of the user account. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### Deletes a user account from the specified Amazon Connect instance. For information about what happens to a… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-user` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | UserId | string | yes | The identifier of the user. | ### Describes the specified hierarchy group. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-user-hierarchy-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | HierarchyGroupId | string | yes | The identifier of the hierarchy group. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-user-hierarchy-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | HierarchyGroupId | string | yes | The identifier of the hierarchy group. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### Deletes the vocabulary that has the given identifier. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/delete-vocabulary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | VocabularyId | string | yes | The identifier of the custom vocabulary. | ### This API is in preview release for Amazon Connect and is subject to change. Describes an agent status. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-agent-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AgentStatusId | string | yes | The identifier for the agent status. | ### This API is in preview release for Amazon Connect and is subject to change. Updates agent status. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-agent-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AgentStatusId | string | yes | The identifier of the agent status. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact.… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-contact` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | ContactId | string | yes | The identifier of the contact. | ### This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-contact` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | ContactId | string | yes | The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-instance-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AttributeType | string | yes | The type of attribute. | ### This API is in preview release for Amazon Connect and is subject to change. Updates the value for the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-instance-attribute` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AttributeType | string | yes | The type of attribute. Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services… | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-instance-storage-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AssociationId | string | yes | The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. | | resourceType | string | yes | A valid resource type. | ### This API is in preview release for Amazon Connect and is subject to change. Updates an existing… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-instance-storage-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AssociationId | string | yes | The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. | | resourceType | string | yes | A valid resource type. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Removes the storage type… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-instance-storage-config` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AssociationId | string | yes | The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. | | resourceType | string | yes | A valid resource type. | ### Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-phone-number` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | PhoneNumberId | string | yes | A unique identifier for the phone number. | ### Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-phone-number` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | PhoneNumberId | string | yes | A unique identifier for the phone number. | | body | object | yes | JSON request body | ### Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/release-phone-number` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | PhoneNumberId | string | yes | A unique identifier for the phone number. | | clientToken | string | no | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services… | ### Describes the hierarchy structure of the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-user-hierarchy-structure` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-user-hierarchy-structure` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | body | object | yes | JSON request body | ### Describes the specified vocabulary. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/describe-vocabulary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | VocabularyId | string | yes | The identifier of the custom vocabulary. | ### This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-approved-origin` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | origin | string | yes | The domain URL of the integrated application. | ### This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-lambda-function` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.. | | functionArn | string | yes | The Amazon Resource Name (ARN) of the Lambda function being disassociated. | ### This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-lex-bot` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | botName | string | yes | The name of the Amazon Lex bot. Maximum character limit of 50. | | lexRegion | string | yes | The Amazon Web Services Region in which the Amazon Lex bot has been created. | ### Removes the flow association from a phone number claimed to your Amazon Connect instance. If the number is… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-phone-number-contact-flow` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | PhoneNumberId | string | yes | A unique identifier for the phone number. | | instanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-queue-quick-connects` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | QueueId | string | yes | The identifier for the queue. | | body | object | yes | JSON request body | ### Disassociates a set of queues from a routing profile. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-routing-profile-queues` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | RoutingProfileId | string | yes | The identifier of the routing profile. | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/disassociate-security-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | AssociationId | string | yes | The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. | ### Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/dismiss-user-contact` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | UserId | string | yes | The identifier of the user account. | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. | | body | object | yes | JSON request body | ### Retrieves the contact attributes for the specified contact. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-contact-attributes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. | | InitialContactId | string | yes | The identifier of the initial contact. | ### Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric,… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-current-metric-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Gets the real-time active user data from the specified Amazon Connect instance. `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-current-user-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Retrieves a token for federation. This API doesn't support root users. If you try to invoke… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-federation-token` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | ### Gets historical metric data from the specified Amazon Connect instance. For a description of each historical… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-metric-data` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-metric-data-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | | body | object | yes | JSON request body | ### Gets the prompt file. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-prompt-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | PromptId | string | yes | A unique identifier for the prompt. | ### Retrieves the current traffic distribution for a given traffic distribution group. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/get-traffic-distribution` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | Id | string | yes | The identifier of the traffic distribution group. | ### Updates the traffic distribution for a given traffic distribution group. For more information about updating… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/update-traffic-distribution` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | Id | string | yes | The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic… | | body | object | yes | JSON request body | ### This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-approved-origins` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### This API is in preview release for Amazon Connect and is subject to change. For the specified version of… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-bots` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | lexVersion | string | yes | The version of Amazon Lex or Amazon Lex V2. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | ### Lists contact evaluations in the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-contact-evaluations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | contactId | string | yes | The identifier of the contact in this instance of Amazon Connect. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | NextToken | string | no | Pagination token | ### Provides information about the flow modules for the specified Amazon Connect instance. `GET https://zieapi.vercel.app/v1/cloud:amazonaws-connect/list-contact-flow-modules` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | InstanceId | string | yes | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. | | nextToken | string | no | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of… | | maxResults | integer | no | The maximum number of results to return per page. | | state | string | no | The state of the flow module. | | MaxResults | string | no | Pagination limit | | NextToken | string | no | Pagination token | …and 77 more. See the OpenAPI spec. ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:amazonaws-connect/activate-evaluation-form" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Amazon Connect Service API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-connect/activate-evaluation-form with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Amazon Connect Service API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Connect Service itself also needs your own key from amazonaws.com. ### Can AI agents use the Amazon Connect Service API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-connect. ### What is the status of the Amazon Connect Service API? Needs your own provider key (bring your own key)