instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	aws.connect.instances

Fields

The following fields are returned by SELECT queries:

describe_instance

Name	Datatype	Description
instance	object	The name of the instance.
replication_configuration	object	Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Connect Customer instance across Amazon Web Services Regions. For information about replicating Connect Customer instances, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide.

list_instances

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the instance.
created_time	string (date-time)	When the instance was created.
id	string	The identifier of the instance.
identity_management_type	string	The identity management type of the instance. (SAML, CONNECT_MANAGED, EXISTING_DIRECTORY)
inbound_calls_enabled	boolean	Whether inbound calls are enabled.
instance_access_url	string	This URL allows contact center users to access the Connect Customer admin website.
instance_alias	string	The alias of the instance. (pattern: <code>^(?!d-)([\da-zA-Z]+)([-][\da-zA-Z])$</code>)
instance_status	string	The state of the instance. (CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED)
outbound_calls_enabled	boolean	Whether outbound calls are enabled.
service_role	string	The service role of the instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance	select	instance_id, region		This 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 instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
list_instances	select	region	nextToken, maxResults	This 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 state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
create_push_notification_registration	insert	instance_id, region, PinpointAppArn, DeviceToken, DeviceType, ContactConfiguration		Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Connect Customer for mobile chat in the Connect Customer Administrator Guide.
create_persistent_contact_association	insert	instance_id, initial_contact_id, region, RehydrationType, SourceContactId		Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Connect Customer Administrator Guide.
create_auth_code	insert	instance_id, region, Scope, SessionInactivityDurationMinutes		Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters.
create_instance	insert	region, IdentityManagementType, InboundCallsEnabled, OutboundCallsEnabled		This API is in preview release for Connect Customer and is subject to change. Initiates an Connect Customer instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Connect Customer. For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
create_participant	insert	region, InstanceId, ContactId, ParticipantDetails		Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.
associate_flow	update	instance_id, region, ResourceId, FlowId, ResourceType		Associates a connect resource to a flow.
disassociate_flow	update	instance_id, resource_id, resource_type, region		Disassociates a connect resource from a flow.
update_participant_role_config	update	instance_id, contact_id, region, ChannelConfiguration		Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers: Customer idle timeout Customer auto-disconnect timeout Agent idle timeout Agent auto-disconnect timeout For more information about how chat timeouts work, see Set up chat timeouts for human participants.
associate_analytics_data_set	update	instance_id, region, DataSetId		Associates the specified dataset for a Connect Customer instance with the target account. You can associate only one dataset in a single call.
update_participant_authentication	update	region, State, InstanceId		Instructs Connect Customer to resume the authentication process. The subsequent actions depend on the request body contents: If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles. If an error is provided: The error branch of the Authenticate Customer block is executed. The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.
delete_push_notification_registration	delete	instance_id, registration_id, region	contactId	Deletes registration for a device token and a chat contact.
delete_session	delete	instance_id, session_id, region		Deletes a session for the specified Connect Customer instance.
delete_instance	delete	instance_id, region	clientToken	This API is in preview release for Connect Customer and is subject to change. Deletes the Connect Customer instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
disassociate_analytics_data_set	exec	instance_id, region, DataSetId		Removes the dataset ID associated with a given Connect Customer instance.
batch_associate_analytics_data_set	exec	instance_id, region, DataSetIds		Associates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call.
batch_disassociate_analytics_data_set	exec	instance_id, region, DataSetIds		Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call.
batch_put_contact	exec	instance_id, region, ContactDataRequestList		Only 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 contacts in Connect Customer. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
complete_attached_file_upload	exec	instance_id, file_id, associatedResourceArn, region		Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
dismiss_user_contact	exec	user_id, instance_id, region, ContactId		Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
import_phone_number	exec	region, InstanceId, SourcePhoneNumberArn		Imports 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 API only in the same Amazon Web Services Region where the Connect Customer instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
monitor_contact	exec	region, InstanceId, ContactId, UserId		Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
pause_contact	exec	region, ContactId, InstanceId		Allows pausing an ongoing task contact.
replicate_instance	exec	instance_id, region, ReplicaRegion, ReplicaAlias		Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions. For more information about replicating an Connect Customer instance, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide.
resume_contact	exec	region, ContactId, InstanceId		Allows resuming a task contact in a paused state.
send_outbound_email	exec	instance_id, region, FromEmailAddress, DestinationEmailAddress, EmailMessage, TrafficType		Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns. Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.
send_outbound_web_notification	exec	instance_id, region, BrowserId, SessionId, ExpiresAt, Source, Destination, Content		Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns. Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.
start_assistant_contact	exec	region, InstanceId, AiAgent, ParticipantDetails		Starts a chat contact with an AI agent. Use the returned ParticipantToken with the CreateParticipantConnection operation. For more information about chat, see the following topics in the Connect Customer Administrator Guide: Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices
start_email_contact	exec	region, InstanceId, FromEmailAddress, DestinationEmailAddress, EmailMessage		Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
start_outbound_email_contact	exec	region, InstanceId, ContactId, DestinationEmailAddress, EmailMessage		Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
start_screen_sharing	exec	region, InstanceId, ContactId		Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide.
start_task_contact	exec	region, InstanceId, Name		Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Connect Customer in the Connect Customer Administrator Guide. When using PreviousContactId and RelatedContactId input parameters, note the following: PreviousContactId Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId. RelatedContactId Copies contact attributes from the related task contact to the new contact. Any update on attributes in a new task contact does not update attributes on previous contact. There’s no limit on the number of task contacts that can be created that use the same RelatedContactId. In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Connect Customer cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Connect Customer service quotas in the Connect Customer Administrator Guide.
stop_contact	exec	region, ContactId, InstanceId		Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER EXTERNAL_OUTBOUND MONITOR Chat and task contacts can be terminated in any state, regardless of initiation method.
suspend_contact_recording	exec	region, InstanceId, ContactId, InitialContactId		When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice (IVR, agent) and screen recordings are supported.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
associatedResourceArn	string	The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task. This value must be a valid ARN.
contact_id	string	The identifier of the contact in this instance of Connect Customer.
file_id	string	The unique identifier of the attached file resource.
initial_contact_id	string	This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
registration_id	string	The identifier for the registration.
resource_id	string	The identifier of the resource. Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER
resource_type	string	A valid resource type.
session_id	string	The identifier of the session to delete.
user_id	string	The identifier of the user account.
clientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
contactId	string	The identifier of the contact within the Connect Customer instance.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

