Connect

This page documents function available when using the Connect module, created with @service Connect.

Index

Documentation

Main.Connect.associate_approved_originMethod
associate_approved_origin(instance_id, origin)
associate_approved_origin(instance_id, origin, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • origin: The domain to add to your allow list.
source
Main.Connect.associate_botMethod
associate_bot(instance_id)
associate_bot(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "LexBot":
  • "LexV2Bot": The Amazon Lex V2 bot to associate with the instance.
source
Main.Connect.associate_default_vocabularyMethod
associate_default_vocabulary(instance_id, language_code)
associate_default_vocabulary(instance_id, language_code, params::Dict{String,<:Any})

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • language_code: The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "VocabularyId": The identifier of the custom vocabulary. If this is empty, the default is set to none.
source
Main.Connect.associate_instance_storage_configMethod
associate_instance_storage_config(instance_id, resource_type, storage_config)
associate_instance_storage_config(instance_id, resource_type, storage_config, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • resource_type: A valid resource type.
  • storage_config: A valid storage type.
source
Main.Connect.associate_lambda_functionMethod
associate_lambda_function(function_arn, instance_id)
associate_lambda_function(function_arn, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function.

Arguments

  • function_arn: The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.associate_lex_botMethod
associate_lex_bot(instance_id, lex_bot)
associate_lex_bot(instance_id, lex_bot, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • lex_bot: The Amazon Lex bot to associate with the instance.
source
Main.Connect.associate_phone_number_contact_flowMethod
associate_phone_number_contact_flow(contact_flow_id, instance_id, phone_number_id)
associate_phone_number_contact_flow(contact_flow_id, instance_id, phone_number_id, params::Dict{String,<:Any})

Associates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Arguments

  • contact_flow_id: The identifier of the flow.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • phone_number_id: A unique identifier for the phone number.
source
Main.Connect.associate_queue_quick_connectsMethod
associate_queue_quick_connects(instance_id, queue_id, quick_connect_ids)
associate_queue_quick_connects(instance_id, queue_id, quick_connect_ids, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.
  • quick_connect_ids: The quick connects to associate with this queue.
source
Main.Connect.associate_routing_profile_queuesMethod
associate_routing_profile_queues(instance_id, queue_configs, routing_profile_id)
associate_routing_profile_queues(instance_id, queue_configs, routing_profile_id, params::Dict{String,<:Any})

Associates a set of queues with a routing profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_configs: The queues to associate with this routing profile.
  • routing_profile_id: The identifier of the routing profile.
source
Main.Connect.associate_security_keyMethod
associate_security_key(instance_id, key)
associate_security_key(instance_id, key, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • key: A valid security key in PEM format.
source
Main.Connect.claim_phone_numberMethod
claim_phone_number(phone_number, target_arn)
claim_phone_number(phone_number, target_arn, params::Dict{String,<:Any})

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

Arguments

  • phone_number: The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].
  • target_arn: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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. Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
  • "PhoneNumberDescription": The description of the phone number.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_agent_statusMethod
create_agent_status(instance_id, name, state)
create_agent_status(instance_id, name, state, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the status.
  • state: The state of the status.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the status.
  • "DisplayOrder": The display order of the status.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_contact_flowMethod
create_contact_flow(content, instance_id, name, type)
create_contact_flow(content, instance_id, name, type, params::Dict{String,<:Any})

Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language.

Arguments

  • content: The content of the flow.
  • instance_id: The identifier of the Amazon Connect instance.
  • name: The name of the flow.
  • type: The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the flow.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_contact_flow_moduleMethod
create_contact_flow_module(content, instance_id, name)
create_contact_flow_module(content, instance_id, name, params::Dict{String,<:Any})

Creates a flow module for the specified Amazon Connect instance.

Arguments

  • content: The content of the flow module.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the flow module.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
  • "Description": The description of the flow module.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_hours_of_operationMethod
create_hours_of_operation(config, instance_id, name, time_zone)
create_hours_of_operation(config, instance_id, name, time_zone, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation.

Arguments

  • config: Configuration information for the hours of operation: day, start time, and end time.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the hours of operation.
  • time_zone: The time zone of the hours of operation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the hours of operation.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_instanceMethod
create_instance(identity_management_type, inbound_calls_enabled, outbound_calls_enabled)
create_instance(identity_management_type, inbound_calls_enabled, outbound_calls_enabled, params::Dict{String,<:Any})

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

Arguments

  • identity_management_type: The type of identity management for your Amazon Connect users.
  • inbound_calls_enabled: Your contact center handles incoming contacts.
  • outbound_calls_enabled: Your contact center allows outbound calls.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": The idempotency token.
  • "DirectoryId": The identifier for the directory.
  • "InstanceAlias": The name for your instance.
source
Main.Connect.create_integration_associationMethod
create_integration_association(instance_id, integration_arn, integration_type)
create_integration_association(instance_id, integration_arn, integration_type, params::Dict{String,<:Any})

Creates an Amazon Web Services resource association with an Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • integration_arn: The Amazon Resource Name (ARN) of the integration. When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
  • integration_type: The type of information to be ingested.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SourceApplicationName": The name of the external application. This field is only required for the EVENT integration type.
  • "SourceApplicationUrl": The URL for the external application. This field is only required for the EVENT integration type.
  • "SourceType": The type of the data source. This field is only required for the EVENT integration type.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_queueMethod
create_queue(hours_of_operation_id, instance_id, name)
create_queue(hours_of_operation_id, instance_id, name, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Arguments

  • hours_of_operation_id: The identifier for the hours of operation.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the queue.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the queue.
  • "MaxContacts": The maximum number of contacts that can be in the queue before it is considered full.
  • "OutboundCallerConfig": The outbound caller ID name, number, and outbound whisper flow.
  • "QuickConnectIds": The quick connects available to agents who are working the queue.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_quick_connectMethod
create_quick_connect(instance_id, name, quick_connect_config)
create_quick_connect(instance_id, name, quick_connect_config, params::Dict{String,<:Any})

Creates a quick connect for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the quick connect.
  • quick_connect_config: Configuration settings for the quick connect.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the quick connect.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_routing_profileMethod
create_routing_profile(default_outbound_queue_id, description, instance_id, media_concurrencies, name)
create_routing_profile(default_outbound_queue_id, description, instance_id, media_concurrencies, name, params::Dict{String,<:Any})

Creates a new routing profile.

Arguments

  • default_outbound_queue_id: The default outbound queue for the routing profile.
  • description: Description of the routing profile. Must not be more than 250 characters.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • media_concurrencies: The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
  • name: The name of the routing profile. Must not be more than 127 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "QueueConfigs": The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_ruleMethod
create_rule(actions, function, instance_id, name, publish_status, trigger_event_source)
create_rule(actions, function, instance_id, name, publish_status, trigger_event_source, params::Dict{String,<:Any})

Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.

Arguments

  • actions: A list of actions to be run when the rule is triggered.
  • function: The conditions of the rule.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: A unique name for the rule.
  • publish_status: The publish status of the rule.
  • trigger_event_source: The event source to trigger the rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
source
Main.Connect.create_security_profileMethod
create_security_profile(instance_id, security_profile_name)
create_security_profile(instance_id, security_profile_name, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Creates a security profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • security_profile_name: The name of the security profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AllowedAccessControlTags": The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
  • "Description": The description of the security profile.
  • "Permissions": Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
  • "TagRestrictedResources": The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_task_templateMethod
create_task_template(fields, instance_id, name)
create_task_template(fields, instance_id, name, params::Dict{String,<:Any})

Creates a new task template in the specified Amazon Connect instance.

Arguments

  • fields: Fields that are part of the template.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the task template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
  • "Constraints": Constraints that are applicable to the fields listed.
  • "ContactFlowId": The identifier of the flow that runs by default when a task is created by referencing this template.
  • "Defaults": The default values for fields when a task is created by referencing this template.
  • "Description": The description of the task template.
  • "Status": 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 as INACTIVE, then a task that refers to this template cannot be created.
source
Main.Connect.create_traffic_distribution_groupMethod
create_traffic_distribution_group(instance_id, name)
create_traffic_distribution_group(instance_id, name, params::Dict{String,<:Any})

Creates a traffic distribution group given an Amazon Connect instance that has been replicated. For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.
  • name: The name for the traffic distribution group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
  • "Description": A description for the traffic distribution group.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_use_caseMethod
create_use_case(instance_id, integration_association_id, use_case_type)
create_use_case(instance_id, integration_association_id, use_case_type, params::Dict{String,<:Any})

Creates a use case for an integration association.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • integration_association_id: The identifier for the integration association.
  • use_case_type: The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_userMethod
create_user(instance_id, phone_config, routing_profile_id, security_profile_ids, username)
create_user(instance_id, phone_config, routing_profile_id, security_profile_ids, username, params::Dict{String,<:Any})

Creates a user account for the specified Amazon Connect instance. For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • phone_config: The phone settings for the user.
  • routing_profile_id: The identifier of the routing profile for the user.
  • security_profile_ids: The identifier of the security profile for the user.
  • username: The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DirectoryUserId": The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
  • "HierarchyGroupId": The identifier of the hierarchy group for the user.
  • "IdentityInfo": The information about the identity of the user.
  • "Password": The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_user_hierarchy_groupMethod
create_user_hierarchy_group(instance_id, name)
create_user_hierarchy_group(instance_id, name, params::Dict{String,<:Any})

Creates a new user hierarchy group.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the user hierarchy group. Must not be more than 100 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ParentGroupId": The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.create_vocabularyMethod
create_vocabulary(content, instance_id, language_code, vocabulary_name)
create_vocabulary(content, instance_id, language_code, vocabulary_name, params::Dict{String,<:Any})

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Arguments

  • content: The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • language_code: The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
  • vocabulary_name: A unique name of the custom vocabulary.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
  • "Tags": The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.delete_contact_flowMethod
delete_contact_flow(contact_flow_id, instance_id)
delete_contact_flow(contact_flow_id, instance_id, params::Dict{String,<:Any})

Deletes a flow for the specified Amazon Connect instance.

Arguments

  • contact_flow_id: The identifier of the flow.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.delete_contact_flow_moduleMethod
delete_contact_flow_module(contact_flow_module_id, instance_id)
delete_contact_flow_module(contact_flow_module_id, instance_id, params::Dict{String,<:Any})

Deletes the specified flow module.

Arguments

  • contact_flow_module_id: The identifier of the flow module.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.delete_hours_of_operationMethod
delete_hours_of_operation(hours_of_operation_id, instance_id)
delete_hours_of_operation(hours_of_operation_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation.

Arguments

  • hours_of_operation_id: The identifier for the hours of operation.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.delete_instanceMethod
delete_instance(instance_id)
delete_instance(instance_id, params::Dict{String,<:Any})

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

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.delete_integration_associationMethod
delete_integration_association(instance_id, integration_association_id)
delete_integration_association(instance_id, integration_association_id, params::Dict{String,<:Any})

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • integration_association_id: The identifier for the integration association.
source
Main.Connect.delete_quick_connectMethod
delete_quick_connect(instance_id, quick_connect_id)
delete_quick_connect(instance_id, quick_connect_id, params::Dict{String,<:Any})

Deletes a quick connect.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • quick_connect_id: The identifier for the quick connect.
source
Main.Connect.delete_ruleMethod
delete_rule(instance_id, rule_id)
delete_rule(instance_id, rule_id, params::Dict{String,<:Any})

Deletes a rule for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • rule_id: A unique identifier for the rule.
source
Main.Connect.delete_security_profileMethod
delete_security_profile(instance_id, security_profile_id)
delete_security_profile(instance_id, security_profile_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Deletes a security profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • security_profile_id: The identifier for the security profle.
source
Main.Connect.delete_task_templateMethod
delete_task_template(instance_id, task_template_id)
delete_task_template(instance_id, task_template_id, params::Dict{String,<:Any})

Deletes the task template.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • task_template_id: A unique identifier for the task template.
source
Main.Connect.delete_traffic_distribution_groupMethod
delete_traffic_distribution_group(traffic_distribution_group_id)
delete_traffic_distribution_group(traffic_distribution_group_id, params::Dict{String,<:Any})

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

Arguments

  • traffic_distribution_group_id: 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 distribution group was created. The ARN must be provided if the call is from the replicated Region.
source
Main.Connect.delete_use_caseMethod
delete_use_case(instance_id, integration_association_id, use_case_id)
delete_use_case(instance_id, integration_association_id, use_case_id, params::Dict{String,<:Any})

Deletes a use case from an integration association.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • integration_association_id: The identifier for the integration association.
  • use_case_id: The identifier for the use case.
source
Main.Connect.delete_userMethod
delete_user(instance_id, user_id)
delete_user(instance_id, user_id, params::Dict{String,<:Any})

Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user.
source
Main.Connect.delete_user_hierarchy_groupMethod
delete_user_hierarchy_group(hierarchy_group_id, instance_id)
delete_user_hierarchy_group(hierarchy_group_id, instance_id, params::Dict{String,<:Any})

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

Arguments

  • hierarchy_group_id: The identifier of the hierarchy group.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.delete_vocabularyMethod
delete_vocabulary(instance_id, vocabulary_id)
delete_vocabulary(instance_id, vocabulary_id, params::Dict{String,<:Any})

Deletes the vocabulary that has the given identifier.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • vocabulary_id: The identifier of the custom vocabulary.
source
Main.Connect.describe_agent_statusMethod
describe_agent_status(agent_status_id, instance_id)
describe_agent_status(agent_status_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Describes an agent status.

Arguments

  • agent_status_id: The identifier for the agent status.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_contactMethod
describe_contact(contact_id, instance_id)
describe_contact(contact_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API.

Arguments

  • contact_id: The identifier of the contact.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_contact_flowMethod
describe_contact_flow(contact_flow_id, instance_id)
describe_contact_flow(contact_flow_id, instance_id, params::Dict{String,<:Any})

Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language.

Arguments

  • contact_flow_id: The identifier of the flow.
  • instance_id: The identifier of the Amazon Connect instance.
source
Main.Connect.describe_contact_flow_moduleMethod
describe_contact_flow_module(contact_flow_module_id, instance_id)
describe_contact_flow_module(contact_flow_module_id, instance_id, params::Dict{String,<:Any})

Describes the specified flow module.

Arguments

  • contact_flow_module_id: The identifier of the flow module.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_hours_of_operationMethod
describe_hours_of_operation(hours_of_operation_id, instance_id)
describe_hours_of_operation(hours_of_operation_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation.

Arguments

  • hours_of_operation_id: The identifier for the hours of operation.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_instanceMethod
describe_instance(instance_id)
describe_instance(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect 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.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_instance_attributeMethod
describe_instance_attribute(attribute_type, instance_id)
describe_instance_attribute(attribute_type, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.

Arguments

  • attribute_type: The type of attribute.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_instance_storage_configMethod
describe_instance_storage_config(association_id, instance_id, resource_type)
describe_instance_storage_config(association_id, instance_id, resource_type, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Arguments

  • association_id: The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • resource_type: A valid resource type.
source
Main.Connect.describe_phone_numberMethod
describe_phone_number(phone_number_id)
describe_phone_number(phone_number_id, params::Dict{String,<:Any})

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Arguments

  • phone_number_id: A unique identifier for the phone number.
source
Main.Connect.describe_queueMethod
describe_queue(instance_id, queue_id)
describe_queue(instance_id, queue_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.
source
Main.Connect.describe_quick_connectMethod
describe_quick_connect(instance_id, quick_connect_id)
describe_quick_connect(instance_id, quick_connect_id, params::Dict{String,<:Any})

Describes the quick connect.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • quick_connect_id: The identifier for the quick connect.
source
Main.Connect.describe_routing_profileMethod
describe_routing_profile(instance_id, routing_profile_id)
describe_routing_profile(instance_id, routing_profile_id, params::Dict{String,<:Any})

Describes the specified routing profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • routing_profile_id: The identifier of the routing profile.
source
Main.Connect.describe_ruleMethod
describe_rule(instance_id, rule_id)
describe_rule(instance_id, rule_id, params::Dict{String,<:Any})

Describes a rule for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • rule_id: A unique identifier for the rule.
source
Main.Connect.describe_security_profileMethod
describe_security_profile(instance_id, security_profile_id)
describe_security_profile(instance_id, security_profile_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Gets basic information about the security profle.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • security_profile_id: The identifier for the security profle.
source
Main.Connect.describe_traffic_distribution_groupMethod
describe_traffic_distribution_group(traffic_distribution_group_id)
describe_traffic_distribution_group(traffic_distribution_group_id, params::Dict{String,<:Any})

Gets details and status of a traffic distribution group.

Arguments

  • traffic_distribution_group_id: 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 distribution group was created. The ARN must be provided if the call is from the replicated Region.
source
Main.Connect.describe_userMethod
describe_user(instance_id, user_id)
describe_user(instance_id, user_id, params::Dict{String,<:Any})

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user account.
source
Main.Connect.describe_user_hierarchy_groupMethod
describe_user_hierarchy_group(hierarchy_group_id, instance_id)
describe_user_hierarchy_group(hierarchy_group_id, instance_id, params::Dict{String,<:Any})

Describes the specified hierarchy group.

Arguments

  • hierarchy_group_id: The identifier of the hierarchy group.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_user_hierarchy_structureMethod
describe_user_hierarchy_structure(instance_id)
describe_user_hierarchy_structure(instance_id, params::Dict{String,<:Any})

Describes the hierarchy structure of the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.describe_vocabularyMethod
describe_vocabulary(instance_id, vocabulary_id)
describe_vocabulary(instance_id, vocabulary_id, params::Dict{String,<:Any})

Describes the specified vocabulary.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • vocabulary_id: The identifier of the custom vocabulary.
source
Main.Connect.disassociate_approved_originMethod
disassociate_approved_origin(instance_id, origin)
disassociate_approved_origin(instance_id, origin, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • origin: The domain URL of the integrated application.
source
Main.Connect.disassociate_botMethod
disassociate_bot(instance_id)
disassociate_bot(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "LexBot":
  • "LexV2Bot": The Amazon Lex V2 bot to disassociate from the instance.
source
Main.Connect.disassociate_instance_storage_configMethod
disassociate_instance_storage_config(association_id, instance_id, resource_type)
disassociate_instance_storage_config(association_id, instance_id, resource_type, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID.

Arguments

  • association_id: The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • resource_type: A valid resource type.
source
Main.Connect.disassociate_lambda_functionMethod
disassociate_lambda_function(instance_id, function_arn)
disassociate_lambda_function(instance_id, function_arn, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..
  • function_arn: The Amazon Resource Name (ARN) of the Lambda function being disassociated.
source
Main.Connect.disassociate_lex_botMethod
disassociate_lex_bot(instance_id, bot_name, lex_region)
disassociate_lex_bot(instance_id, bot_name, lex_region, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • bot_name: The name of the Amazon Lex bot. Maximum character limit of 50.
  • lex_region: The Amazon Web Services Region in which the Amazon Lex bot has been created.
source
Main.Connect.disassociate_phone_number_contact_flowMethod
disassociate_phone_number_contact_flow(phone_number_id, instance_id)
disassociate_phone_number_contact_flow(phone_number_id, instance_id, params::Dict{String,<:Any})

Removes the flow association from a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Arguments

  • phone_number_id: A unique identifier for the phone number.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.disassociate_queue_quick_connectsMethod
disassociate_queue_quick_connects(instance_id, queue_id, quick_connect_ids)
disassociate_queue_quick_connects(instance_id, queue_id, quick_connect_ids, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.
  • quick_connect_ids: The quick connects to disassociate from the queue.
source
Main.Connect.disassociate_routing_profile_queuesMethod
disassociate_routing_profile_queues(instance_id, queue_references, routing_profile_id)
disassociate_routing_profile_queues(instance_id, queue_references, routing_profile_id, params::Dict{String,<:Any})

Disassociates a set of queues from a routing profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_references: The queues to disassociate from this routing profile.
  • routing_profile_id: The identifier of the routing profile.
source
Main.Connect.disassociate_security_keyMethod
disassociate_security_key(association_id, instance_id)
disassociate_security_key(association_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key.

Arguments

  • association_id: The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.dismiss_user_contactMethod
dismiss_user_contact(contact_id, instance_id, user_id)
dismiss_user_contact(contact_id, instance_id, user_id, params::Dict{String,<:Any})

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.

Arguments

  • contact_id: The identifier of the contact.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user account.
source
Main.Connect.get_contact_attributesMethod
get_contact_attributes(initial_contact_id, instance_id)
get_contact_attributes(initial_contact_id, instance_id, params::Dict{String,<:Any})

Retrieves the contact attributes for the specified contact.

Arguments

  • initial_contact_id: The identifier of the initial contact.
  • instance_id: The identifier of the Amazon Connect instance.
source
Main.Connect.get_current_metric_dataMethod
get_current_metric_data(current_metrics, filters, instance_id)
get_current_metric_data(current_metrics, filters, instance_id, params::Dict{String,<:Any})

Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Arguments

  • current_metrics: The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide. AGENTSAFTERCONTACTWORK Unit: COUNT Name in real-time metrics report: ACW AGENTSAVAILABLE Unit: COUNT Name in real-time metrics report: Available AGENTSERROR Unit: COUNT Name in real-time metrics report: Error AGENTSNONPRODUCTIVE Unit: COUNT Name in real-time metrics report: NPT (Non-Productive Time) AGENTSONCALL Unit: COUNT Name in real-time metrics report: On contact AGENTSONCONTACT Unit: COUNT Name in real-time metrics report: On contact AGENTSONLINE Unit: COUNT Name in real-time metrics report: Online AGENTSSTAFFED Unit: COUNT Name in real-time metrics report: Staffed CONTACTSINQUEUE Unit: COUNT Name in real-time metrics report: In queue CONTACTSSCHEDULED Unit: COUNT Name in real-time metrics report: Scheduled OLDESTCONTACTAGE Unit: SECONDS When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this: { "Metric": { "Name": "OLDESTCONTACTAGE", "Unit": "SECONDS" }, "Value": 24113.0 } The actual OLDESTCONTACTAGE is 24 seconds. Name in real-time metrics report: Oldest SLOTSACTIVE Unit: COUNT Name in real-time metrics report: Active SLOTSAVAILABLE Unit: COUNT Name in real-time metrics report: Availability
  • filters: The filters to apply to returned metrics. You can filter up to the following limits: Queues: 100 Routing profiles: 100 Channels: 3 (VOICE, CHAT, and TASK channels are supported.) Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request. Currently tagging is only supported on the resources that are passed in the filter.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Groupings": The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported. If you group by ROUTINGPROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTSSCHEDULED, CONTACTSINQUEUE, and OLDESTCONTACTAGE. If no Grouping is included in the request, a summary of metrics is returned.
  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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. The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
  • "SortCriteria": The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTSONLINE, DESCENDING. The metric collection is sorted based on the input metrics. Note the following: Sorting on SLOTSACTIVE and SLOTS_AVAILABLE is not supported.
source
Main.Connect.get_current_user_dataMethod
get_current_user_data(filters, instance_id)
get_current_user_data(filters, instance_id, params::Dict{String,<:Any})

Gets the real-time active user data from the specified Amazon Connect instance.

Arguments

  • filters: The filters to apply to returned user data. You can filter up to the following limits: Queues: 100 Routing profiles: 100 Agents: 100 Contact states: 9 User hierarchy groups: 1 The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups. Currently tagging is only supported on the resources that are passed in the filter.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
source
Main.Connect.get_federation_tokenMethod
get_federation_token(instance_id)
get_federation_token(instance_id, params::Dict{String,<:Any})

Retrieves a token for federation. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.get_metric_dataMethod
get_metric_data(end_time, filters, historical_metrics, instance_id, start_time)
get_metric_data(end_time, filters, historical_metrics, instance_id, start_time, params::Dict{String,<:Any})

Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Arguments

  • end_time: The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp. The time range between the start and end time must be less than 24 hours.
  • filters: The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported. To filter by Queues, enter the queue ID/ARN, not the name of the queue.
  • historical_metrics: The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide. This API does not support a contacts incoming metric (there's no CONTACTSINCOMING metric missing from the documented list). ABANDONTIME Unit: SECONDS Statistic: AVG AFTERCONTACTWORKTIME Unit: SECONDS Statistic: AVG APICONTACTSHANDLED Unit: COUNT Statistic: SUM CALLBACKCONTACTSHANDLED Unit: COUNT Statistic: SUM CONTACTSABANDONED Unit: COUNT Statistic: SUM CONTACTSAGENTHUNGUPFIRST Unit: COUNT Statistic: SUM CONTACTSCONSULTED Unit: COUNT Statistic: SUM CONTACTSHANDLED Unit: COUNT Statistic: SUM CONTACTSHANDLEDINCOMING Unit: COUNT Statistic: SUM CONTACTSHANDLEDOUTBOUND Unit: COUNT Statistic: SUM CONTACTSHOLDABANDONS Unit: COUNT Statistic: SUM CONTACTSMISSED Unit: COUNT Statistic: SUM CONTACTSQUEUED Unit: COUNT Statistic: SUM CONTACTSTRANSFERREDIN Unit: COUNT Statistic: SUM CONTACTSTRANSFERREDINFROMQUEUE Unit: COUNT Statistic: SUM CONTACTSTRANSFERREDOUT Unit: COUNT Statistic: SUM CONTACTSTRANSFERREDOUTFROMQUEUE Unit: COUNT Statistic: SUM HANDLETIME Unit: SECONDS Statistic: AVG HOLDTIME Unit: SECONDS Statistic: AVG INTERACTIONANDHOLDTIME Unit: SECONDS Statistic: AVG INTERACTIONTIME Unit: SECONDS Statistic: AVG OCCUPANCY Unit: PERCENT Statistic: AVG QUEUEANSWERTIME Unit: SECONDS Statistic: AVG QUEUEDTIME Unit: SECONDS Statistic: MAX SERVICELEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: PERCENT Statistic: AVG Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • start_time: The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15. The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Groupings": The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues. If no grouping is specified, a summary of metrics for all queues is returned.
  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
source
Main.Connect.get_task_templateMethod
get_task_template(instance_id, task_template_id)
get_task_template(instance_id, task_template_id, params::Dict{String,<:Any})

Gets details about a specific task template in the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • task_template_id: A unique identifier for the task template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "snapshotVersion": The system generated version of a task template that is associated with a task, when the task is created.
source
Main.Connect.get_traffic_distributionMethod
get_traffic_distribution(id)
get_traffic_distribution(id, params::Dict{String,<:Any})

Retrieves the current traffic distribution for a given traffic distribution group.

Arguments

  • id: The identifier of the traffic distribution group.
source
Main.Connect.list_agent_statusesMethod
list_agent_statuses(instance_id)
list_agent_statuses(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AgentStatusTypes": Available agent status types.
  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_approved_originsMethod
list_approved_origins(instance_id)
list_approved_origins(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_botsMethod
list_bots(instance_id, lex_version)
list_bots(instance_id, lex_version, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • lex_version: The version of Amazon Lex or Amazon Lex V2.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_contact_flow_modulesMethod
list_contact_flow_modules(instance_id)
list_contact_flow_modules(instance_id, params::Dict{String,<:Any})

Provides information about the flow modules for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
  • "state": The state of the flow module.
source
Main.Connect.list_contact_flowsMethod
list_contact_flows(instance_id)
list_contact_flows(instance_id, params::Dict{String,<:Any})

Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "contactFlowTypes": The type of flow.
  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_contact_referencesMethod
list_contact_references(contact_id, instance_id, reference_types)
list_contact_references(contact_id, instance_id, reference_types, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact.

Arguments

  • contact_id: The identifier of the initial contact.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • reference_types: The type of reference.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": 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. This is not expected to be set, because the value returned in the previous response is always null.
source
Main.Connect.list_default_vocabulariesMethod
list_default_vocabularies(instance_id)
list_default_vocabularies(instance_id, params::Dict{String,<:Any})

Lists the default vocabularies for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "LanguageCode": The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
source
Main.Connect.list_hours_of_operationsMethod
list_hours_of_operations(instance_id)
list_hours_of_operations(instance_id, params::Dict{String,<:Any})

Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_instance_attributesMethod
list_instance_attributes(instance_id)
list_instance_attributes(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_instance_storage_configsMethod
list_instance_storage_configs(instance_id, resource_type)
list_instance_storage_configs(instance_id, resource_type, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • resource_type: A valid resource type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_instancesMethod
list_instances()
list_instances(params::Dict{String,<:Any})

This API is in preview release for Amazon Connect 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_integration_associationsMethod
list_integration_associations(instance_id)
list_integration_associations(instance_id, params::Dict{String,<:Any})

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "integrationType": The integration type.
  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_lambda_functionsMethod
list_lambda_functions(instance_id)
list_lambda_functions(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_lex_botsMethod
list_lex_bots(instance_id)
list_lex_bots(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. If no value is specified, the default is 10.
  • "nextToken": 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.
source
Main.Connect.list_phone_numbersMethod
list_phone_numbers(instance_id)
list_phone_numbers(instance_id, params::Dict{String,<:Any})

Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
  • "phoneNumberCountryCodes": The ISO country code.
  • "phoneNumberTypes": The type of phone number.
source
Main.Connect.list_phone_numbers_v2Method
list_phone_numbers_v2()
list_phone_numbers_v2(params::Dict{String,<:Any})

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
  • "PhoneNumberCountryCodes": The ISO country code.
  • "PhoneNumberPrefix": The prefix of the phone number. If provided, it must contain + as part of the country code.
  • "PhoneNumberTypes": The type of phone number.
  • "TargetArn": The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
source
Main.Connect.list_promptsMethod
list_prompts(instance_id)
list_prompts(instance_id, params::Dict{String,<:Any})

Provides information about the prompts for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_queue_quick_connectsMethod
list_queue_quick_connects(instance_id, queue_id)
list_queue_quick_connects(instance_id, queue_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_queuesMethod
list_queues(instance_id)
list_queues(instance_id, params::Dict{String,<:Any})

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

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
  • "queueTypes": The type of queue.
source
Main.Connect.list_quick_connectsMethod
list_quick_connects(instance_id)
list_quick_connects(instance_id, params::Dict{String,<:Any})

Provides information about the quick connects for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "QuickConnectTypes": 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 types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_routing_profile_queuesMethod
list_routing_profile_queues(instance_id, routing_profile_id)
list_routing_profile_queues(instance_id, routing_profile_id, params::Dict{String,<:Any})

Lists the queues associated with a routing profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • routing_profile_id: The identifier of the routing profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_routing_profilesMethod
list_routing_profiles(instance_id)
list_routing_profiles(instance_id, params::Dict{String,<:Any})

Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_rulesMethod
list_rules(instance_id)
list_rules(instance_id, params::Dict{String,<:Any})

List all rules for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "eventSourceName": The name of the event source.
  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
  • "publishStatus": The publish status of the rule.
source
Main.Connect.list_security_keysMethod
list_security_keys(instance_id)
list_security_keys(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_security_profile_permissionsMethod
list_security_profile_permissions(instance_id, security_profile_id)
list_security_profile_permissions(instance_id, security_profile_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Lists the permissions granted to a security profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • security_profile_id: The identifier for the security profle.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_security_profilesMethod
list_security_profiles(instance_id)
list_security_profiles(instance_id, params::Dict{String,<:Any})

Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
source
Main.Connect.list_task_templatesMethod
list_task_templates(instance_id)
list_task_templates(instance_id, params::Dict{String,<:Any})

Lists task templates for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. It is not expected that you set this.
  • "name": The name of the task template.
  • "nextToken": 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. It is not expected that you set this because the value returned in the previous response is always null.
  • "status": 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 as INACTIVE, then a task that refers to this template cannot be created.
source
Main.Connect.list_traffic_distribution_groupsMethod
list_traffic_distribution_groups()
list_traffic_distribution_groups(params::Dict{String,<:Any})

Lists traffic distribution groups.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "instanceId": The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_use_casesMethod
list_use_cases(instance_id, integration_association_id)
list_use_cases(instance_id, integration_association_id, params::Dict{String,<:Any})

Lists the use cases for the integration association.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • integration_association_id: The identifier for the integration association.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": 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.
source
Main.Connect.list_user_hierarchy_groupsMethod
list_user_hierarchy_groups(instance_id)
list_user_hierarchy_groups(instance_id, params::Dict{String,<:Any})

Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.list_usersMethod
list_users(instance_id)
list_users(instance_id, params::Dict{String,<:Any})

Provides summary information about the users for the specified Amazon Connect instance.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page. The default MaxResult size is 100.
  • "nextToken": 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.
source
Main.Connect.monitor_contactMethod
monitor_contact(contact_id, instance_id, user_id)
monitor_contact(contact_id, instance_id, user_id, params::Dict{String,<:Any})

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.

Arguments

  • contact_id: The identifier of the contact.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AllowedMonitorCapabilities": Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
  • "ClientToken": 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.
source
Main.Connect.put_user_statusMethod
put_user_status(agent_status_id, instance_id, user_id)
put_user_status(agent_status_id, instance_id, user_id, params::Dict{String,<:Any})

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

Arguments

  • agent_status_id: The identifier of the agent status.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user.
source
Main.Connect.release_phone_numberMethod
release_phone_number(phone_number_id)
release_phone_number(phone_number_id, params::Dict{String,<:Any})

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console. After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

Arguments

  • phone_number_id: A unique identifier for the phone number.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": 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.
source
Main.Connect.replicate_instanceMethod
replicate_instance(instance_id, replica_alias, replica_region)
replicate_instance(instance_id, replica_alias, replica_region, params::Dict{String,<:Any})

Replicates an Amazon Connect instance in the specified Amazon Web Services Region. For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.
  • replica_alias: The alias for the replicated instance. The ReplicaAlias must be unique.
  • replica_region: The Amazon Web Services Region where to replicate the Amazon Connect instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
source
Main.Connect.resume_contact_recordingMethod
resume_contact_recording(contact_id, initial_contact_id, instance_id)
resume_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any})

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call. Only voice recordings are supported at this time.

Arguments

  • contact_id: The identifier of the contact.
  • initial_contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.search_available_phone_numbersMethod
search_available_phone_numbers(phone_number_country_code, phone_number_type, target_arn)
search_available_phone_numbers(phone_number_country_code, phone_number_type, target_arn, params::Dict{String,<:Any})

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

Arguments

  • phone_number_country_code: The ISO country code.
  • phone_number_type: The type of phone number.
  • target_arn: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
  • "PhoneNumberPrefix": The prefix of the phone number. If provided, it must contain + as part of the country code.
source
Main.Connect.search_queuesMethod
search_queues(instance_id)
search_queues(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Searches queues in an Amazon Connect instance, with optional filtering.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
  • "SearchCriteria": The search criteria to be used to return queues. The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
  • "SearchFilter": Filters to be applied to search results.
source
Main.Connect.search_routing_profilesMethod
search_routing_profiles(instance_id)
search_routing_profiles(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Searches routing profiles in an Amazon Connect instance, with optional filtering.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
  • "SearchCriteria": The search criteria to be used to return routing profiles. The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
  • "SearchFilter": Filters to be applied to search results.
source
Main.Connect.search_security_profilesMethod
search_security_profiles(instance_id)
search_security_profiles(instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Searches security profiles in an Amazon Connect instance, with optional filtering.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
  • "SearchCriteria": The search criteria to be used to return security profiles. The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. The currently supported value for FieldName: name
  • "SearchFilter": Filters to be applied to search results.
source
Main.Connect.search_usersMethod
search_users()
search_users(params::Dict{String,<:Any})

Searches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InstanceId": The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • "MaxResults": The maximum number of results to return per page.
  • "NextToken": 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.
  • "SearchCriteria":
  • "SearchFilter": Filters to be applied to search results.
source
Main.Connect.search_vocabulariesMethod
search_vocabularies(instance_id)
search_vocabularies(instance_id, params::Dict{String,<:Any})

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "LanguageCode": The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
  • "MaxResults": The maximum number of results to return per page.
  • "NameStartsWith": The starting pattern of the name of the vocabulary.
  • "NextToken": 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.
  • "State": The current state of the custom vocabulary.
source
Main.Connect.start_chat_contactMethod
start_chat_contact(contact_flow_id, instance_id, participant_details)
start_chat_contact(contact_flow_id, instance_id, participant_details, params::Dict{String,<:Any})

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see Chat in the Amazon Connect Administrator Guide.

Arguments

  • contact_flow_id: The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold: arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact -flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • participant_details: Information identifying the participant.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Attributes": A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
  • "ChatDurationInMinutes": The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
  • "ClientToken": 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.
  • "InitialMessage": The initial message to be sent to the newly created chat.
  • "SupportedMessagingContentTypes": The supported chat message content types. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json].
source
Main.Connect.start_contact_recordingMethod
start_contact_recording(contact_id, initial_contact_id, instance_id, voice_recording_configuration)
start_contact_recording(contact_id, initial_contact_id, instance_id, voice_recording_configuration, params::Dict{String,<:Any})

Starts recording the contact: If the API is called before the agent joins the call, recording starts when the agent joins the call. If the API is called after the agent joins the call, recording starts at the time of the API call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time.

Arguments

  • contact_id: The identifier of the contact.
  • initial_contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • voice_recording_configuration: The person being recorded.
source
Main.Connect.start_contact_streamingMethod
start_contact_streaming(chat_streaming_configuration, client_token, contact_id, instance_id)
start_contact_streaming(chat_streaming_configuration, client_token, contact_id, instance_id, params::Dict{String,<:Any})

Initiates real-time message streaming for a new chat contact. For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Arguments

  • chat_streaming_configuration: The streaming configuration, such as the Amazon SNS streaming endpoint.
  • client_token: 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.
  • contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.start_outbound_voice_contactMethod
start_outbound_voice_contact(contact_flow_id, destination_phone_number, instance_id)
start_outbound_voice_contact(contact_flow_id, destination_phone_number, instance_id, params::Dict{String,<:Any})

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide. Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

Arguments

  • contact_flow_id: The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold: arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact -flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
  • destination_phone_number: The phone number of the customer, in E.164 format.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AnswerMachineDetectionConfig": Configuration of the answering machine detection for this outbound call.
  • "Attributes": A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
  • "CampaignId": The campaign identifier of the outbound communication.
  • "ClientToken": 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. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
  • "QueueId": The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
  • "SourcePhoneNumber": The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
  • "TrafficType": Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
source
Main.Connect.start_task_contactMethod
start_task_contact(instance_id, name)
start_task_contact(instance_id, name, params::Dict{String,<:Any})

Initiates a flow to start a new task.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Attributes": A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
  • "ClientToken": 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.
  • "ContactFlowId": The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold: arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact -flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
  • "Description": A description of the task that is shown to an agent in the Contact Control Panel (CCP).
  • "PreviousContactId": The identifier of the previous chat, voice, or task contact.
  • "QuickConnectId": The identifier for the quick connect.
  • "References": A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
  • "ScheduledTime": The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
  • "TaskTemplateId": A unique identifier for the task template.
source
Main.Connect.stop_contactMethod
stop_contact(contact_id, instance_id)
stop_contact(contact_id, instance_id, params::Dict{String,<:Any})

Ends the specified contact. This call does not work for the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER

Arguments

  • contact_id: The ID of the contact.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.stop_contact_recordingMethod
stop_contact_recording(contact_id, initial_contact_id, instance_id)
stop_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any})

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time.

Arguments

  • contact_id: The identifier of the contact.
  • initial_contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.stop_contact_streamingMethod
stop_contact_streaming(contact_id, instance_id, streaming_id)
stop_contact_streaming(contact_id, instance_id, streaming_id, params::Dict{String,<:Any})

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

Arguments

  • contact_id: The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • streaming_id: The identifier of the streaming configuration enabled.
source
Main.Connect.suspend_contact_recordingMethod
suspend_contact_recording(contact_id, initial_contact_id, instance_id)
suspend_contact_recording(contact_id, initial_contact_id, instance_id, params::Dict{String,<:Any})

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. The period of time that the recording is suspended is filled with silence in the final recording. Only voice recordings are supported at this time.

Arguments

  • contact_id: The identifier of the contact.
  • initial_contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tags: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
source
Main.Connect.transfer_contactMethod
transfer_contact(contact_flow_id, contact_id, instance_id)
transfer_contact(contact_flow_id, contact_id, instance_id, params::Dict{String,<:Any})

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. Note the following requirements: Transfer is supported for only TASK contacts. Do not use both QueueId and UserId in the same call. The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. The TransferContact API can be called only on active contacts. A contact cannot be transferred more than 11 times.

Arguments

  • contact_flow_id: The identifier of the flow.
  • contact_id: The identifier of the contact in this instance of Amazon Connect.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
  • "QueueId": The identifier for the queue.
  • "UserId": The identifier for the user.
source
Main.Connect.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes the specified tags from the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tag_keys: The tag keys.
source
Main.Connect.update_agent_statusMethod
update_agent_status(agent_status_id, instance_id)
update_agent_status(agent_status_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates agent status.

Arguments

  • agent_status_id: The identifier of the agent status.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the agent status.
  • "DisplayOrder": The display order of the agent status.
  • "Name": The name of the agent status.
  • "ResetOrderNumber": A number indicating the reset order of the agent status.
  • "State": The state of the agent status.
source
Main.Connect.update_contactMethod
update_contact(contact_id, instance_id)
update_contact(contact_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. You can add or update user-defined contact information for both ongoing and completed contacts.

Arguments

  • contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the contact.
  • "Name": The name of the contact.
  • "References": Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
source
Main.Connect.update_contact_attributesMethod
update_contact_attributes(attributes, initial_contact_id, instance_id)
update_contact_attributes(attributes, initial_contact_id, instance_id, params::Dict{String,<:Any})

Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

Arguments

  • attributes: The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
  • initial_contact_id: The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.update_contact_flow_contentMethod
update_contact_flow_content(contact_flow_id, content, instance_id)
update_contact_flow_content(contact_flow_id, content, instance_id, params::Dict{String,<:Any})

Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language.

Arguments

  • contact_flow_id: The identifier of the flow.
  • content: The JSON string that represents flow's content. For an example, see Example contact flow in Amazon Connect Flow language.
  • instance_id: The identifier of the Amazon Connect instance.
source
Main.Connect.update_contact_flow_metadataMethod
update_contact_flow_metadata(contact_flow_id, instance_id)
update_contact_flow_metadata(contact_flow_id, instance_id, params::Dict{String,<:Any})

Updates metadata about specified flow.

Arguments

  • contact_flow_id: The identifier of the flow.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ContactFlowState": The state of flow.
  • "Description": The description of the flow.
  • "Name": The name of the flow.
source
Main.Connect.update_contact_flow_module_contentMethod
update_contact_flow_module_content(contact_flow_module_id, content, instance_id)
update_contact_flow_module_content(contact_flow_module_id, content, instance_id, params::Dict{String,<:Any})

Updates specified flow module for the specified Amazon Connect instance.

Arguments

  • contact_flow_module_id: The identifier of the flow module.
  • content: The content of the flow module.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.update_contact_flow_module_metadataMethod
update_contact_flow_module_metadata(contact_flow_module_id, instance_id)
update_contact_flow_module_metadata(contact_flow_module_id, instance_id, params::Dict{String,<:Any})

Updates metadata about specified flow module.

Arguments

  • contact_flow_module_id: The identifier of the flow module.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the flow module.
  • "Name": The name of the flow module.
  • "State": The state of flow module.
source
Main.Connect.update_contact_flow_nameMethod
update_contact_flow_name(contact_flow_id, instance_id)
update_contact_flow_name(contact_flow_id, instance_id, params::Dict{String,<:Any})

The name of the flow. You can also create and update flows using the Amazon Connect Flow language.

Arguments

  • contact_flow_id: The identifier of the flow.
  • instance_id: The identifier of the Amazon Connect instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the flow.
  • "Name": The name of the flow.
source
Main.Connect.update_contact_scheduleMethod
update_contact_schedule(contact_id, instance_id, scheduled_time)
update_contact_schedule(contact_id, instance_id, scheduled_time, params::Dict{String,<:Any})

Updates the scheduled time of a task contact that is already scheduled.

Arguments

  • contact_id: The identifier of the contact.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • scheduled_time: The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
source
Main.Connect.update_hours_of_operationMethod
update_hours_of_operation(hours_of_operation_id, instance_id)
update_hours_of_operation(hours_of_operation_id, instance_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation.

Arguments

  • hours_of_operation_id: The identifier of the hours of operation.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Config": Configuration information of the hours of operation.
  • "Description": The description of the hours of operation.
  • "Name": The name of the hours of operation.
  • "TimeZone": The time zone of the hours of operation.
source
Main.Connect.update_instance_attributeMethod
update_instance_attribute(attribute_type, instance_id, value)
update_instance_attribute(attribute_type, instance_id, value, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type.

Arguments

  • attribute_type: The type of attribute. Only allowlisted customers can consume USECUSTOMTTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • value: The value for the attribute. Maximum character limit is 100.
source
Main.Connect.update_instance_storage_configMethod
update_instance_storage_config(association_id, instance_id, storage_config, resource_type)
update_instance_storage_config(association_id, instance_id, storage_config, resource_type, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent.

Arguments

  • association_id: The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • storage_config:
  • resource_type: A valid resource type.
source
Main.Connect.update_participant_role_configMethod
update_participant_role_config(channel_configuration, contact_id, instance_id)
update_participant_role_config(channel_configuration, contact_id, instance_id, params::Dict{String,<:Any})

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.

Arguments

  • channel_configuration: The Amazon Connect channel you want to configure.
  • contact_id: The identifier of the contact in this instance of Amazon Connect.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.update_phone_numberMethod
update_phone_number(phone_number_id, target_arn)
update_phone_number(phone_number_id, target_arn, params::Dict{String,<:Any})

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region. You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

Arguments

  • phone_number_id: A unique identifier for the phone number.
  • target_arn: The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
source
Main.Connect.update_queue_hours_of_operationMethod
update_queue_hours_of_operation(hours_of_operation_id, instance_id, queue_id)
update_queue_hours_of_operation(hours_of_operation_id, instance_id, queue_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue.

Arguments

  • hours_of_operation_id: The identifier for the hours of operation.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.
source
Main.Connect.update_queue_max_contactsMethod
update_queue_max_contacts(instance_id, queue_id)
update_queue_max_contacts(instance_id, queue_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxContacts": The maximum number of contacts that can be in the queue before it is considered full.
source
Main.Connect.update_queue_nameMethod
update_queue_name(instance_id, queue_id)
update_queue_name(instance_id, queue_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a queue. At least Name or Description must be provided.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the queue.
  • "Name": The name of the queue.
source
Main.Connect.update_queue_outbound_caller_configMethod
update_queue_outbound_caller_config(instance_id, outbound_caller_config, queue_id)
update_queue_outbound_caller_config(instance_id, outbound_caller_config, queue_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • outbound_caller_config: The outbound caller ID name, number, and outbound whisper flow.
  • queue_id: The identifier for the queue.
source
Main.Connect.update_queue_statusMethod
update_queue_status(instance_id, queue_id, status)
update_queue_status(instance_id, queue_id, status, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates the status of the queue.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_id: The identifier for the queue.
  • status: The status of the queue.
source
Main.Connect.update_quick_connect_configMethod
update_quick_connect_config(instance_id, quick_connect_config, quick_connect_id)
update_quick_connect_config(instance_id, quick_connect_config, quick_connect_id, params::Dict{String,<:Any})

Updates the configuration settings for the specified quick connect.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • quick_connect_config: Information about the configuration settings for the quick connect.
  • quick_connect_id: The identifier for the quick connect.
source
Main.Connect.update_quick_connect_nameMethod
update_quick_connect_name(instance_id, quick_connect_id)
update_quick_connect_name(instance_id, quick_connect_id, params::Dict{String,<:Any})

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • quick_connect_id: The identifier for the quick connect.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the quick connect.
  • "Name": The name of the quick connect.
source
Main.Connect.update_routing_profile_concurrencyMethod
update_routing_profile_concurrency(instance_id, media_concurrencies, routing_profile_id)
update_routing_profile_concurrency(instance_id, media_concurrencies, routing_profile_id, params::Dict{String,<:Any})

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • media_concurrencies: The channels that agents can handle in the Contact Control Panel (CCP).
  • routing_profile_id: The identifier of the routing profile.
source
Main.Connect.update_routing_profile_default_outbound_queueMethod
update_routing_profile_default_outbound_queue(default_outbound_queue_id, instance_id, routing_profile_id)
update_routing_profile_default_outbound_queue(default_outbound_queue_id, instance_id, routing_profile_id, params::Dict{String,<:Any})

Updates the default outbound queue of a routing profile.

Arguments

  • default_outbound_queue_id: The identifier for the default outbound queue.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • routing_profile_id: The identifier of the routing profile.
source
Main.Connect.update_routing_profile_nameMethod
update_routing_profile_name(instance_id, routing_profile_id)
update_routing_profile_name(instance_id, routing_profile_id, params::Dict{String,<:Any})

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • routing_profile_id: The identifier of the routing profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the routing profile. Must not be more than 250 characters.
  • "Name": The name of the routing profile. Must not be more than 127 characters.
source
Main.Connect.update_routing_profile_queuesMethod
update_routing_profile_queues(instance_id, queue_configs, routing_profile_id)
update_routing_profile_queues(instance_id, queue_configs, routing_profile_id, params::Dict{String,<:Any})

Updates the properties associated with a set of queues for a routing profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • queue_configs: The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
  • routing_profile_id: The identifier of the routing profile.
source
Main.Connect.update_ruleMethod
update_rule(actions, function, instance_id, name, publish_status, rule_id)
update_rule(actions, function, instance_id, name, publish_status, rule_id, params::Dict{String,<:Any})

Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.

Arguments

  • actions: A list of actions to be run when the rule is triggered.
  • function: The conditions of the rule.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
  • publish_status: The publish status of the rule.
  • rule_id: A unique identifier for the rule.
source
Main.Connect.update_security_profileMethod
update_security_profile(instance_id, security_profile_id)
update_security_profile(instance_id, security_profile_id, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and is subject to change. Updates a security profile.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • security_profile_id: The identifier for the security profle.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AllowedAccessControlTags": The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
  • "Description": The description of the security profile.
  • "Permissions": The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
  • "TagRestrictedResources": The list of resources that a security profile applies tag restrictions to in Amazon Connect.
source
Main.Connect.update_task_templateMethod
update_task_template(instance_id, task_template_id)
update_task_template(instance_id, task_template_id, params::Dict{String,<:Any})

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • task_template_id: A unique identifier for the task template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Constraints": Constraints that are applicable to the fields listed.
  • "ContactFlowId": The identifier of the flow that runs by default when a task is created by referencing this template.
  • "Defaults": The default values for fields when a task is created by referencing this template.
  • "Description": The description of the task template.
  • "Fields": Fields that are part of the template.
  • "Name": The name of the task template.
  • "Status": 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 as INACTIVE, then a task that refers to this template cannot be created.
source
Main.Connect.update_traffic_distributionMethod
update_traffic_distribution(id)
update_traffic_distribution(id, params::Dict{String,<:Any})

Updates the traffic distribution for a given traffic distribution group. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

Arguments

  • id: 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 distribution group was created. The ARN must be provided if the call is from the replicated Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "TelephonyConfig": The distribution of traffic between the instance and its replica(s).
source
Main.Connect.update_user_hierarchyMethod
update_user_hierarchy(instance_id, user_id)
update_user_hierarchy(instance_id, user_id, params::Dict{String,<:Any})

Assigns the specified hierarchy group to the specified user.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "HierarchyGroupId": The identifier of the hierarchy group.
source
Main.Connect.update_user_hierarchy_group_nameMethod
update_user_hierarchy_group_name(hierarchy_group_id, instance_id, name)
update_user_hierarchy_group_name(hierarchy_group_id, instance_id, name, params::Dict{String,<:Any})

Updates the name of the user hierarchy group.

Arguments

  • hierarchy_group_id: The identifier of the hierarchy group.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • name: The name of the hierarchy group. Must not be more than 100 characters.
source
Main.Connect.update_user_hierarchy_structureMethod
update_user_hierarchy_structure(hierarchy_structure, instance_id)
update_user_hierarchy_structure(hierarchy_structure, instance_id, params::Dict{String,<:Any})

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

Arguments

  • hierarchy_structure: The hierarchy levels to update.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
source
Main.Connect.update_user_identity_infoMethod
update_user_identity_info(identity_info, instance_id, user_id)
update_user_identity_info(identity_info, instance_id, user_id, params::Dict{String,<:Any})

Updates the identity information for the specified user. We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

Arguments

  • identity_info: The identity information for the user.
  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • user_id: The identifier of the user account.
source
Main.Connect.update_user_phone_configMethod
update_user_phone_config(instance_id, phone_config, user_id)
update_user_phone_config(instance_id, phone_config, user_id, params::Dict{String,<:Any})

Updates the phone configuration settings for the specified user.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • phone_config: Information about phone configuration settings for the user.
  • user_id: The identifier of the user account.
source
Main.Connect.update_user_routing_profileMethod
update_user_routing_profile(instance_id, routing_profile_id, user_id)
update_user_routing_profile(instance_id, routing_profile_id, user_id, params::Dict{String,<:Any})

Assigns the specified routing profile to the specified user.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • routing_profile_id: The identifier of the routing profile for the user.
  • user_id: The identifier of the user account.
source
Main.Connect.update_user_security_profilesMethod
update_user_security_profiles(instance_id, security_profile_ids, user_id)
update_user_security_profiles(instance_id, security_profile_ids, user_id, params::Dict{String,<:Any})

Assigns the specified security profiles to the specified user.

Arguments

  • instance_id: The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
  • security_profile_ids: The identifiers of the security profiles for the user.
  • user_id: The identifier of the user account.
source