describe_instance

This 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 instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

SELECT
instance,
replication_configuration
FROM aws.connect.instances
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_instances

This 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 state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

SELECT
arn,
created_time,
id,
identity_management_type,
inbound_calls_enabled,
instance_access_url,
instance_alias,
instance_status,
outbound_calls_enabled,
service_role
FROM aws.connect.instances
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_push_notification_registration

Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Connect Customer for mobile chat in the Connect Customer Administrator Guide.

INSERT INTO aws.connect.instances (
ClientToken,
PinpointAppArn,
DeviceToken,
DeviceType,
ContactConfiguration,
instance_id,
region
)
SELECT 
'{{ ClientToken }}',
'{{ PinpointAppArn }}' /* required */,
'{{ DeviceToken }}' /* required */,
'{{ DeviceType }}' /* required */,
'{{ ContactConfiguration }}' /* required */,
'{{ instance_id }}',
'{{ region }}'
RETURNING
registration_id
;

create_persistent_contact_association

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Connect Customer Administrator Guide.

INSERT INTO aws.connect.instances (
RehydrationType,
SourceContactId,
ClientToken,
instance_id,
initial_contact_id,
region
)
SELECT 
'{{ RehydrationType }}' /* required */,
'{{ SourceContactId }}' /* required */,
'{{ ClientToken }}',
'{{ instance_id }}',
'{{ initial_contact_id }}',
'{{ region }}'
RETURNING
continued_from_contact_id
;

create_auth_code

Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters.

INSERT INTO aws.connect.instances (
Scope,
MaxSessionDurationMinutes,
SessionInactivityDurationMinutes,
instance_id,
region
)
SELECT 
'{{ Scope }}' /* required */,
{{ MaxSessionDurationMinutes }},
{{ SessionInactivityDurationMinutes }} /* required */,
'{{ instance_id }}',
'{{ region }}'
RETURNING
auth_code,
entity_id,
entity_type,
session_id
;

create_instance

This API is in preview release for Connect Customer and is subject to change. Initiates an Connect Customer instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Connect Customer. For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

INSERT INTO aws.connect.instances (
ClientToken,
IdentityManagementType,
InstanceAlias,
DirectoryId,
InboundCallsEnabled,
OutboundCallsEnabled,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ IdentityManagementType }}' /* required */,
'{{ InstanceAlias }}',
'{{ DirectoryId }}',
{{ InboundCallsEnabled }} /* required */,
{{ OutboundCallsEnabled }} /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
id
;

create_participant

Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.

INSERT INTO aws.connect.instances (
InstanceId,
ContactId,
ClientToken,
ParticipantDetails,
region
)
SELECT 
'{{ InstanceId }}' /* required */,
'{{ ContactId }}' /* required */,
'{{ ClientToken }}',
'{{ ParticipantDetails }}' /* required */,
'{{ region }}'
RETURNING
participant_credentials,
participant_id
;

Manifest

# Description fields are for documentation purposes
- name: instances
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the instances resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the instances resource.
  - name: initial_contact_id
    value: "{{ initial_contact_id }}"
    description: Required parameter for the instances resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: PinpointAppArn
    value: "{{ PinpointAppArn }}"
  - name: DeviceToken
    value: "{{ DeviceToken }}"
  - name: DeviceType
    value: "{{ DeviceType }}"
    valid_values: ['GCM', 'APNS', 'APNS_SANDBOX']
  - name: ContactConfiguration
    description: |
      The contact configuration for push notification registration.
    value:
      ContactId: "{{ ContactId }}"
      ParticipantRole: "{{ ParticipantRole }}"
      IncludeRawMessage: {{ IncludeRawMessage }}
  - name: RehydrationType
    value: "{{ RehydrationType }}"
    valid_values: ['ENTIRE_PAST_SESSION', 'FROM_SEGMENT']
  - name: SourceContactId
    value: "{{ SourceContactId }}"
  - name: Scope
    description: |
      Contains the scope configuration for an authorization code. Defines the permissions and access boundaries for the session.
    value:
      SecurityProfileIds:
        - "{{ SecurityProfileIds }}"
      EntityType: "{{ EntityType }}"
      EntityId: "{{ EntityId }}"
      DomainName: "{{ DomainName }}"
  - name: MaxSessionDurationMinutes
    value: {{ MaxSessionDurationMinutes }}
  - name: SessionInactivityDurationMinutes
    value: {{ SessionInactivityDurationMinutes }}
  - name: IdentityManagementType
    value: "{{ IdentityManagementType }}"
    valid_values: ['SAML', 'CONNECT_MANAGED', 'EXISTING_DIRECTORY']
  - name: InstanceAlias
    value: "{{ InstanceAlias }}"
  - name: DirectoryId
    value: "{{ DirectoryId }}"
  - name: InboundCallsEnabled
    value: {{ InboundCallsEnabled }}
  - name: OutboundCallsEnabled
    value: {{ OutboundCallsEnabled }}
  - name: Tags
    value: "{{ Tags }}"
  - name: InstanceId
    value: "{{ InstanceId }}"
  - name: ContactId
    value: "{{ ContactId }}"
  - name: ParticipantDetails
    description: |
      The details to add for the participant.
    value:
      ParticipantRole: "{{ ParticipantRole }}"
      DisplayName: "{{ DisplayName }}"
      ParticipantCapabilities:
        Video: "{{ Video }}"
        ScreenShare: "{{ ScreenShare }}"

UPDATE examples

associate_flow

Associates a connect resource to a flow.

UPDATE aws.connect.instances
SET 
ResourceId = '{{ ResourceId }}',
FlowId = '{{ FlowId }}',
ResourceType = '{{ ResourceType }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND ResourceId = '{{ ResourceId }}' --required
AND FlowId = '{{ FlowId }}' --required
AND ResourceType = '{{ ResourceType }}' --required;

disassociate_flow

Disassociates a connect resource from a flow.

UPDATE aws.connect.instances
SET 
-- No updatable properties
WHERE 
instance_id = '{{ instance_id }}' --required
AND resource_id = '{{ resource_id }}' --required
AND resource_type = '{{ resource_type }}' --required
AND region = '{{ region }}' --required;

update_participant_role_config

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers: Customer idle timeout Customer auto-disconnect timeout Agent idle timeout Agent auto-disconnect timeout For more information about how chat timeouts work, see Set up chat timeouts for human participants.

UPDATE aws.connect.instances
SET 
ChannelConfiguration = '{{ ChannelConfiguration }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND contact_id = '{{ contact_id }}' --required
AND region = '{{ region }}' --required
AND ChannelConfiguration = '{{ ChannelConfiguration }}' --required;

associate_analytics_data_set

Associates the specified dataset for a Connect Customer instance with the target account. You can associate only one dataset in a single call.

UPDATE aws.connect.instances
SET 
DataSetId = '{{ DataSetId }}',
TargetAccountId = '{{ TargetAccountId }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND DataSetId = '{{ DataSetId }}' --required
RETURNING
data_set_id,
resource_share_arn,
resource_share_id,
target_account_id;

update_participant_authentication

Instructs Connect Customer to resume the authentication process. The subsequent actions depend on the request body contents: If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles. If an error is provided: The error branch of the Authenticate Customer block is executed. The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.

UPDATE aws.connect.instances
SET 
State = '{{ State }}',
InstanceId = '{{ InstanceId }}',
Code = '{{ Code }}',
Error = '{{ Error }}',
ErrorDescription = '{{ ErrorDescription }}'
WHERE 
region = '{{ region }}' --required
AND State = '{{ State }}' --required
AND InstanceId = '{{ InstanceId }}' --required;

DELETE examples

delete_push_notification_registration

Deletes registration for a device token and a chat contact.

DELETE FROM aws.connect.instances
WHERE instance_id = '{{ instance_id }}' --required
AND registration_id = '{{ registration_id }}' --required
AND region = '{{ region }}' --required
AND contactId = '{{ contactId }}'
;

delete_session

Deletes a session for the specified Connect Customer instance.

DELETE FROM aws.connect.instances
WHERE instance_id = '{{ instance_id }}' --required
AND session_id = '{{ session_id }}' --required
AND region = '{{ region }}' --required
;

delete_instance

This API is in preview release for Connect Customer and is subject to change. Deletes the Connect Customer instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide. Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

DELETE FROM aws.connect.instances
WHERE instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;

Lifecycle Methods

disassociate_analytics_data_set

Removes the dataset ID associated with a given Connect Customer instance.

EXEC aws.connect.instances.disassociate_analytics_data_set 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"DataSetId": "{{ DataSetId }}", 
"TargetAccountId": "{{ TargetAccountId }}"
}'
;

batch_associate_analytics_data_set

Associates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call.

EXEC aws.connect.instances.batch_associate_analytics_data_set 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"DataSetIds": "{{ DataSetIds }}", 
"TargetAccountId": "{{ TargetAccountId }}"
}'
;

batch_disassociate_analytics_data_set

Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call.

EXEC aws.connect.instances.batch_disassociate_analytics_data_set 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"DataSetIds": "{{ DataSetIds }}", 
"TargetAccountId": "{{ TargetAccountId }}"
}'
;

batch_put_contact

Only 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 contacts in Connect Customer. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

EXEC aws.connect.instances.batch_put_contact 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ClientToken": "{{ ClientToken }}", 
"ContactDataRequestList": "{{ ContactDataRequestList }}"
}'
;

complete_attached_file_upload

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

EXEC aws.connect.instances.complete_attached_file_upload 
@instance_id='{{ instance_id }}' --required, 
@file_id='{{ file_id }}' --required, 
@associatedResourceArn='{{ associatedResourceArn }}' --required, 
@region='{{ region }}' --required
;

dismiss_user_contact

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

EXEC aws.connect.instances.dismiss_user_contact 
@user_id='{{ user_id }}' --required, 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ContactId": "{{ ContactId }}"
}'
;

import_phone_number

Imports 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 API only in the same Amazon Web Services Region where the Connect Customer instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.

EXEC aws.connect.instances.import_phone_number 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"SourcePhoneNumberArn": "{{ SourcePhoneNumberArn }}", 
"PhoneNumberDescription": "{{ PhoneNumberDescription }}", 
"Tags": "{{ Tags }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

monitor_contact

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

EXEC aws.connect.instances.monitor_contact 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"ContactId": "{{ ContactId }}", 
"UserId": "{{ UserId }}", 
"AllowedMonitorCapabilities": "{{ AllowedMonitorCapabilities }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

pause_contact

Allows pausing an ongoing task contact.

EXEC aws.connect.instances.pause_contact 
@region='{{ region }}' --required 
@@json=
'{
"ContactId": "{{ ContactId }}", 
"InstanceId": "{{ InstanceId }}", 
"ContactFlowId": "{{ ContactFlowId }}"
}'
;

replicate_instance

Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions. For more information about replicating an Connect Customer instance, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide.

EXEC aws.connect.instances.replicate_instance 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ReplicaRegion": "{{ ReplicaRegion }}", 
"ClientToken": "{{ ClientToken }}", 
"ReplicaAlias": "{{ ReplicaAlias }}"
}'
;

resume_contact

Allows resuming a task contact in a paused state.

EXEC aws.connect.instances.resume_contact 
@region='{{ region }}' --required 
@@json=
'{
"ContactId": "{{ ContactId }}", 
"InstanceId": "{{ InstanceId }}", 
"ContactFlowId": "{{ ContactFlowId }}"
}'
;

send_outbound_email

Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns. Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

EXEC aws.connect.instances.send_outbound_email 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"FromEmailAddress": "{{ FromEmailAddress }}", 
"DestinationEmailAddress": "{{ DestinationEmailAddress }}", 
"AdditionalRecipients": "{{ AdditionalRecipients }}", 
"EmailMessage": "{{ EmailMessage }}", 
"TrafficType": "{{ TrafficType }}", 
"SourceCampaign": "{{ SourceCampaign }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

send_outbound_web_notification

Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns. Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

EXEC aws.connect.instances.send_outbound_web_notification 
@instance_id='{{ instance_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ClientToken": "{{ ClientToken }}", 
"BrowserId": "{{ BrowserId }}", 
"SessionId": "{{ SessionId }}", 
"ExpiresAt": "{{ ExpiresAt }}", 
"Source": "{{ Source }}", 
"Destination": "{{ Destination }}", 
"Content": "{{ Content }}"
}'
;

start_assistant_contact

Starts a chat contact with an AI agent. Use the returned ParticipantToken with the CreateParticipantConnection operation. For more information about chat, see the following topics in the Connect Customer Administrator Guide: Concepts: Web and mobile messaging capabilities in Connect Customer Connect Customer Chat security best practices

EXEC aws.connect.instances.start_assistant_contact 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"AiAgent": "{{ AiAgent }}", 
"ParticipantDetails": "{{ ParticipantDetails }}", 
"InitialMessage": "{{ InitialMessage }}", 
"Attributes": "{{ Attributes }}", 
"ClientToken": "{{ ClientToken }}", 
"PersistentChat": "{{ PersistentChat }}", 
"RelatedContactId": "{{ RelatedContactId }}"
}'
;

start_email_contact

Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.

EXEC aws.connect.instances.start_email_contact 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"FromEmailAddress": "{{ FromEmailAddress }}", 
"DestinationEmailAddress": "{{ DestinationEmailAddress }}", 
"Description": "{{ Description }}", 
"References": "{{ References }}", 
"Name": "{{ Name }}", 
"EmailMessage": "{{ EmailMessage }}", 
"AdditionalRecipients": "{{ AdditionalRecipients }}", 
"Attachments": "{{ Attachments }}", 
"ContactFlowId": "{{ ContactFlowId }}", 
"RelatedContactId": "{{ RelatedContactId }}", 
"Attributes": "{{ Attributes }}", 
"SegmentAttributes": "{{ SegmentAttributes }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

start_outbound_email_contact

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

EXEC aws.connect.instances.start_outbound_email_contact 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"ContactId": "{{ ContactId }}", 
"FromEmailAddress": "{{ FromEmailAddress }}", 
"DestinationEmailAddress": "{{ DestinationEmailAddress }}", 
"AdditionalRecipients": "{{ AdditionalRecipients }}", 
"EmailMessage": "{{ EmailMessage }}", 
"ClientToken": "{{ ClientToken }}"
}'
;

start_screen_sharing

Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide.

EXEC aws.connect.instances.start_screen_sharing 
@region='{{ region }}' --required 
@@json=
'{
"ClientToken": "{{ ClientToken }}", 
"InstanceId": "{{ InstanceId }}", 
"ContactId": "{{ ContactId }}"
}'
;

start_task_contact

Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Connect Customer in the Connect Customer Administrator Guide. When using PreviousContactId and RelatedContactId input parameters, note the following: PreviousContactId Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId. RelatedContactId Copies contact attributes from the related task contact to the new contact. Any update on attributes in a new task contact does not update attributes on previous contact. There’s no limit on the number of task contacts that can be created that use the same RelatedContactId. In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Connect Customer cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Connect Customer service quotas in the Connect Customer Administrator Guide.

EXEC aws.connect.instances.start_task_contact 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"PreviousContactId": "{{ PreviousContactId }}", 
"ContactFlowId": "{{ ContactFlowId }}", 
"Attributes": "{{ Attributes }}", 
"Name": "{{ Name }}", 
"References": "{{ References }}", 
"Description": "{{ Description }}", 
"ClientToken": "{{ ClientToken }}", 
"ScheduledTime": "{{ ScheduledTime }}", 
"TaskTemplateId": "{{ TaskTemplateId }}", 
"QuickConnectId": "{{ QuickConnectId }}", 
"RelatedContactId": "{{ RelatedContactId }}", 
"SegmentAttributes": "{{ SegmentAttributes }}", 
"Attachments": "{{ Attachments }}"
}'
;

stop_contact

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER EXTERNAL_OUTBOUND MONITOR Chat and task contacts can be terminated in any state, regardless of initiation method.

EXEC aws.connect.instances.stop_contact 
@region='{{ region }}' --required 
@@json=
'{
"ContactId": "{{ ContactId }}", 
"InstanceId": "{{ InstanceId }}", 
"DisconnectReason": "{{ DisconnectReason }}"
}'
;

suspend_contact_recording

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice (IVR, agent) and screen recordings are supported.

EXEC aws.connect.instances.suspend_contact_recording 
@region='{{ region }}' --required 
@@json=
'{
"InstanceId": "{{ InstanceId }}", 
"ContactId": "{{ ContactId }}", 
"InitialContactId": "{{ InitialContactId }}", 
"ContactRecordingType": "{{ ContactRecordingType }}"
}'
;