Table of Contents
Connect.Client¶A low-level client representing Amazon Connect Service
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide .
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints .
Note
Working with flows? Check out the Amazon Connect Flow language .
import boto3
client = boto3.client('connect')
These are the available methods:
associate_approved_origin()associate_bot()associate_default_vocabulary()associate_instance_storage_config()associate_lambda_function()associate_lex_bot()associate_phone_number_contact_flow()associate_queue_quick_connects()associate_routing_profile_queues()associate_security_key()can_paginate()claim_phone_number()close()create_agent_status()create_contact_flow()create_contact_flow_module()create_hours_of_operation()create_instance()create_integration_association()create_queue()create_quick_connect()create_routing_profile()create_security_profile()create_task_template()create_traffic_distribution_group()create_use_case()create_user()create_user_hierarchy_group()create_vocabulary()delete_contact_flow()delete_contact_flow_module()delete_hours_of_operation()delete_instance()delete_integration_association()delete_quick_connect()delete_security_profile()delete_task_template()delete_traffic_distribution_group()delete_use_case()delete_user()delete_user_hierarchy_group()delete_vocabulary()describe_agent_status()describe_contact()describe_contact_flow()describe_contact_flow_module()describe_hours_of_operation()describe_instance()describe_instance_attribute()describe_instance_storage_config()describe_phone_number()describe_queue()describe_quick_connect()describe_routing_profile()describe_security_profile()describe_traffic_distribution_group()describe_user()describe_user_hierarchy_group()describe_user_hierarchy_structure()describe_vocabulary()disassociate_approved_origin()disassociate_bot()disassociate_instance_storage_config()disassociate_lambda_function()disassociate_lex_bot()disassociate_phone_number_contact_flow()disassociate_queue_quick_connects()disassociate_routing_profile_queues()disassociate_security_key()dismiss_user_contact()get_contact_attributes()get_current_metric_data()get_current_user_data()get_federation_token()get_metric_data()get_paginator()get_task_template()get_traffic_distribution()get_waiter()list_agent_statuses()list_approved_origins()list_bots()list_contact_flow_modules()list_contact_flows()list_contact_references()list_default_vocabularies()list_hours_of_operations()list_instance_attributes()list_instance_storage_configs()list_instances()list_integration_associations()list_lambda_functions()list_lex_bots()list_phone_numbers()list_phone_numbers_v2()list_prompts()list_queue_quick_connects()list_queues()list_quick_connects()list_routing_profile_queues()list_routing_profiles()list_security_keys()list_security_profile_permissions()list_security_profiles()list_tags_for_resource()list_task_templates()list_traffic_distribution_groups()list_use_cases()list_user_hierarchy_groups()list_users()put_user_status()release_phone_number()replicate_instance()resume_contact_recording()search_available_phone_numbers()search_queues()search_routing_profiles()search_security_profiles()search_users()search_vocabularies()start_chat_contact()start_contact_recording()start_contact_streaming()start_outbound_voice_contact()start_task_contact()stop_contact()stop_contact_recording()stop_contact_streaming()suspend_contact_recording()tag_resource()transfer_contact()untag_resource()update_agent_status()update_contact()update_contact_attributes()update_contact_flow_content()update_contact_flow_metadata()update_contact_flow_module_content()update_contact_flow_module_metadata()update_contact_flow_name()update_contact_schedule()update_hours_of_operation()update_instance_attribute()update_instance_storage_config()update_phone_number()update_queue_hours_of_operation()update_queue_max_contacts()update_queue_name()update_queue_outbound_caller_config()update_queue_status()update_quick_connect_config()update_quick_connect_name()update_routing_profile_concurrency()update_routing_profile_default_outbound_queue()update_routing_profile_name()update_routing_profile_queues()update_security_profile()update_task_template()update_traffic_distribution()update_user_hierarchy()update_user_hierarchy_group_name()update_user_hierarchy_structure()update_user_identity_info()update_user_phone_config()update_user_routing_profile()update_user_security_profiles()associate_approved_origin(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.associate_approved_origin(
InstanceId='string',
Origin='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The domain to add to your allow list.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionassociate_bot(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.associate_bot(
InstanceId='string',
LexBot={
'Name': 'string',
'LexRegion': 'string'
},
LexV2Bot={
'AliasArn': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Configuration information of an Amazon Lex bot.
The name of the Amazon Lex bot.
The Amazon Web Services Region where the Amazon Lex bot was created.
The Amazon Lex V2 bot to associate with the instance.
The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionassociate_default_vocabulary(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.associate_default_vocabulary(
InstanceId='string',
LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
VocabularyId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionassociate_instance_storage_config(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.associate_instance_storage_config(
InstanceId='string',
ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS',
StorageConfig={
'AssociationId': 'string',
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'S3Config': {
'BucketName': 'string',
'BucketPrefix': 'string',
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisVideoStreamConfig': {
'Prefix': 'string',
'RetentionPeriodHours': 123,
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisStreamConfig': {
'StreamArn': 'string'
},
'KinesisFirehoseConfig': {
'FirehoseArn': 'string'
}
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A valid resource type.
[REQUIRED]
A valid storage type.
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
A valid storage type.
The S3 bucket configuration.
The S3 bucket name.
The S3 bucket prefix.
The Amazon S3 encryption configuration.
The type of encryption.
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
The configuration of the Kinesis video stream.
The prefix of the video stream.
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
The encryption configuration.
The type of encryption.
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
The configuration of the Kinesis data stream.
The Amazon Resource Name (ARN) of the data stream.
The configuration of the Kinesis Firehose delivery stream.
The Amazon Resource Name (ARN) of the delivery stream.
dict
Response Syntax
{
'AssociationId': 'string'
}
Response Structure
(dict) --
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionassociate_lambda_function(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.associate_lambda_function(
InstanceId='string',
FunctionArn='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionassociate_lex_bot(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.associate_lex_bot(
InstanceId='string',
LexBot={
'Name': 'string',
'LexRegion': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The Amazon Lex bot to associate with the instance.
The name of the Amazon Lex bot.
The Amazon Web Services Region where the Amazon Lex bot was created.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionassociate_phone_number_contact_flow(**kwargs)¶Associates a flow with a phone number claimed to your Amazon Connect instance.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.associate_phone_number_contact_flow(
PhoneNumberId='string',
InstanceId='string',
ContactFlowId='string'
)
[REQUIRED]
A unique identifier for the phone number.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow.
None
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.AccessDeniedExceptionassociate_queue_quick_connects(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
See also: AWS API Documentation
Request Syntax
response = client.associate_queue_quick_connects(
InstanceId='string',
QueueId='string',
QuickConnectIds=[
'string',
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
[REQUIRED]
The quick connects to associate with this queue.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionassociate_routing_profile_queues(**kwargs)¶Associates a set of queues with a routing profile.
See also: AWS API Documentation
Request Syntax
response = client.associate_routing_profile_queues(
InstanceId='string',
RoutingProfileId='string',
QueueConfigs=[
{
'QueueReference': {
'QueueId': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK'
},
'Priority': 123,
'Delay': 123
},
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
[REQUIRED]
The queues to associate with this routing profile.
Contains information about the queue and channel for which priority and delay can be set.
Contains information about a queue resource.
The identifier for the queue.
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay .
The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionassociate_security_key(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
See also: AWS API Documentation
Request Syntax
response = client.associate_security_key(
InstanceId='string',
Key='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A valid security key in PEM format.
dict
Response Syntax
{
'AssociationId': 'string'
}
Response Structure
(dict) --
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.claim_phone_number(**kwargs)¶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.
Warning
You can call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
See also: AWS API Documentation
Request Syntax
response = client.claim_phone_number(
TargetArn='string',
PhoneNumber='string',
PhoneNumberDescription='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
[REQUIRED]
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'PhoneNumberId': 'string',
'PhoneNumberArn': 'string'
}
Response Structure
(dict) --
PhoneNumberId (string) --
A unique identifier for the phone number.
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) of the phone number.
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.IdempotencyExceptionConnect.Client.exceptions.AccessDeniedExceptionclose()¶Closes underlying endpoint connections.
create_agent_status(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.create_agent_status(
InstanceId='string',
Name='string',
Description='string',
State='ENABLED'|'DISABLED',
DisplayOrder=123,
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the status.
[REQUIRED]
The state of the status.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'AgentStatusARN': 'string',
'AgentStatusId': 'string'
}
Response Structure
(dict) --
AgentStatusARN (string) --
The Amazon Resource Name (ARN) of the agent status.
AgentStatusId (string) --
The identifier of the agent status.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_contact_flow(**kwargs)¶Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language .
See also: AWS API Documentation
Request Syntax
response = client.create_contact_flow(
InstanceId='string',
Name='string',
Type='CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
Description='string',
Content='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The name of the flow.
[REQUIRED]
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide .
[REQUIRED]
The content of the flow.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'ContactFlowId': 'string',
'ContactFlowArn': 'string'
}
Response Structure
(dict) --
ContactFlowId (string) --
The identifier of the flow.
ContactFlowArn (string) --
The Amazon Resource Name (ARN) of the flow.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidContactFlowExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_contact_flow_module(**kwargs)¶Creates a flow module for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.create_contact_flow_module(
InstanceId='string',
Name='string',
Description='string',
Content='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the flow module.
[REQUIRED]
The content of the flow module.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the flow module.
Arn (string) --
The Amazon Resource Name (ARN) of the flow module.
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidContactFlowModuleExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.IdempotencyExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_hours_of_operation(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
See also: AWS API Documentation
Request Syntax
response = client.create_hours_of_operation(
InstanceId='string',
Name='string',
Description='string',
TimeZone='string',
Config=[
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the hours of operation.
[REQUIRED]
The time zone of the hours of operation.
[REQUIRED]
Configuration information for the hours of operation: day, start time, and end time.
Contains information about the hours of operation.
The day that the hours of operation applies to.
The start time that your contact center opens.
The hours.
The minutes.
The end time that your contact center closes.
The hours.
The minutes.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string'
}
Response Structure
(dict) --
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Exceptions
Connect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_instance(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_instance(
ClientToken='string',
IdentityManagementType='SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
InstanceAlias='string',
DirectoryId='string',
InboundCallsEnabled=True|False,
OutboundCallsEnabled=True|False
)
[REQUIRED]
The type of identity management for your Amazon Connect users.
[REQUIRED]
Your contact center handles incoming contacts.
[REQUIRED]
Your contact center allows outbound calls.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier for the instance.
Arn (string) --
The Amazon Resource Name (ARN) of the instance.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_integration_association(**kwargs)¶Creates an Amazon Web Services resource association with an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.create_integration_association(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
IntegrationArn='string',
SourceApplicationUrl='string',
SourceApplicationName='string',
SourceType='SALESFORCE'|'ZENDESK',
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The type of information to be ingested.
[REQUIRED]
The Amazon Resource Name (ARN) of the integration.
Note
When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string'
}
Response Structure
(dict) --
IntegrationAssociationId (string) --
The identifier for the integration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the association.
Exceptions
Connect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptioncreate_queue(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.create_queue(
InstanceId='string',
Name='string',
Description='string',
OutboundCallerConfig={
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
},
HoursOfOperationId='string',
MaxContacts=123,
QuickConnectIds=[
'string',
],
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the queue.
The outbound caller ID name, number, and outbound whisper flow.
The caller ID name.
The caller ID number.
The outbound whisper flow to be used during an outbound call.
[REQUIRED]
The identifier for the hours of operation.
The quick connects available to agents who are working the queue.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'QueueArn': 'string',
'QueueId': 'string'
}
Response Structure
(dict) --
QueueArn (string) --
The Amazon Resource Name (ARN) of the queue.
QueueId (string) --
The identifier for the queue.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_quick_connect(**kwargs)¶Creates a quick connect for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.create_quick_connect(
InstanceId='string',
Name='string',
Description='string',
QuickConnectConfig={
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
}
},
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the quick connect.
[REQUIRED]
Configuration settings for the quick connect.
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).
The user configuration. This is required only if QuickConnectType is USER.
The identifier of the user.
The identifier of the flow.
The queue configuration. This is required only if QuickConnectType is QUEUE.
The identifier for the queue.
The identifier of the flow.
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
The phone number in E.164 format.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'QuickConnectARN': 'string',
'QuickConnectId': 'string'
}
Response Structure
(dict) --
QuickConnectARN (string) --
The Amazon Resource Name (ARN) for the quick connect.
QuickConnectId (string) --
The identifier for the quick connect.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_routing_profile(**kwargs)¶Creates a new routing profile.
See also: AWS API Documentation
Request Syntax
response = client.create_routing_profile(
InstanceId='string',
Name='string',
Description='string',
DefaultOutboundQueueId='string',
QueueConfigs=[
{
'QueueReference': {
'QueueId': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK'
},
'Priority': 123,
'Delay': 123
},
],
MediaConcurrencies=[
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123
},
],
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the routing profile. Must not be more than 127 characters.
[REQUIRED]
Description of the routing profile. Must not be more than 250 characters.
[REQUIRED]
The default outbound queue for the routing profile.
The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
Contains information about the queue and channel for which priority and delay can be set.
Contains information about a queue resource.
The identifier for the queue.
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay .
The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .
[REQUIRED]
The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
The channels that agents can handle in the Contact Control Panel (CCP).
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'RoutingProfileArn': 'string',
'RoutingProfileId': 'string'
}
Response Structure
(dict) --
RoutingProfileArn (string) --
The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileId (string) --
The identifier of the routing profile.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_security_profile(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Creates a security profile.
See also: AWS API Documentation
Request Syntax
response = client.create_security_profile(
SecurityProfileName='string',
Description='string',
Permissions=[
'string',
],
InstanceId='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the security profile.
Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions .
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'SecurityProfileId': 'string',
'SecurityProfileArn': 'string'
}
Response Structure
(dict) --
SecurityProfileId (string) --
The identifier for the security profle.
SecurityProfileArn (string) --
The Amazon Resource Name (ARN) for the security profile.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_task_template(**kwargs)¶Creates a new task template in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.create_task_template(
InstanceId='string',
Name='string',
Description='string',
ContactFlowId='string',
Constraints={
'RequiredFields': [
{
'Id': {
'Name': 'string'
}
},
],
'ReadOnlyFields': [
{
'Id': {
'Name': 'string'
}
},
],
'InvisibleFields': [
{
'Id': {
'Name': 'string'
}
},
]
},
Defaults={
'DefaultFieldValues': [
{
'Id': {
'Name': 'string'
},
'DefaultValue': 'string'
},
]
},
Status='ACTIVE'|'INACTIVE',
Fields=[
{
'Id': {
'Name': 'string'
},
'Description': 'string',
'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL',
'SingleSelectOptions': [
'string',
]
},
],
ClientToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the task template.
Constraints that are applicable to the fields listed.
Lists the fields that are required to be filled by agents.
Information about a required field.
The unique identifier for the field.
The name of the task template field.
Lists the fields that are read-only to agents, and cannot be edited.
Indicates a field that is read-only to an agent.
Identifier of the read-only field.
The name of the task template field.
Lists the fields that are invisible to agents.
A field that is invisible to an agent.
Identifier of the invisible field.
The name of the task template field.
The default values for fields when a task is created by referencing this template.
Default value for the field.
Describes a default field and its corresponding value.
Identifier of a field.
The name of the task template field.
Default value for the field.
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.[REQUIRED]
Fields that are part of the template.
Describes a single task template field.
The unique identifier for the field.
The name of the task template field.
The description of the field.
Indicates the type of field.
A list of options for a single select field.
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the task template resource.
Arn (string) --
The Amazon Resource Name (ARN) for the task template resource.
Exceptions
Connect.Client.exceptions.PropertyValidationExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_traffic_distribution_group(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_traffic_distribution_group(
Name='string',
Description='string',
InstanceId='string',
ClientToken='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name for the traffic distribution group.
[REQUIRED]
The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.
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 .
This field is autopopulated if not provided.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
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.
Arn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.ResourceNotReadyExceptioncreate_use_case(**kwargs)¶Creates a use case for an integration association.
See also: AWS API Documentation
Request Syntax
response = client.create_use_case(
InstanceId='string',
IntegrationAssociationId='string',
UseCaseType='RULES_EVALUATION'|'CONNECT_CAMPAIGNS',
Tags={
'string': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the integration association.
[REQUIRED]
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'UseCaseId': 'string',
'UseCaseArn': 'string'
}
Response Structure
(dict) --
UseCaseId (string) --
The identifier of the use case.
UseCaseArn (string) --
The Amazon Resource Name (ARN) for the use case.
Exceptions
Connect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptioncreate_user(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_user(
Username='string',
Password='string',
IdentityInfo={
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'SecondaryEmail': 'string',
'Mobile': 'string'
},
PhoneConfig={
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
DirectoryUserId='string',
SecurityProfileIds=[
'string',
],
RoutingProfileId='string',
HierarchyGroupId='string',
InstanceId='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
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_-.@]+.
The information about the identity of the user.
The first name. This is required if you are using Amazon Connect or SAML for identity management.
The last name. This is required if you are using Amazon Connect or SAML for identity management.
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
The user's mobile number.
[REQUIRED]
The phone settings for the user.
The phone type.
The Auto accept setting.
The After Call Work (ACW) timeout setting, in seconds.
Note
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
The phone number for the user's desk phone.
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.
[REQUIRED]
The identifier of the security profile for the user.
[REQUIRED]
The identifier of the routing profile for the user.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'UserId': 'string',
'UserArn': 'string'
}
Response Structure
(dict) --
UserId (string) --
The identifier of the user account.
UserArn (string) --
The Amazon Resource Name (ARN) of the user account.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_user_hierarchy_group(**kwargs)¶Creates a new user hierarchy group.
See also: AWS API Documentation
Request Syntax
response = client.create_user_hierarchy_group(
Name='string',
ParentGroupId='string',
InstanceId='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the user hierarchy group. Must not be more than 100 characters.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'HierarchyGroupId': 'string',
'HierarchyGroupArn': 'string'
}
Response Structure
(dict) --
HierarchyGroupId (string) --
The identifier of the hierarchy group.
HierarchyGroupArn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptioncreate_vocabulary(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_vocabulary(
ClientToken='string',
InstanceId='string',
VocabularyName='string',
LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
Content='string',
Tags={
'string': 'string'
}
)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs . If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.
This field is autopopulated if not provided.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A unique name of the custom vocabulary.
[REQUIRED]
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
[REQUIRED]
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 .
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
dict
Response Syntax
{
'VocabularyArn': 'string',
'VocabularyId': 'string',
'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS'
}
Response Structure
(dict) --
VocabularyArn (string) --
The Amazon Resource Name (ARN) of the custom vocabulary.
VocabularyId (string) --
The identifier of the custom vocabulary.
State (string) --
The current state of the custom vocabulary.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptiondelete_contact_flow(**kwargs)¶Deletes a flow for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact_flow(
InstanceId='string',
ContactFlowId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow.
None
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptiondelete_contact_flow_module(**kwargs)¶Deletes the specified flow module.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact_flow_module(
InstanceId='string',
ContactFlowModuleId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow module.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_hours_of_operation(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_hours_of_operation(
InstanceId='string',
HoursOfOperationId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the hours of operation.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_instance(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_instance(
InstanceId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptiondelete_integration_association(**kwargs)¶Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
See also: AWS API Documentation
Request Syntax
response = client.delete_integration_association(
InstanceId='string',
IntegrationAssociationId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the integration association.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptiondelete_quick_connect(**kwargs)¶Deletes a quick connect.
See also: AWS API Documentation
Request Syntax
response = client.delete_quick_connect(
InstanceId='string',
QuickConnectId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the quick connect.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_security_profile(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Deletes a security profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_security_profile(
InstanceId='string',
SecurityProfileId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the security profle.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceInUseExceptiondelete_task_template(**kwargs)¶Deletes the task template.
See also: AWS API Documentation
Request Syntax
response = client.delete_task_template(
InstanceId='string',
TaskTemplateId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A unique identifier for the task template.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_traffic_distribution_group(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_traffic_distribution_group(
TrafficDistributionGroupId='string'
)
[REQUIRED]
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.
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceInUseExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_use_case(**kwargs)¶Deletes a use case from an integration association.
See also: AWS API Documentation
Request Syntax
response = client.delete_use_case(
InstanceId='string',
IntegrationAssociationId='string',
UseCaseId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the integration association.
[REQUIRED]
The identifier for the use case.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptiondelete_user(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
InstanceId='string',
UserId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the user.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_user_hierarchy_group(**kwargs)¶Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_hierarchy_group(
HierarchyGroupId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the hierarchy group.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceInUseExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondelete_vocabulary(**kwargs)¶Deletes the vocabulary that has the given identifier.
See also: AWS API Documentation
Request Syntax
response = client.delete_vocabulary(
InstanceId='string',
VocabularyId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the custom vocabulary.
dict
Response Syntax
{
'VocabularyArn': 'string',
'VocabularyId': 'string',
'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS'
}
Response Structure
(dict) --
VocabularyArn (string) --
The Amazon Resource Name (ARN) of the custom vocabulary.
VocabularyId (string) --
The identifier of the custom vocabulary.
State (string) --
The current state of the custom vocabulary.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceInUseExceptiondescribe_agent_status(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
See also: AWS API Documentation
Request Syntax
response = client.describe_agent_status(
InstanceId='string',
AgentStatusId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the agent status.
dict
Response Syntax
{
'AgentStatus': {
'AgentStatusARN': 'string',
'AgentStatusId': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE',
'DisplayOrder': 123,
'State': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
AgentStatus (dict) --
The agent status.
AgentStatusARN (string) --
The Amazon Resource Name (ARN) of the agent status.
AgentStatusId (string) --
The identifier of the agent status.
Name (string) --
The name of the agent status.
Description (string) --
The description of the agent status.
Type (string) --
The type of agent status.
DisplayOrder (integer) --
The display order of the agent status.
State (string) --
The state of the agent status.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_contact(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_contact(
InstanceId='string',
ContactId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
dict
Response Syntax
{
'Contact': {
'Arn': 'string',
'Id': 'string',
'InitialContactId': 'string',
'PreviousContactId': 'string',
'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API',
'Name': 'string',
'Description': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK',
'QueueInfo': {
'Id': 'string',
'EnqueueTimestamp': datetime(2015, 1, 1)
},
'AgentInfo': {
'Id': 'string',
'ConnectedToAgentTimestamp': datetime(2015, 1, 1)
},
'InitiationTimestamp': datetime(2015, 1, 1),
'DisconnectTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'ScheduledTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Contact (dict) --
Information about the contact.
Arn (string) --
The Amazon Resource Name (ARN) for the contact.
Id (string) --
The identifier for the contact.
InitialContactId (string) --
If this contact is related to other contacts, this is the ID of the initial contact.
PreviousContactId (string) --
If this contact is not the first contact, this is the ID of the previous contact.
InitiationMethod (string) --
Indicates how the contact was initiated.
Name (string) --
The name of the contact.
Description (string) --
The description of the contact.
Channel (string) --
How the contact reached your contact center.
QueueInfo (dict) --
If this contact was queued, this contains information about the queue.
Id (string) --
The unique identifier for the queue.
EnqueueTimestamp (datetime) --
The timestamp when the contact was added to the queue.
AgentInfo (dict) --
Information about the agent who accepted the contact.
Id (string) --
The identifier of the agent who accepted the contact.
ConnectedToAgentTimestamp (datetime) --
The timestamp when the contact was connected to the agent.
InitiationTimestamp (datetime) --
The date and time this contact was initiated, in UTC time. For INBOUND , this is when the contact arrived. For OUTBOUND , this is when the agent began dialing. For CALLBACK , this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER , this is when the transfer was initiated. For API , this is when the request arrived.
DisconnectTimestamp (datetime) --
The timestamp when the customer endpoint disconnected from Amazon Connect.
LastUpdateTimestamp (datetime) --
The timestamp when contact was last updated.
ScheduledTimestamp (datetime) --
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptiondescribe_contact_flow(**kwargs)¶Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language .
See also: AWS API Documentation
Request Syntax
response = client.describe_contact_flow(
InstanceId='string',
ContactFlowId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the flow.
dict
Response Syntax
{
'ContactFlow': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
'State': 'ACTIVE'|'ARCHIVED',
'Description': 'string',
'Content': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ContactFlow (dict) --
Information about the flow.
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
Id (string) --
The identifier of the flow.
Name (string) --
The name of the flow.
Type (string) --
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide .
State (string) --
The type of flow.
Description (string) --
The description of the flow.
Content (string) --
The content of the flow.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ContactFlowNotPublishedExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_contact_flow_module(**kwargs)¶Describes the specified flow module.
See also: AWS API Documentation
Request Syntax
response = client.describe_contact_flow_module(
InstanceId='string',
ContactFlowModuleId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow module.
dict
Response Syntax
{
'ContactFlowModule': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Content': 'string',
'Description': 'string',
'State': 'ACTIVE'|'ARCHIVED',
'Status': 'PUBLISHED'|'SAVED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ContactFlowModule (dict) --
Information about the flow module.
Arn (string) --
The Amazon Resource Name (ARN).
Id (string) --
The identifier of the flow module.
Name (string) --
The name of the flow module.
Content (string) --
The content of the flow module.
Description (string) --
The description of the flow module.
State (string) --
The type of flow module.
Status (string) --
The status of the flow module.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_hours_of_operation(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_hours_of_operation(
InstanceId='string',
HoursOfOperationId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the hours of operation.
dict
Response Syntax
{
'HoursOfOperation': {
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'TimeZone': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
HoursOfOperation (dict) --
The hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name for the hours of operation.
Description (string) --
The description for the hours of operation.
TimeZone (string) --
The time zone for the hours of operation.
Config (list) --
Configuration information for the hours of operation.
(dict) --
Contains information about the hours of operation.
Day (string) --
The day that the hours of operation applies to.
StartTime (dict) --
The start time that your contact center opens.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_instance(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_instance(
InstanceId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
{
'Instance': {
'Id': 'string',
'Arn': 'string',
'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
'InstanceAlias': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ServiceRole': 'string',
'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
'StatusReason': {
'Message': 'string'
},
'InboundCallsEnabled': True|False,
'OutboundCallsEnabled': True|False
}
}
Response Structure
The name of the instance.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The Amazon Resource Name (ARN) of the instance.
The identity management type.
The alias of instance.
When the instance was created.
The service role of the instance.
The state of the instance.
Relevant details why the instance was not successfully created.
The message.
Whether inbound calls are enabled.
Whether outbound calls are enabled.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_instance_attribute(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_attribute(
InstanceId='string',
AttributeType='INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The type of attribute.
dict
Response Syntax
{
'Attribute': {
'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND',
'Value': 'string'
}
}
Response Structure
(dict) --
Attribute (dict) --
The type of attribute.
AttributeType (string) --
The type of attribute.
Value (string) --
The value of the attribute.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondescribe_instance_storage_config(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_storage_config(
InstanceId='string',
AssociationId='string',
ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
[REQUIRED]
A valid resource type.
dict
Response Syntax
{
'StorageConfig': {
'AssociationId': 'string',
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'S3Config': {
'BucketName': 'string',
'BucketPrefix': 'string',
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisVideoStreamConfig': {
'Prefix': 'string',
'RetentionPeriodHours': 123,
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisStreamConfig': {
'StreamArn': 'string'
},
'KinesisFirehoseConfig': {
'FirehoseArn': 'string'
}
}
}
Response Structure
(dict) --
StorageConfig (dict) --
A valid storage type.
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
StorageType (string) --
A valid storage type.
S3Config (dict) --
The S3 bucket configuration.
BucketName (string) --
The S3 bucket name.
BucketPrefix (string) --
The S3 bucket prefix.
EncryptionConfig (dict) --
The Amazon S3 encryption configuration.
EncryptionType (string) --
The type of encryption.
KeyId (string) --
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
KinesisVideoStreamConfig (dict) --
The configuration of the Kinesis video stream.
Prefix (string) --
The prefix of the video stream.
RetentionPeriodHours (integer) --
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
EncryptionConfig (dict) --
The encryption configuration.
EncryptionType (string) --
The type of encryption.
KeyId (string) --
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
KinesisStreamConfig (dict) --
The configuration of the Kinesis data stream.
StreamArn (string) --
The Amazon Resource Name (ARN) of the data stream.
KinesisFirehoseConfig (dict) --
The configuration of the Kinesis Firehose delivery stream.
FirehoseArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondescribe_phone_number(**kwargs)¶Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_phone_number(
PhoneNumberId='string'
)
[REQUIRED]
A unique identifier for the phone number.
{
'ClaimedPhoneNumberSummary': {
'PhoneNumberId': 'string',
'PhoneNumberArn': 'string',
'PhoneNumber': 'string',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'PhoneNumberDescription': 'string',
'TargetArn': 'string',
'Tags': {
'string': 'string'
},
'PhoneNumberStatus': {
'Status': 'CLAIMED'|'IN_PROGRESS'|'FAILED',
'Message': 'string'
}
}
}
Response Structure
Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
A unique identifier for the phone number.
The Amazon Resource Name (ARN) of the phone number.
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
The ISO country code.
The type of phone number.
The description of the phone number.
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
The status of the phone number.
CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.FAILED indicates that the previous ClaimedPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.Note
You will not be billed for the phone number during the 1-day period if number claiming fails.
The status.
The status message.
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.AccessDeniedExceptiondescribe_queue(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
See also: AWS API Documentation
Request Syntax
response = client.describe_queue(
InstanceId='string',
QueueId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
dict
Response Syntax
{
'Queue': {
'Name': 'string',
'QueueArn': 'string',
'QueueId': 'string',
'Description': 'string',
'OutboundCallerConfig': {
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
},
'HoursOfOperationId': 'string',
'MaxContacts': 123,
'Status': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Queue (dict) --
The name of the queue.
Name (string) --
The name of the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) for the queue.
QueueId (string) --
The identifier for the queue.
Description (string) --
The description of the queue.
OutboundCallerConfig (dict) --
The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerIdName (string) --
The caller ID name.
OutboundCallerIdNumberId (string) --
The caller ID number.
OutboundFlowId (string) --
The outbound whisper flow to be used during an outbound call.
HoursOfOperationId (string) --
The identifier for the hours of operation.
MaxContacts (integer) --
The maximum number of contacts that can be in the queue before it is considered full.
Status (string) --
The status of the queue.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_quick_connect(**kwargs)¶Describes the quick connect.
See also: AWS API Documentation
Request Syntax
response = client.describe_quick_connect(
InstanceId='string',
QuickConnectId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the quick connect.
dict
Response Syntax
{
'QuickConnect': {
'QuickConnectARN': 'string',
'QuickConnectId': 'string',
'Name': 'string',
'Description': 'string',
'QuickConnectConfig': {
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
}
},
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
QuickConnect (dict) --
Information about the quick connect.
QuickConnectARN (string) --
The Amazon Resource Name (ARN) of the quick connect.
QuickConnectId (string) --
The identifier for the quick connect.
Name (string) --
The name of the quick connect.
Description (string) --
The description.
QuickConnectConfig (dict) --
Contains information about the quick connect.
QuickConnectType (string) --
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).
UserConfig (dict) --
The user configuration. This is required only if QuickConnectType is USER.
UserId (string) --
The identifier of the user.
ContactFlowId (string) --
The identifier of the flow.
QueueConfig (dict) --
The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueId (string) --
The identifier for the queue.
ContactFlowId (string) --
The identifier of the flow.
PhoneConfig (dict) --
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
PhoneNumber (string) --
The phone number in E.164 format.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_routing_profile(**kwargs)¶Describes the specified routing profile.
See also: AWS API Documentation
Request Syntax
response = client.describe_routing_profile(
InstanceId='string',
RoutingProfileId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
dict
Response Syntax
{
'RoutingProfile': {
'InstanceId': 'string',
'Name': 'string',
'RoutingProfileArn': 'string',
'RoutingProfileId': 'string',
'Description': 'string',
'MediaConcurrencies': [
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123
},
],
'DefaultOutboundQueueId': 'string',
'Tags': {
'string': 'string'
},
'NumberOfAssociatedQueues': 123,
'NumberOfAssociatedUsers': 123
}
}
Response Structure
(dict) --
RoutingProfile (dict) --
The routing profile.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Name (string) --
The name of the routing profile.
RoutingProfileArn (string) --
The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileId (string) --
The identifier of the routing profile.
Description (string) --
The description of the routing profile.
MediaConcurrencies (list) --
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
(dict) --
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
Channel (string) --
The channels that agents can handle in the Contact Control Panel (CCP).
Concurrency (integer) --
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
DefaultOutboundQueueId (string) --
The identifier of the default outbound queue for this routing profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
NumberOfAssociatedQueues (integer) --
The number of associated queues in routing profile.
NumberOfAssociatedUsers (integer) --
The number of associated users in routing profile.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_security_profile(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Gets basic information about the security profle.
See also: AWS API Documentation
Request Syntax
response = client.describe_security_profile(
SecurityProfileId='string',
InstanceId='string'
)
[REQUIRED]
The identifier for the security profle.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'SecurityProfile': {
'Id': 'string',
'OrganizationResourceId': 'string',
'Arn': 'string',
'SecurityProfileName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
SecurityProfile (dict) --
The security profile.
Id (string) --
The identifier for the security profile.
OrganizationResourceId (string) --
The organization resource identifier for the security profile.
Arn (string) --
The Amazon Resource Name (ARN) for the secruity profile.
SecurityProfileName (string) --
The name for the security profile.
Description (string) --
The description of the security profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_traffic_distribution_group(**kwargs)¶Gets details and status of a traffic distribution group.
See also: AWS API Documentation
Request Syntax
response = client.describe_traffic_distribution_group(
TrafficDistributionGroupId='string'
)
[REQUIRED]
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.
{
'TrafficDistributionGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'InstanceArn': 'string',
'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS',
'Tags': {
'string': 'string'
}
}
}
Response Structure
Information about the traffic distribution group.
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.
The Amazon Resource Name (ARN) of the traffic distribution group.
The name of the traffic distribution group.
The description of the traffic distribution group.
The Amazon Resource Name (ARN).
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptiondescribe_user(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_user(
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'User': {
'Id': 'string',
'Arn': 'string',
'Username': 'string',
'IdentityInfo': {
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'SecondaryEmail': 'string',
'Mobile': 'string'
},
'PhoneConfig': {
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
'DirectoryUserId': 'string',
'SecurityProfileIds': [
'string',
],
'RoutingProfileId': 'string',
'HierarchyGroupId': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
User (dict) --
Information about the user account and configuration settings.
Id (string) --
The identifier of the user account.
Arn (string) --
The Amazon Resource Name (ARN) of the user account.
Username (string) --
The user name assigned to the user account.
IdentityInfo (dict) --
Information about the user identity.
FirstName (string) --
The first name. This is required if you are using Amazon Connect or SAML for identity management.
LastName (string) --
The last name. This is required if you are using Amazon Connect or SAML for identity management.
Email (string) --
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
SecondaryEmail (string) --
The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
Mobile (string) --
The user's mobile number.
PhoneConfig (dict) --
Information about the phone configuration for the user.
PhoneType (string) --
The phone type.
AutoAccept (boolean) --
The Auto accept setting.
AfterContactWorkTimeLimit (integer) --
The After Call Work (ACW) timeout setting, in seconds.
Note
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
DeskPhoneNumber (string) --
The phone number for the user's desk phone.
DirectoryUserId (string) --
The identifier of the user account in the directory used for identity management.
SecurityProfileIds (list) --
The identifiers of the security profiles for the user.
RoutingProfileId (string) --
The identifier of the routing profile for the user.
HierarchyGroupId (string) --
The identifier of the hierarchy group for the user.
Tags (dict) --
The tags.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_user_hierarchy_group(**kwargs)¶Describes the specified hierarchy group.
See also: AWS API Documentation
Request Syntax
response = client.describe_user_hierarchy_group(
HierarchyGroupId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the hierarchy group.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'HierarchyGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LevelId': 'string',
'HierarchyPath': {
'LevelOne': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
},
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
HierarchyGroup (dict) --
Information about the hierarchy group.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelId (string) --
The identifier of the level in the hierarchy group.
HierarchyPath (dict) --
Information about the levels in the hierarchy group.
LevelOne (dict) --
Information about level one.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelTwo (dict) --
Information about level two.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelThree (dict) --
Information about level three.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelFour (dict) --
Information about level four.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelFive (dict) --
Information about level five.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_user_hierarchy_structure(**kwargs)¶Describes the hierarchy structure of the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.describe_user_hierarchy_structure(
InstanceId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
{
'HierarchyStructure': {
'LevelOne': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
Information about the hierarchy structure.
Information about level one.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level two.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level three.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level four.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level five.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondescribe_vocabulary(**kwargs)¶Describes the specified vocabulary.
See also: AWS API Documentation
Request Syntax
response = client.describe_vocabulary(
InstanceId='string',
VocabularyId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the custom vocabulary.
dict
Response Syntax
{
'Vocabulary': {
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'LanguageCode': 'ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'Content': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Vocabulary (dict) --
A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
Name (string) --
A unique name of the custom vocabulary.
Id (string) --
The identifier of the custom vocabulary.
Arn (string) --
The Amazon Resource Name (ARN) of the custom vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
State (string) --
The current state of the custom vocabulary.
LastModifiedTime (datetime) --
The timestamp when the custom vocabulary was last modified.
FailureReason (string) --
The reason why the custom vocabulary was not created.
Content (string) --
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. For more information, see Create a custom vocabulary using a table .
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptiondisassociate_approved_origin(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_approved_origin(
InstanceId='string',
Origin='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The domain URL of the integrated application.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondisassociate_bot(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_bot(
InstanceId='string',
LexBot={
'Name': 'string',
'LexRegion': 'string'
},
LexV2Bot={
'AliasArn': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Configuration information of an Amazon Lex bot.
The name of the Amazon Lex bot.
The Amazon Web Services Region where the Amazon Lex bot was created.
The Amazon Lex V2 bot to disassociate from the instance.
The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptiondisassociate_instance_storage_config(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_instance_storage_config(
InstanceId='string',
AssociationId='string',
ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
[REQUIRED]
A valid resource type.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondisassociate_lambda_function(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_lambda_function(
InstanceId='string',
FunctionArn='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..
[REQUIRED]
The Amazon Resource Name (ARN) of the Lambda function being disassociated.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondisassociate_lex_bot(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_lex_bot(
InstanceId='string',
BotName='string',
LexRegion='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The name of the Amazon Lex bot. Maximum character limit of 50.
[REQUIRED]
The Amazon Web Services Region in which the Amazon Lex bot has been created.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondisassociate_phone_number_contact_flow(**kwargs)¶Removes the flow association from a phone number claimed to your Amazon Connect instance.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.disassociate_phone_number_contact_flow(
PhoneNumberId='string',
InstanceId='string'
)
[REQUIRED]
A unique identifier for the phone number.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.AccessDeniedExceptiondisassociate_queue_quick_connects(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_queue_quick_connects(
InstanceId='string',
QueueId='string',
QuickConnectIds=[
'string',
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
[REQUIRED]
The quick connects to disassociate from the queue.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondisassociate_routing_profile_queues(**kwargs)¶Disassociates a set of queues from a routing profile.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_routing_profile_queues(
InstanceId='string',
RoutingProfileId='string',
QueueReferences=[
{
'QueueId': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK'
},
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
[REQUIRED]
The queues to disassociate from this routing profile.
Contains the channel and queue identifier for a routing profile.
The identifier for the queue.
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptiondisassociate_security_key(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_security_key(
InstanceId='string',
AssociationId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptiondismiss_user_contact(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.dismiss_user_contact(
UserId='string',
InstanceId='string',
ContactId='string'
)
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InternalServiceExceptionget_contact_attributes(**kwargs)¶Retrieves the contact attributes for the specified contact.
See also: AWS API Documentation
Request Syntax
response = client.get_contact_attributes(
InstanceId='string',
InitialContactId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the initial contact.
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
Attributes (dict) --
Information about the attributes.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionget_current_metric_data(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.get_current_metric_data(
InstanceId='string',
Filters={
'Queues': [
'string',
],
'Channels': [
'VOICE'|'CHAT'|'TASK',
]
},
Groupings=[
'QUEUE'|'CHANNEL',
],
CurrentMetrics=[
{
'Name': 'AGENTS_ONLINE'|'AGENTS_AVAILABLE'|'AGENTS_ON_CALL'|'AGENTS_NON_PRODUCTIVE'|'AGENTS_AFTER_CONTACT_WORK'|'AGENTS_ERROR'|'AGENTS_STAFFED'|'CONTACTS_IN_QUEUE'|'OLDEST_CONTACT_AGE'|'CONTACTS_SCHEDULED'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
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.
The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
The channel to use to filter the metrics.
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 no Grouping is included in the request, a summary of metrics is returned.
[REQUIRED]
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 .
AGENTS_AFTER_CONTACT_WORK
Unit: COUNT
Name in real-time metrics report: ACW
AGENTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Available
AGENTS_ERROR
Unit: COUNT
Name in real-time metrics report: Error
AGENTS_NON_PRODUCTIVE
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
AGENTS_ON_CALL
Unit: COUNT
Name in real-time metrics report: On contact
AGENTS_ON_CONTACT
Unit: COUNT
Name in real-time metrics report: On contact
AGENTS_ONLINE
Unit: COUNT
Name in real-time metrics report: Online
AGENTS_STAFFED
Unit: COUNT
Name in real-time metrics report: Staffed
CONTACTS_IN_QUEUE
Unit: COUNT
Name in real-time metrics report: In queue
CONTACTS_SCHEDULED
Unit: COUNT
Name in real-time metrics report: Scheduled
OLDEST_CONTACT_AGE
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": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0}
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
SLOTS_ACTIVE
Unit: COUNT
Name in real-time metrics report: Active
SLOTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Availability
Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide .
The name of the metric.
The unit for the metric.
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.
dict
Response Syntax
{
'NextToken': 'string',
'MetricResults': [
{
'Dimensions': {
'Queue': {
'Id': 'string',
'Arn': 'string'
},
'Channel': 'VOICE'|'CHAT'|'TASK'
},
'Collections': [
{
'Metric': {
'Name': 'AGENTS_ONLINE'|'AGENTS_AVAILABLE'|'AGENTS_ON_CALL'|'AGENTS_NON_PRODUCTIVE'|'AGENTS_AFTER_CONTACT_WORK'|'AGENTS_ERROR'|'AGENTS_STAFFED'|'CONTACTS_IN_QUEUE'|'OLDEST_CONTACT_AGE'|'CONTACTS_SCHEDULED'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
'Value': 123.0
},
]
},
],
'DataSnapshotTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for 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.
MetricResults (list) --
Information about the real-time metrics.
(dict) --
Contains information about a set of real-time metrics.
Dimensions (dict) --
The dimensions for the metrics.
Queue (dict) --
Information about the queue for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Channel (string) --
The channel used for grouping and filters.
Collections (list) --
The set of metrics.
(dict) --
Contains the data for a real-time metric.
Metric (dict) --
Information about the metric.
Name (string) --
The name of the metric.
Unit (string) --
The unit for the metric.
Value (float) --
The value of the metric.
DataSnapshotTime (datetime) --
The time at which the metrics were retrieved and cached for pagination.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ResourceNotFoundExceptionget_current_user_data(**kwargs)¶Gets the real-time active user data from the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.get_current_user_data(
InstanceId='string',
Filters={
'Queues': [
'string',
],
'ContactFilter': {
'ContactStates': [
'INCOMING'|'PENDING'|'CONNECTING'|'CONNECTED'|'CONNECTED_ONHOLD'|'MISSED'|'ERROR'|'ENDED'|'REJECTED',
]
}
},
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
Filters up to 100 Queues , or up to 9 ContactStates . The user data is retrieved only for those users who are associated with the queues and have contacts that are in the specified ContactState .
Contains information about a queue resource for which metrics are returned.
A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.
A list of up to 9 contact states .
dict
Response Syntax
{
'NextToken': 'string',
'UserDataList': [
{
'User': {
'Id': 'string',
'Arn': 'string'
},
'RoutingProfile': {
'Id': 'string',
'Arn': 'string'
},
'HierarchyPath': {
'LevelOne': {
'Id': 'string',
'Arn': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string'
}
},
'Status': {
'StatusStartTimestamp': datetime(2015, 1, 1),
'StatusArn': 'string'
},
'AvailableSlotsByChannel': {
'string': 123
},
'MaxSlotsByChannel': {
'string': 123
},
'ActiveSlotsByChannel': {
'string': 123
},
'Contacts': [
{
'ContactId': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK',
'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API',
'AgentContactState': 'INCOMING'|'PENDING'|'CONNECTING'|'CONNECTED'|'CONNECTED_ONHOLD'|'MISSED'|'ERROR'|'ENDED'|'REJECTED',
'StateStartTimestamp': datetime(2015, 1, 1),
'ConnectedToAgentTimestamp': datetime(2015, 1, 1),
'Queue': {
'Id': 'string',
'Arn': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
UserDataList (list) --
A list of the user data that is returned.
(dict) --
Data for a user.
User (dict) --
Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
Id (string) --
The unique identifier for the user.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
RoutingProfile (dict) --
Information about the routing profile that is assigned to the user.
Id (string) --
The identifier of the routing profile.
Arn (string) --
The Amazon Resource Name (ARN) of the routing profile.
HierarchyPath (dict) --
Contains information about the levels of a hierarchy group assigned to a user.
LevelOne (dict) --
Information about level one.
Id (string) --
The unique identifier for the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) for the hierarchy group.
LevelTwo (dict) --
Information about level two.
Id (string) --
The unique identifier for the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) for the hierarchy group.
LevelThree (dict) --
Information about level three.
Id (string) --
The unique identifier for the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) for the hierarchy group.
LevelFour (dict) --
Information about level four.
Id (string) --
The unique identifier for the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) for the hierarchy group.
LevelFive (dict) --
Information about level five.
Id (string) --
The unique identifier for the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) for the hierarchy group.
Status (dict) --
The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
StatusStartTimestamp (datetime) --
The start timestamp of the agent's status.
StatusArn (string) --
The Amazon Resource Name (ARN) of the agent's status.
AvailableSlotsByChannel (dict) --
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
MaxSlotsByChannel (dict) --
A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
ActiveSlotsByChannel (dict) --
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
Contacts (list) --
A list of contact reference information.
(dict) --
Information about the contact associated to the user.
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
Channel (string) --
The channel of the contact.
InitiationMethod (string) --
How the contact was initiated.
AgentContactState (string) --
The state of the contact .
StateStartTimestamp (datetime) --
The epoch timestamp when the contact state started.
ConnectedToAgentTimestamp (datetime) --
The time at which the contact was connected to an agent.
Queue (dict) --
Contains information about a queue resource for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ResourceNotFoundExceptionget_federation_token(**kwargs)¶Retrieves a token for federation.
Note
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
See also: AWS API Documentation
Request Syntax
response = client.get_federation_token(
InstanceId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
{
'Credentials': {
'AccessToken': 'string',
'AccessTokenExpiration': datetime(2015, 1, 1),
'RefreshToken': 'string',
'RefreshTokenExpiration': datetime(2015, 1, 1)
}
}
Response Structure
The credentials to use for federation.
An access token generated for a federated user to access Amazon Connect.
A token generated with an expiration time for the session a user is logged in to Amazon Connect.
Renews a token generated for a user to access the Amazon Connect instance.
Renews the expiration timer for a generated token.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.UserNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.DuplicateResourceExceptionget_metric_data(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.get_metric_data(
InstanceId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Filters={
'Queues': [
'string',
],
'Channels': [
'VOICE'|'CHAT'|'TASK',
]
},
Groupings=[
'QUEUE'|'CHANNEL',
],
HistoricalMetrics=[
{
'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
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.
[REQUIRED]
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.
[REQUIRED]
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.
Note
To filter by Queues , enter the queue ID/ARN, not the name of the queue.
The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
The channel to use to filter the metrics.
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.
[REQUIRED]
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 .
Note
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
ABANDON_TIME
Unit: SECONDS
Statistic: AVG
AFTER_CONTACT_WORK_TIME
Unit: SECONDS
Statistic: AVG
API_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CALLBACK_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_ABANDONED
Unit: COUNT
Statistic: SUM
CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNT
Statistic: SUM
CONTACTS_CONSULTED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_INCOMING
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_OUTBOUND
Unit: COUNT
Statistic: SUM
CONTACTS_HOLD_ABANDONS
Unit: COUNT
Statistic: SUM
CONTACTS_MISSED
Unit: COUNT
Statistic: SUM
CONTACTS_QUEUED
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNT
Statistic: SUM
HANDLE_TIME
Unit: SECONDS
Statistic: AVG
HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_AND_HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_TIME
Unit: SECONDS
Statistic: AVG
OCCUPANCY
Unit: PERCENT
Statistic: AVG
QUEUE_ANSWER_TIME
Unit: SECONDS
Statistic: AVG
QUEUED_TIME
Unit: SECONDS
Statistic: MAX
SERVICE_LEVEL
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").
Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .
The name of the metric.
The threshold for the metric, used with service level metrics.
The type of comparison. Only "less than" (LT) comparisons are supported.
The threshold value to compare.
The statistic for the metric.
The unit for the metric.
dict
Response Syntax
{
'NextToken': 'string',
'MetricResults': [
{
'Dimensions': {
'Queue': {
'Id': 'string',
'Arn': 'string'
},
'Channel': 'VOICE'|'CHAT'|'TASK'
},
'Collections': [
{
'Metric': {
'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
'Value': 123.0
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for 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.
MetricResults (list) --
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
(dict) --
Contains information about the historical metrics retrieved.
Dimensions (dict) --
The dimension for the metrics.
Queue (dict) --
Information about the queue for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Channel (string) --
The channel used for grouping and filters.
Collections (list) --
The set of metrics.
(dict) --
Contains the data for a historical metric.
Metric (dict) --
Information about the metric.
Name (string) --
The name of the metric.
Threshold (dict) --
The threshold for the metric, used with service level metrics.
Comparison (string) --
The type of comparison. Only "less than" (LT) comparisons are supported.
ThresholdValue (float) --
The threshold value to compare.
Statistic (string) --
The statistic for the metric.
Unit (string) --
The unit for the metric.
Value (float) --
The value of the metric.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_task_template(**kwargs)¶Gets details about a specific task template in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.get_task_template(
InstanceId='string',
TaskTemplateId='string',
SnapshotVersion='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A unique identifier for the task template.
dict
Response Syntax
{
'InstanceId': 'string',
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'Constraints': {
'RequiredFields': [
{
'Id': {
'Name': 'string'
}
},
],
'ReadOnlyFields': [
{
'Id': {
'Name': 'string'
}
},
],
'InvisibleFields': [
{
'Id': {
'Name': 'string'
}
},
]
},
'Defaults': {
'DefaultFieldValues': [
{
'Id': {
'Name': 'string'
},
'DefaultValue': 'string'
},
]
},
'Fields': [
{
'Id': {
'Name': 'string'
},
'Description': 'string',
'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL',
'SingleSelectOptions': [
'string',
]
},
],
'Status': 'ACTIVE'|'INACTIVE',
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Id (string) --
A unique identifier for the task template.
Arn (string) --
The Amazon Resource Name (ARN).
Name (string) --
The name of the task template.
Description (string) --
The description of the task template.
ContactFlowId (string) --
The identifier of the flow that runs by default when a task is created by referencing this template.
Constraints (dict) --
Constraints that are applicable to the fields listed.
RequiredFields (list) --
Lists the fields that are required to be filled by agents.
(dict) --
Information about a required field.
Id (dict) --
The unique identifier for the field.
Name (string) --
The name of the task template field.
ReadOnlyFields (list) --
Lists the fields that are read-only to agents, and cannot be edited.
(dict) --
Indicates a field that is read-only to an agent.
Id (dict) --
Identifier of the read-only field.
Name (string) --
The name of the task template field.
InvisibleFields (list) --
Lists the fields that are invisible to agents.
(dict) --
A field that is invisible to an agent.
Id (dict) --
Identifier of the invisible field.
Name (string) --
The name of the task template field.
Defaults (dict) --
The default values for fields when a task is created by referencing this template.
DefaultFieldValues (list) --
Default value for the field.
(dict) --
Describes a default field and its corresponding value.
Id (dict) --
Identifier of a field.
Name (string) --
The name of the task template field.
DefaultValue (string) --
Default value for the field.
Fields (list) --
Fields that are part of the template.
(dict) --
Describes a single task template field.
Id (dict) --
The unique identifier for the field.
Name (string) --
The name of the task template field.
Description (string) --
The description of the field.
Type (string) --
Indicates the type of field.
SingleSelectOptions (list) --
A list of options for a single select field.
Status (string) --
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.
LastModifiedTime (datetime) --
The timestamp when the task template was last modified.
CreatedTime (datetime) --
The timestamp when the task template was created.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionget_traffic_distribution(**kwargs)¶Retrieves the current traffic distribution for a given traffic distribution group.
See also: AWS API Documentation
Request Syntax
response = client.get_traffic_distribution(
Id='string'
)
[REQUIRED]
The identifier of the traffic distribution group.
{
'TelephonyConfig': {
'Distributions': [
{
'Region': 'string',
'Percentage': 123
},
]
},
'Id': 'string',
'Arn': 'string'
}
Response Structure
The distribution of traffic between the instance and its replicas.
Information about traffic distributions.
Information about a traffic distribution.
The Amazon Web Services Region where the traffic is distributed.
The percentage of the traffic that is distributed, in increments of 10.
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.
The Amazon Resource Name (ARN) of the traffic distribution group.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_agent_statuses(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
See also: AWS API Documentation
Request Syntax
response = client.list_agent_statuses(
InstanceId='string',
NextToken='string',
MaxResults=123,
AgentStatusTypes=[
'ROUTABLE'|'CUSTOM'|'OFFLINE',
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Available agent status types.
dict
Response Syntax
{
'NextToken': 'string',
'AgentStatusSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
AgentStatusSummaryList (list) --
A summary of agent statuses.
(dict) --
Summary information for an agent status.
Id (string) --
The identifier for an agent status.
Arn (string) --
The Amazon Resource Name (ARN) for the agent status.
Name (string) --
The name of the agent status.
Type (string) --
The type of the agent status.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_approved_origins(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_approved_origins(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'Origins': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Origins (list) --
The approved origins.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionlist_bots(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_bots(
InstanceId='string',
NextToken='string',
MaxResults=123,
LexVersion='V1'|'V2'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The version of Amazon Lex or Amazon Lex V2.
dict
Response Syntax
{
'LexBots': [
{
'LexBot': {
'Name': 'string',
'LexRegion': 'string'
},
'LexV2Bot': {
'AliasArn': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LexBots (list) --
The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.
(dict) --
Configuration information of an Amazon Lex or Amazon Lex V2 bot.
LexBot (dict) --
Configuration information of an Amazon Lex bot.
Name (string) --
The name of the Amazon Lex bot.
LexRegion (string) --
The Amazon Web Services Region where the Amazon Lex bot was created.
LexV2Bot (dict) --
Configuration information of an Amazon Lex V2 bot.
AliasArn (string) --
The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptionlist_contact_flow_modules(**kwargs)¶Provides information about the flow modules for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_contact_flow_modules(
InstanceId='string',
NextToken='string',
MaxResults=123,
ContactFlowModuleState='ACTIVE'|'ARCHIVED'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'ContactFlowModulesSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'State': 'ACTIVE'|'ARCHIVED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContactFlowModulesSummaryList (list) --
Information about the flow module.
(dict) --
Contains summary information about a flow.
Id (string) --
The identifier of the flow module.
Arn (string) --
The Amazon Resource Name (ARN) of the flow module.
Name (string) --
The name of the flow module.
State (string) --
The type of flow module.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_contact_flows(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_contact_flows(
InstanceId='string',
ContactFlowTypes=[
'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The type of flow.
dict
Response Syntax
{
'ContactFlowSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
'ContactFlowState': 'ACTIVE'|'ARCHIVED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContactFlowSummaryList (list) --
Information about the flows.
(dict) --
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language .
Id (string) --
The identifier of the flow.
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
Name (string) --
The name of the flow.
ContactFlowType (string) --
The type of flow.
ContactFlowState (string) --
The type of flow.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_contact_references(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_contact_references(
InstanceId='string',
ContactId='string',
ReferenceTypes=[
'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL',
],
NextToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the initial contact.
[REQUIRED]
The type of reference.
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.
Warning
This is not expected to be set, because the value returned in the previous response is always null.
dict
Response Syntax
{
'ReferenceSummaryList': [
{
'Url': {
'Name': 'string',
'Value': 'string'
},
'Attachment': {
'Name': 'string',
'Value': 'string',
'Status': 'APPROVED'|'REJECTED'
},
'String': {
'Name': 'string',
'Value': 'string'
},
'Number': {
'Name': 'string',
'Value': 'string'
},
'Date': {
'Name': 'string',
'Value': 'string'
},
'Email': {
'Name': 'string',
'Value': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReferenceSummaryList (list) --
Information about the flows.
(dict) --
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: Url, Attachment, String, Number, Date, Email. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
Url (dict) --
Information about the reference when the referenceType is URL . Otherwise, null.
Name (string) --
Identifier of the URL reference.
Value (string) --
A valid URL.
Attachment (dict) --
Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.
Name (string) --
Identifier of the attachment reference.
Value (string) --
The location path of the attachment reference.
Status (string) --
Status of the attachment reference type.
String (dict) --
Information about a reference when the referenceType is STRING . Otherwise, null.
Name (string) --
Identifier of the string reference.
Value (string) --
A valid string.
Number (dict) --
Information about a reference when the referenceType is NUMBER . Otherwise, null.
Name (string) --
Identifier of the number reference.
Value (string) --
A valid number.
Date (dict) --
Information about a reference when the referenceType is DATE . Otherwise, null.
Name (string) --
Identifier of the date reference.
Value (string) --
A valid date.
Email (dict) --
Information about a reference when the referenceType is EMAIL . Otherwise, null.
Name (string) --
Identifier of the email reference.
Value (string) --
A valid email address.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Warning
This is always returned as null in the response.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionlist_default_vocabularies(**kwargs)¶Lists the default vocabularies for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_default_vocabularies(
InstanceId='string',
LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'DefaultVocabularyList': [
{
'InstanceId': 'string',
'LanguageCode': 'ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
'VocabularyId': 'string',
'VocabularyName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DefaultVocabularyList (list) --
A list of default vocabularies.
(dict) --
Contains information about a default vocabulary.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
LanguageCode (string) --
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
VocabularyId (string) --
The identifier of the custom vocabulary.
VocabularyName (string) --
A unique name of the custom vocabulary.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionlist_hours_of_operations(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_hours_of_operations(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'HoursOfOperationSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
HoursOfOperationSummaryList (list) --
Information about the hours of operation.
(dict) --
Contains summary information about hours of operation for a contact center.
Id (string) --
The identifier of the hours of operation.
Arn (string) --
The Amazon Resource Name (ARN) of the hours of operation.
Name (string) --
The name of the hours of operation.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_instance_attributes(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_instance_attributes(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'Attributes': [
{
'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attributes (list) --
The attribute types.
(dict) --
A toggle for an individual feature at the instance level.
AttributeType (string) --
The type of attribute.
Value (string) --
The value of the attribute.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionlist_instance_storage_configs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_instance_storage_configs(
InstanceId='string',
ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A valid resource type.
dict
Response Syntax
{
'StorageConfigs': [
{
'AssociationId': 'string',
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'S3Config': {
'BucketName': 'string',
'BucketPrefix': 'string',
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisVideoStreamConfig': {
'Prefix': 'string',
'RetentionPeriodHours': 123,
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisStreamConfig': {
'StreamArn': 'string'
},
'KinesisFirehoseConfig': {
'FirehoseArn': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StorageConfigs (list) --
A valid storage type.
(dict) --
The storage configuration for the instance.
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
StorageType (string) --
A valid storage type.
S3Config (dict) --
The S3 bucket configuration.
BucketName (string) --
The S3 bucket name.
BucketPrefix (string) --
The S3 bucket prefix.
EncryptionConfig (dict) --
The Amazon S3 encryption configuration.
EncryptionType (string) --
The type of encryption.
KeyId (string) --
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
KinesisVideoStreamConfig (dict) --
The configuration of the Kinesis video stream.
Prefix (string) --
The prefix of the video stream.
RetentionPeriodHours (integer) --
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
EncryptionConfig (dict) --
The encryption configuration.
EncryptionType (string) --
The type of encryption.
KeyId (string) --
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
KinesisStreamConfig (dict) --
The configuration of the Kinesis data stream.
StreamArn (string) --
The Amazon Resource Name (ARN) of the data stream.
KinesisFirehoseConfig (dict) --
The configuration of the Kinesis Firehose delivery stream.
FirehoseArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionlist_instances(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_instances(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'InstanceSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
'InstanceAlias': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ServiceRole': 'string',
'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
'InboundCallsEnabled': True|False,
'OutboundCallsEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceSummaryList (list) --
Information about the instances.
(dict) --
Information about the instance.
Id (string) --
The identifier of the instance.
Arn (string) --
The Amazon Resource Name (ARN) of the instance.
IdentityManagementType (string) --
The identity management type of the instance.
InstanceAlias (string) --
The alias of the instance.
CreatedTime (datetime) --
When the instance was created.
ServiceRole (string) --
The service role of the instance.
InstanceStatus (string) --
The state of the instance.
InboundCallsEnabled (boolean) --
Whether inbound calls are enabled.
OutboundCallsEnabled (boolean) --
Whether outbound calls are enabled.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InternalServiceExceptionlist_integration_associations(**kwargs)¶Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_integration_associations(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'IntegrationAssociationSummaryList': [
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string',
'InstanceId': 'string',
'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
'IntegrationArn': 'string',
'SourceApplicationUrl': 'string',
'SourceApplicationName': 'string',
'SourceType': 'SALESFORCE'|'ZENDESK'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IntegrationAssociationSummaryList (list) --
The associations.
(dict) --
Contains summary information about the associated AppIntegrations.
IntegrationAssociationId (string) --
The identifier for the AppIntegration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration association.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
IntegrationType (string) --
The integration type.
IntegrationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration.
SourceApplicationUrl (string) --
The URL for the external application.
SourceApplicationName (string) --
The user-provided, friendly name for the external application.
SourceType (string) --
The name of the source.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptionlist_lambda_functions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_lambda_functions(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'LambdaFunctions': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
LambdaFunctions (list) --
The Lambdafunction ARNs associated with the specified instance.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionlist_lex_bots(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_lex_bots(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'LexBots': [
{
'Name': 'string',
'LexRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LexBots (list) --
The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
(dict) --
Configuration information of an Amazon Lex bot.
Name (string) --
The name of the Amazon Lex bot.
LexRegion (string) --
The Amazon Web Services Region where the Amazon Lex bot was created.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionlist_phone_numbers(**kwargs)¶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 .
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.list_phone_numbers(
InstanceId='string',
PhoneNumberTypes=[
'TOLL_FREE'|'DID',
],
PhoneNumberCountryCodes=[
'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The type of phone number.
The ISO country code.
dict
Response Syntax
{
'PhoneNumberSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'PhoneNumber': 'string',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PhoneNumberSummaryList (list) --
Information about the phone numbers.
(dict) --
Contains summary information about a phone number for a contact center.
Id (string) --
The identifier of the phone number.
Arn (string) --
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber (string) --
The phone number.
PhoneNumberType (string) --
The type of phone number.
PhoneNumberCountryCode (string) --
The ISO country code.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_phone_numbers_v2(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_phone_numbers_v2(
TargetArn='string',
MaxResults=123,
NextToken='string',
PhoneNumberCountryCodes=[
'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
],
PhoneNumberTypes=[
'TOLL_FREE'|'DID',
],
PhoneNumberPrefix='string'
)
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.The ISO country code.
The type of phone number.
+ as part of the country code.dict
Response Syntax
{
'NextToken': 'string',
'ListPhoneNumbersSummaryList': [
{
'PhoneNumberId': 'string',
'PhoneNumberArn': 'string',
'PhoneNumber': 'string',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'TargetArn': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ListPhoneNumbersSummaryList (list) --
Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.
(dict) --
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
PhoneNumberId (string) --
A unique identifier for the phone number.
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber (string) --
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
PhoneNumberCountryCode (string) --
The ISO country code.
PhoneNumberType (string) --
The type of phone number.
TargetArn (string) --
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.AccessDeniedExceptionlist_prompts(**kwargs)¶Provides information about the prompts for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_prompts(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'PromptSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PromptSummaryList (list) --
Information about the prompts.
(dict) --
Contains information about the prompt.
Id (string) --
The identifier of the prompt.
Arn (string) --
The Amazon Resource Name (ARN) of the prompt.
Name (string) --
The name of the prompt.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_queue_quick_connects(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
See also: AWS API Documentation
Request Syntax
response = client.list_queue_quick_connects(
InstanceId='string',
QueueId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
dict
Response Syntax
{
'NextToken': 'string',
'QuickConnectSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
QuickConnectSummaryList (list) --
Information about the quick connects.
(dict) --
Contains summary information about a quick connect.
Id (string) --
The identifier for the quick connect.
Arn (string) --
The Amazon Resource Name (ARN) of the quick connect.
Name (string) --
The name of the quick connect.
QuickConnectType (string) --
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).
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_queues(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_queues(
InstanceId='string',
QueueTypes=[
'STANDARD'|'AGENT',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The type of queue.
dict
Response Syntax
{
'QueueSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QueueType': 'STANDARD'|'AGENT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
QueueSummaryList (list) --
Information about the queues.
(dict) --
Contains summary information about a queue.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Name (string) --
The name of the queue.
QueueType (string) --
The type of queue.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_quick_connects(**kwargs)¶Provides information about the quick connects for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_quick_connects(
InstanceId='string',
NextToken='string',
MaxResults=123,
QuickConnectTypes=[
'USER'|'QUEUE'|'PHONE_NUMBER',
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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).
dict
Response Syntax
{
'QuickConnectSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
QuickConnectSummaryList (list) --
Information about the quick connects.
(dict) --
Contains summary information about a quick connect.
Id (string) --
The identifier for the quick connect.
Arn (string) --
The Amazon Resource Name (ARN) of the quick connect.
Name (string) --
The name of the quick connect.
QuickConnectType (string) --
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).
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_routing_profile_queues(**kwargs)¶Lists the queues associated with a routing profile.
See also: AWS API Documentation
Request Syntax
response = client.list_routing_profile_queues(
InstanceId='string',
RoutingProfileId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
dict
Response Syntax
{
'NextToken': 'string',
'RoutingProfileQueueConfigSummaryList': [
{
'QueueId': 'string',
'QueueArn': 'string',
'QueueName': 'string',
'Priority': 123,
'Delay': 123,
'Channel': 'VOICE'|'CHAT'|'TASK'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
RoutingProfileQueueConfigSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile queue.
QueueId (string) --
The identifier for the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) of the queue.
QueueName (string) --
The name of the queue.
Priority (integer) --
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay .
Delay (integer) --
The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .
Channel (string) --
The channels this queue supports.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_routing_profiles(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_routing_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'RoutingProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RoutingProfileSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile.
Id (string) --
The identifier of the routing profile.
Arn (string) --
The Amazon Resource Name (ARN) of the routing profile.
Name (string) --
The name of the routing profile.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_security_keys(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_security_keys(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'SecurityKeys': [
{
'AssociationId': 'string',
'Key': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityKeys (list) --
The security keys.
(dict) --
Configuration information of the security key.
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Key (string) --
The key of the security key.
CreationTime (datetime) --
When the security key was created.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionlist_security_profile_permissions(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Lists the permissions granted to a security profile.
See also: AWS API Documentation
Request Syntax
response = client.list_security_profile_permissions(
SecurityProfileId='string',
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier for the security profle.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'Permissions': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Permissions (list) --
The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions .
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_security_profiles(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_security_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'SecurityProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityProfileSummaryList (list) --
Information about the security profiles.
(dict) --
Contains information about a security profile.
Id (string) --
The identifier of the security profile.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
Name (string) --
The name of the security profile.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionLists 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 .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
Information about the tags.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionlist_task_templates(**kwargs)¶Lists task templates for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_task_templates(
InstanceId='string',
NextToken='string',
MaxResults=123,
Status='ACTIVE'|'INACTIVE',
Name='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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.
Warning
It is not expected that you set this because the value returned in the previous response is always null.
The maximum number of results to return per page.
Warning
It is not expected that you set this.
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.dict
Response Syntax
{
'TaskTemplates': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'INACTIVE',
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TaskTemplates (list) --
Provides details about a list of task templates belonging to an instance.
(dict) --
Contains summary information about the task template.
Id (string) --
A unique identifier for the task template.
Arn (string) --
The Amazon Resource Name (ARN) of the task template.
Name (string) --
The name of the task template.
Description (string) --
The description of the task template.
Status (string) --
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.
LastModifiedTime (datetime) --
The timestamp when the task template was last modified.
CreatedTime (datetime) --
The timestamp when the task template was created.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Warning
This is always returned as a null in the response.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_traffic_distribution_groups(**kwargs)¶Lists traffic distribution groups.
See also: AWS API Documentation
Request Syntax
response = client.list_traffic_distribution_groups(
MaxResults=123,
NextToken='string',
InstanceId='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'TrafficDistributionGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'InstanceArn': 'string',
'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
TrafficDistributionGroupSummaryList (list) --
A list of traffic distribution groups.
(dict) --
Information about traffic distribution groups.
Id (string) --
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.
Arn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Name (string) --
The name of the traffic distribution group.
InstanceArn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Status (string) --
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_use_cases(**kwargs)¶Lists the use cases for the integration association.
See also: AWS API Documentation
Request Syntax
response = client.list_use_cases(
InstanceId='string',
IntegrationAssociationId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the integration association.
dict
Response Syntax
{
'UseCaseSummaryList': [
{
'UseCaseId': 'string',
'UseCaseArn': 'string',
'UseCaseType': 'RULES_EVALUATION'|'CONNECT_CAMPAIGNS'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UseCaseSummaryList (list) --
The use cases.
(dict) --
Contains the use case.
UseCaseId (string) --
The identifier for the use case.
UseCaseArn (string) --
The Amazon Resource Name (ARN) for the use case.
UseCaseType (string) --
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ThrottlingExceptionlist_user_hierarchy_groups(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.list_user_hierarchy_groups(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'UserHierarchyGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserHierarchyGroupSummaryList (list) --
Information about the hierarchy groups.
(dict) --
Contains summary information about a hierarchy group.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionlist_users(**kwargs)¶Provides summary information about the users for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_users(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'UserSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Username': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserSummaryList (list) --
Information about the users.
(dict) --
Contains summary information about a user.
Id (string) --
The identifier of the user account.
Arn (string) --
The Amazon Resource Name (ARN) of the user account.
Username (string) --
The Amazon Connect user name of the user account.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionput_user_status(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.put_user_status(
UserId='string',
InstanceId='string',
AgentStatusId='string'
)
[REQUIRED]
The identifier of the user.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the agent status.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InternalServiceExceptionrelease_phone_number(**kwargs)¶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.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.release_phone_number(
PhoneNumberId='string',
ClientToken='string'
)
[REQUIRED]
A unique identifier for the phone number.
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 .
This field is autopopulated if not provided.
None
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceInUseExceptionConnect.Client.exceptions.IdempotencyExceptionConnect.Client.exceptions.AccessDeniedExceptionreplicate_instance(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.replicate_instance(
InstanceId='string',
ReplicaRegion='string',
ClientToken='string',
ReplicaAlias='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The Amazon Web Services Region where to replicate the Amazon Connect instance.
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 .
This field is autopopulated if not provided.
[REQUIRED]
The alias for the replicated instance. The ReplicaAlias must be unique.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.
Arn (string) --
The Amazon Resource Name (ARN) of the replicated instance.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceNotReadyExceptionConnect.Client.exceptions.ResourceConflictExceptionresume_contact_recording(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.resume_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionsearch_available_phone_numbers(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.search_available_phone_numbers(
TargetArn='string',
PhoneNumberCountryCode='AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
PhoneNumberType='TOLL_FREE'|'DID',
PhoneNumberPrefix='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
[REQUIRED]
The ISO country code.
[REQUIRED]
The type of phone number.
+ as part of the country code.dict
Response Syntax
{
'NextToken': 'string',
'AvailableNumbersList': [
{
'PhoneNumber': 'string',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'PhoneNumberType': 'TOLL_FREE'|'DID'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
AvailableNumbersList (list) --
A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
(dict) --
Information about available phone numbers.
PhoneNumber (string) --
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
PhoneNumberCountryCode (string) --
The ISO country code.
PhoneNumberType (string) --
The type of phone number.
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.AccessDeniedExceptionsearch_queues(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Searches queues in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
response = client.search_queues(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'QueueTypeCondition': 'STANDARD'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
The search criteria to be used to return queues.
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return queues.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return queues.
A leaf node condition which can be used to specify a string condition.
Note
The currently supported value for FieldName : name
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
The type of queue.
dict
Response Syntax
{
'Queues': [
{
'Name': 'string',
'QueueArn': 'string',
'QueueId': 'string',
'Description': 'string',
'OutboundCallerConfig': {
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
},
'HoursOfOperationId': 'string',
'MaxContacts': 123,
'Status': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Queues (list) --
Information about the queues.
(dict) --
Contains information about a queue.
Name (string) --
The name of the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) for the queue.
QueueId (string) --
The identifier for the queue.
Description (string) --
The description of the queue.
OutboundCallerConfig (dict) --
The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerIdName (string) --
The caller ID name.
OutboundCallerIdNumberId (string) --
The caller ID number.
OutboundFlowId (string) --
The outbound whisper flow to be used during an outbound call.
HoursOfOperationId (string) --
The identifier for the hours of operation.
MaxContacts (integer) --
The maximum number of contacts that can be in the queue before it is considered full.
Status (string) --
The status of the queue.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of queues which matched your search query.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionsearch_routing_profiles(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.search_routing_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
The search criteria to be used to return routing profiles.
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return routing profiles.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return routing profiles.
A leaf node condition which can be used to specify a string condition.
Note
The currently supported value for FieldName : name
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'RoutingProfiles': [
{
'InstanceId': 'string',
'Name': 'string',
'RoutingProfileArn': 'string',
'RoutingProfileId': 'string',
'Description': 'string',
'MediaConcurrencies': [
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123
},
],
'DefaultOutboundQueueId': 'string',
'Tags': {
'string': 'string'
},
'NumberOfAssociatedQueues': 123,
'NumberOfAssociatedUsers': 123
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
RoutingProfiles (list) --
Information about the routing profiles.
(dict) --
Contains information about a routing profile.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Name (string) --
The name of the routing profile.
RoutingProfileArn (string) --
The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileId (string) --
The identifier of the routing profile.
Description (string) --
The description of the routing profile.
MediaConcurrencies (list) --
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
(dict) --
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
Channel (string) --
The channels that agents can handle in the Contact Control Panel (CCP).
Concurrency (integer) --
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
DefaultOutboundQueueId (string) --
The identifier of the default outbound queue for this routing profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
NumberOfAssociatedQueues (integer) --
The number of associated queues in routing profile.
NumberOfAssociatedUsers (integer) --
The number of associated users in routing profile.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of routing profiles which matched your search query.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionsearch_security_profiles(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.search_security_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
},
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The search criteria to be used to return security profiles.
Note
The currently supported value for FieldName : name
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return security profiles.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return security profiles.
A leaf node condition which can be used to specify a string condition.
Note
The currently supported value for FieldName : name
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
dict
Response Syntax
{
'SecurityProfiles': [
{
'Id': 'string',
'OrganizationResourceId': 'string',
'Arn': 'string',
'SecurityProfileName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
SecurityProfiles (list) --
Information about the security profiles.
(dict) --
Information about the returned security profiles.
Id (string) --
The identifier of the security profile.
OrganizationResourceId (string) --
The organization resource identifier.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
SecurityProfileName (string) --
The name of the security profile.
Description (string) --
The description of the security profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of security profiles which matched your search query.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionsearch_users(**kwargs)¶Searches users in an Amazon Connect instance, with optional filtering.
Note
AfterContactWorkTimeLimit is returned in milliseconds.
See also: AWS API Documentation
Request Syntax
response = client.search_users(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'HierarchyGroupCondition': {
'Value': 'string',
'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS'
}
}
)
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
The search criteria to be used to return users.
Note
The Username , Firstname , and Lastname 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 result in empty results.
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return users.
Note
The Username , Firstname , and Lastname 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 result in empty results.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return users.
Note
The Username , Firstname , and Lastname 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 result in empty results.
A leaf node condition which can be used to specify a string condition.
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
A leaf node condition which can be used to specify a hierarchy group condition.
The value in the hierarchy group condition.
The type of hierarchy group match.
dict
Response Syntax
{
'Users': [
{
'Arn': 'string',
'DirectoryUserId': 'string',
'HierarchyGroupId': 'string',
'Id': 'string',
'IdentityInfo': {
'FirstName': 'string',
'LastName': 'string'
},
'PhoneConfig': {
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
'RoutingProfileId': 'string',
'SecurityProfileIds': [
'string',
],
'Tags': {
'string': 'string'
},
'Username': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Users (list) --
Information about the users.
(dict) --
Information about the returned users.
Arn (string) --
The Amazon Resource Name (ARN) of the user.
DirectoryUserId (string) --
The directory identifier of the user.
HierarchyGroupId (string) --
The identifier of the user's hierarchy group.
Id (string) --
The identifier of the user's summary.
IdentityInfo (dict) --
The user's first name and last name.
FirstName (string) --
The user's first name.
LastName (string) --
The user's last name.
PhoneConfig (dict) --
Contains information about the phone configuration settings for a user.
PhoneType (string) --
The phone type.
AutoAccept (boolean) --
The Auto accept setting.
AfterContactWorkTimeLimit (integer) --
The After Call Work (ACW) timeout setting, in seconds.
Note
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
DeskPhoneNumber (string) --
The phone number for the user's desk phone.
RoutingProfileId (string) --
The identifier of the user's routing profile.
SecurityProfileIds (list) --
The identifiers of the user's security profiles.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Username (string) --
The name of the user.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of users who matched your search query.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionsearch_vocabularies(**kwargs)¶Searches for vocabularies within a specific Amazon Connect instance using State , NameStartsWith , and LanguageCode .
See also: AWS API Documentation
Request Syntax
response = client.search_vocabularies(
InstanceId='string',
MaxResults=123,
NextToken='string',
State='CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
NameStartsWith='string',
LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{
'VocabularySummaryList': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'LanguageCode': 'ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VocabularySummaryList (list) --
The list of the available custom vocabularies.
(dict) --
Contains summary information about the custom vocabulary.
Name (string) --
A unique name of the custom vocabulary.
Id (string) --
The identifier of the custom vocabulary.
Arn (string) --
The Amazon Resource Name (ARN) of the custom vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
State (string) --
The current state of the custom vocabulary.
LastModifiedTime (datetime) --
The timestamp when the custom vocabulary was last modified.
FailureReason (string) --
The reason why the custom vocabulary was not created.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.AccessDeniedExceptionstart_chat_contact(**kwargs)¶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:
TooManyRequests exception.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 .
See also: AWS API Documentation
Request Syntax
response = client.start_chat_contact(
InstanceId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
ParticipantDetails={
'DisplayName': 'string'
},
InitialMessage={
'ContentType': 'string',
'Content': 'string'
},
ClientToken='string',
ChatDurationInMinutes=123,
SupportedMessagingContentTypes=[
'string',
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
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
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.
[REQUIRED]
Information identifying the participant.
Display name of the participant.
The initial message to be sent to the newly created chat.
The type of the content. Supported types are text/plain .
The content of the chat message.
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 .
This field is autopopulated if not provided.
The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.
dict
Response Syntax
{
'ContactId': 'string',
'ParticipantId': 'string',
'ParticipantToken': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
ParticipantId (string) --
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
ParticipantToken (string) --
The token used by the chat participant to call CreateParticipantConnection . The participant token is valid for the lifetime of a chat participant.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.LimitExceededExceptionstart_contact_recording(**kwargs)¶Starts recording the contact:
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.
See also: AWS API Documentation
Request Syntax
response = client.start_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string',
VoiceRecordingConfiguration={
'VoiceRecordingTrack': 'FROM_AGENT'|'TO_AGENT'|'ALL'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
[REQUIRED]
The person being recorded.
Identifies which track is being recorded.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionstart_contact_streaming(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.start_contact_streaming(
InstanceId='string',
ContactId='string',
ChatStreamingConfiguration={
'StreamingEndpointArn': 'string'
},
ClientToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
[REQUIRED]
The streaming configuration, such as the Amazon SNS streaming endpoint.
The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.
[REQUIRED]
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'StreamingId': 'string'
}
Response Structure
(dict) --
StreamingId (string) --
The identifier of the streaming configuration enabled.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.LimitExceededExceptionstart_outbound_voice_contact(**kwargs)¶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.
Note
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 .
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.start_outbound_voice_contact(
DestinationPhoneNumber='string',
ContactFlowId='string',
InstanceId='string',
ClientToken='string',
SourcePhoneNumber='string',
QueueId='string',
Attributes={
'string': 'string'
},
AnswerMachineDetectionConfig={
'EnableAnswerMachineDetection': True|False,
'AwaitAnswerMachinePrompt': True|False
},
CampaignId='string',
TrafficType='GENERAL'|'CAMPAIGN'
)
[REQUIRED]
The phone number of the customer, in E.164 format.
[REQUIRED]
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
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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.
This field is autopopulated if not provided.
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.
Configuration of the answering machine detection for this outbound call.
The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true , TrafficType must be set as CAMPAIGN .
Wait for the answering machine prompt.
GENERAL . Use CAMPAIGN if EnableAnswerMachineDetection is set to true . For all other cases, use GENERAL .dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.DestinationNotAllowedExceptionConnect.Client.exceptions.OutboundContactNotPermittedExceptionstart_task_contact(**kwargs)¶Initiates a flow to start a new task.
See also: AWS API Documentation
Request Syntax
response = client.start_task_contact(
InstanceId='string',
PreviousContactId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
Name='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
},
Description='string',
ClientToken='string',
ScheduledTime=datetime(2015, 1, 1),
TaskTemplateId='string',
QuickConnectId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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
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.
[REQUIRED]
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
The type of the reference. DATE must be of type Epoch timestamp.
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.InternalServiceExceptionstop_contact(**kwargs)¶Ends the specified contact. This call does not work for the following initiation methods:
See also: AWS API Documentation
Request Syntax
response = client.stop_contact(
ContactId='string',
InstanceId='string'
)
[REQUIRED]
The ID of the contact.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ContactNotFoundExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionstop_contact_recording(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.stop_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionstop_contact_streaming(**kwargs)¶Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
See also: AWS API Documentation
Request Syntax
response = client.stop_contact_streaming(
InstanceId='string',
ContactId='string',
StreamingId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.
[REQUIRED]
The identifier of the streaming configuration enabled.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionsuspend_contact_recording(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.suspend_contact_recording(
InstanceId='string',
ContactId='string',
InitialContactId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptiontag_resource(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptiontransfer_contact(**kwargs)¶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:
TASK contacts.QueueId and UserId in the same call.TransferContact API can be called only on active contacts.See also: AWS API Documentation
Request Syntax
response = client.transfer_contact(
InstanceId='string',
ContactId='string',
QueueId='string',
UserId='string',
ContactFlowId='string',
ClientToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact in this instance of Amazon Connect.
[REQUIRED]
The identifier of the flow.
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactId': 'string',
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
ContactArn (string) --
The Amazon Resource Name (ARN) of the contact.
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.IdempotencyExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionuntag_resource(**kwargs)¶Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionupdate_agent_status(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
See also: AWS API Documentation
Request Syntax
response = client.update_agent_status(
InstanceId='string',
AgentStatusId='string',
Name='string',
Description='string',
State='ENABLED'|'DISABLED',
DisplayOrder=123,
ResetOrderNumber=True|False
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the agent status.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact(**kwargs)¶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.
Warning
You can add or update user-defined contact information for both ongoing and completed contacts.
See also: AWS API Documentation
Request Syntax
response = client.update_contact(
InstanceId='string',
ContactId='string',
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
The type of the reference. DATE must be of type Epoch timestamp.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ThrottlingExceptionupdate_contact_attributes(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.update_contact_attributes(
InitialContactId='string',
InstanceId='string',
Attributes={
'string': 'string'
}
)
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact_flow_content(**kwargs)¶Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language .
See also: AWS API Documentation
Request Syntax
response = client.update_contact_flow_content(
InstanceId='string',
ContactFlowId='string',
Content='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the flow.
[REQUIRED]
The JSON string that represents flow's content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide .
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidContactFlowExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact_flow_metadata(**kwargs)¶Updates metadata about specified flow.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_flow_metadata(
InstanceId='string',
ContactFlowId='string',
Name='string',
Description='string',
ContactFlowState='ACTIVE'|'ARCHIVED'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact_flow_module_content(**kwargs)¶Updates specified flow module for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_flow_module_content(
InstanceId='string',
ContactFlowModuleId='string',
Content='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow module.
[REQUIRED]
The content of the flow module.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidContactFlowModuleExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact_flow_module_metadata(**kwargs)¶Updates metadata about specified flow module.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_flow_module_metadata(
InstanceId='string',
ContactFlowModuleId='string',
Name='string',
Description='string',
State='ACTIVE'|'ARCHIVED'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the flow module.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact_flow_name(**kwargs)¶The name of the flow.
You can also create and update flows using the Amazon Connect Flow language .
See also: AWS API Documentation
Request Syntax
response = client.update_contact_flow_name(
InstanceId='string',
ContactFlowId='string',
Name='string',
Description='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the flow.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_contact_schedule(**kwargs)¶Updates the scheduled time of a task contact that is already scheduled.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_schedule(
InstanceId='string',
ContactId='string',
ScheduledTime=datetime(2015, 1, 1)
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the contact.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.LimitExceededExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_hours_of_operation(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
See also: AWS API Documentation
Request Syntax
response = client.update_hours_of_operation(
InstanceId='string',
HoursOfOperationId='string',
Name='string',
Description='string',
TimeZone='string',
Config=[
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the hours of operation.
Configuration information of the hours of operation.
Contains information about the hours of operation.
The day that the hours of operation applies to.
The start time that your contact center opens.
The hours.
The minutes.
The end time that your contact center closes.
The hours.
The minutes.
None
Exceptions
Connect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_instance_attribute(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
See also: AWS API Documentation
Request Syntax
response = client.update_instance_attribute(
InstanceId='string',
AttributeType='INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND',
Value='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The type of attribute.
Note
Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
[REQUIRED]
The value for the attribute. Maximum character limit is 100.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionupdate_instance_storage_config(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_instance_storage_config(
InstanceId='string',
AssociationId='string',
ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS',
StorageConfig={
'AssociationId': 'string',
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'S3Config': {
'BucketName': 'string',
'BucketPrefix': 'string',
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisVideoStreamConfig': {
'Prefix': 'string',
'RetentionPeriodHours': 123,
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisStreamConfig': {
'StreamArn': 'string'
},
'KinesisFirehoseConfig': {
'FirehoseArn': 'string'
}
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
[REQUIRED]
A valid resource type.
[REQUIRED]
The storage configuration for the instance.
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
A valid storage type.
The S3 bucket configuration.
The S3 bucket name.
The S3 bucket prefix.
The Amazon S3 encryption configuration.
The type of encryption.
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
The configuration of the Kinesis video stream.
The prefix of the video stream.
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
The encryption configuration.
The type of encryption.
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
The configuration of the Kinesis data stream.
The Amazon Resource Name (ARN) of the data stream.
The configuration of the Kinesis Firehose delivery stream.
The Amazon Resource Name (ARN) of the delivery stream.
None
Exceptions
Connect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ThrottlingExceptionupdate_phone_number(**kwargs)¶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.
Warning
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
See also: AWS API Documentation
Request Syntax
response = client.update_phone_number(
PhoneNumberId='string',
TargetArn='string',
ClientToken='string'
)
[REQUIRED]
A unique identifier for the phone number.
[REQUIRED]
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
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 .
This field is autopopulated if not provided.
dict
Response Syntax
{
'PhoneNumberId': 'string',
'PhoneNumberArn': 'string'
}
Response Structure
(dict) --
PhoneNumberId (string) --
A unique identifier for the phone number.
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) of the phone number.
Exceptions
Connect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionConnect.Client.exceptions.ResourceInUseExceptionConnect.Client.exceptions.IdempotencyExceptionConnect.Client.exceptions.AccessDeniedExceptionupdate_queue_hours_of_operation(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
See also: AWS API Documentation
Request Syntax
response = client.update_queue_hours_of_operation(
InstanceId='string',
QueueId='string',
HoursOfOperationId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
[REQUIRED]
The identifier for the hours of operation.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_queue_max_contacts(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_queue_max_contacts(
InstanceId='string',
QueueId='string',
MaxContacts=123
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_queue_name(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_queue_name(
InstanceId='string',
QueueId='string',
Name='string',
Description='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
None
Exceptions
Connect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_queue_outbound_caller_config(**kwargs)¶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.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.update_queue_outbound_caller_config(
InstanceId='string',
QueueId='string',
OutboundCallerConfig={
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
[REQUIRED]
The outbound caller ID name, number, and outbound whisper flow.
The caller ID name.
The caller ID number.
The outbound whisper flow to be used during an outbound call.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_queue_status(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
See also: AWS API Documentation
Request Syntax
response = client.update_queue_status(
InstanceId='string',
QueueId='string',
Status='ENABLED'|'DISABLED'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
[REQUIRED]
The status of the queue.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_quick_connect_config(**kwargs)¶Updates the configuration settings for the specified quick connect.
See also: AWS API Documentation
Request Syntax
response = client.update_quick_connect_config(
InstanceId='string',
QuickConnectId='string',
QuickConnectConfig={
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
}
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the quick connect.
[REQUIRED]
Information about the configuration settings for the quick connect.
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).
The user configuration. This is required only if QuickConnectType is USER.
The identifier of the user.
The identifier of the flow.
The queue configuration. This is required only if QuickConnectType is QUEUE.
The identifier for the queue.
The identifier of the flow.
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
The phone number in E.164 format.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_quick_connect_name(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_quick_connect_name(
InstanceId='string',
QuickConnectId='string',
Name='string',
Description='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the quick connect.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_routing_profile_concurrency(**kwargs)¶Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
See also: AWS API Documentation
Request Syntax
response = client.update_routing_profile_concurrency(
InstanceId='string',
RoutingProfileId='string',
MediaConcurrencies=[
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123
},
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
[REQUIRED]
The channels that agents can handle in the Contact Control Panel (CCP).
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
The channels that agents can handle in the Contact Control Panel (CCP).
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_routing_profile_default_outbound_queue(**kwargs)¶Updates the default outbound queue of a routing profile.
See also: AWS API Documentation
Request Syntax
response = client.update_routing_profile_default_outbound_queue(
InstanceId='string',
RoutingProfileId='string',
DefaultOutboundQueueId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
[REQUIRED]
The identifier for the default outbound queue.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_routing_profile_name(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_routing_profile_name(
InstanceId='string',
RoutingProfileId='string',
Name='string',
Description='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
None
Exceptions
Connect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_routing_profile_queues(**kwargs)¶Updates the properties associated with a set of queues for a routing profile.
See also: AWS API Documentation
Request Syntax
response = client.update_routing_profile_queues(
InstanceId='string',
RoutingProfileId='string',
QueueConfigs=[
{
'QueueReference': {
'QueueId': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK'
},
'Priority': 123,
'Delay': 123
},
]
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
[REQUIRED]
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
Contains information about the queue and channel for which priority and delay can be set.
Contains information about a queue resource.
The identifier for the queue.
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay .
The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_security_profile(**kwargs)¶This API is in preview release for Amazon Connect and is subject to change.
Updates a security profile.
See also: AWS API Documentation
Request Syntax
response = client.update_security_profile(
Description='string',
Permissions=[
'string',
],
SecurityProfileId='string',
InstanceId='string'
)
The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions .
[REQUIRED]
The identifier for the security profle.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_task_template(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_task_template(
TaskTemplateId='string',
InstanceId='string',
Name='string',
Description='string',
ContactFlowId='string',
Constraints={
'RequiredFields': [
{
'Id': {
'Name': 'string'
}
},
],
'ReadOnlyFields': [
{
'Id': {
'Name': 'string'
}
},
],
'InvisibleFields': [
{
'Id': {
'Name': 'string'
}
},
]
},
Defaults={
'DefaultFieldValues': [
{
'Id': {
'Name': 'string'
},
'DefaultValue': 'string'
},
]
},
Status='ACTIVE'|'INACTIVE',
Fields=[
{
'Id': {
'Name': 'string'
},
'Description': 'string',
'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL',
'SingleSelectOptions': [
'string',
]
},
]
)
[REQUIRED]
A unique identifier for the task template.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Constraints that are applicable to the fields listed.
Lists the fields that are required to be filled by agents.
Information about a required field.
The unique identifier for the field.
The name of the task template field.
Lists the fields that are read-only to agents, and cannot be edited.
Indicates a field that is read-only to an agent.
Identifier of the read-only field.
The name of the task template field.
Lists the fields that are invisible to agents.
A field that is invisible to an agent.
Identifier of the invisible field.
The name of the task template field.
The default values for fields when a task is created by referencing this template.
Default value for the field.
Describes a default field and its corresponding value.
Identifier of a field.
The name of the task template field.
Default value for the field.
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.Fields that are part of the template.
Describes a single task template field.
The unique identifier for the field.
The name of the task template field.
The description of the field.
Indicates the type of field.
A list of options for a single select field.
dict
Response Syntax
{
'InstanceId': 'string',
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'Constraints': {
'RequiredFields': [
{
'Id': {
'Name': 'string'
}
},
],
'ReadOnlyFields': [
{
'Id': {
'Name': 'string'
}
},
],
'InvisibleFields': [
{
'Id': {
'Name': 'string'
}
},
]
},
'Defaults': {
'DefaultFieldValues': [
{
'Id': {
'Name': 'string'
},
'DefaultValue': 'string'
},
]
},
'Fields': [
{
'Id': {
'Name': 'string'
},
'Description': 'string',
'Type': 'NAME'|'DESCRIPTION'|'SCHEDULED_TIME'|'QUICK_CONNECT'|'URL'|'NUMBER'|'TEXT'|'TEXT_AREA'|'DATE_TIME'|'BOOLEAN'|'SINGLE_SELECT'|'EMAIL',
'SingleSelectOptions': [
'string',
]
},
],
'Status': 'ACTIVE'|'INACTIVE',
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Id (string) --
The identifier of the task template resource.
Arn (string) --
The Amazon Resource Name (ARN) for the task template resource.
Name (string) --
The name of the task template.
Description (string) --
The description of the task template.
ContactFlowId (string) --
The identifier of the flow that runs by default when a task is created by referencing this template.
Constraints (dict) --
Constraints that are applicable to the fields listed.
RequiredFields (list) --
Lists the fields that are required to be filled by agents.
(dict) --
Information about a required field.
Id (dict) --
The unique identifier for the field.
Name (string) --
The name of the task template field.
ReadOnlyFields (list) --
Lists the fields that are read-only to agents, and cannot be edited.
(dict) --
Indicates a field that is read-only to an agent.
Id (dict) --
Identifier of the read-only field.
Name (string) --
The name of the task template field.
InvisibleFields (list) --
Lists the fields that are invisible to agents.
(dict) --
A field that is invisible to an agent.
Id (dict) --
Identifier of the invisible field.
Name (string) --
The name of the task template field.
Defaults (dict) --
The default values for fields when a task is created by referencing this template.
DefaultFieldValues (list) --
Default value for the field.
(dict) --
Describes a default field and its corresponding value.
Id (dict) --
Identifier of a field.
Name (string) --
The name of the task template field.
DefaultValue (string) --
Default value for the field.
Fields (list) --
Fields that are part of the template.
(dict) --
Describes a single task template field.
Id (dict) --
The unique identifier for the field.
Name (string) --
The name of the task template field.
Description (string) --
The description of the field.
Type (string) --
Indicates the type of field.
SingleSelectOptions (list) --
A list of options for a single select field.
Status (string) --
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.
LastModifiedTime (datetime) --
The timestamp when the task template was last modified.
CreatedTime (datetime) --
The timestamp when the task template was created.
Exceptions
Connect.Client.exceptions.PropertyValidationExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.ServiceQuotaExceededExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_traffic_distribution(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.update_traffic_distribution(
Id='string',
TelephonyConfig={
'Distributions': [
{
'Region': 'string',
'Percentage': 123
},
]
}
)
[REQUIRED]
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.
The distribution of traffic between the instance and its replica(s).
Information about traffic distributions.
Information about a traffic distribution.
The Amazon Web Services Region where the traffic is distributed.
The percentage of the traffic that is distributed, in increments of 10.
dict
Response Syntax
{}
Response Structure
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.AccessDeniedExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceConflictExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_hierarchy(**kwargs)¶Assigns the specified hierarchy group to the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_hierarchy(
HierarchyGroupId='string',
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_hierarchy_group_name(**kwargs)¶Updates the name of the user hierarchy group.
See also: AWS API Documentation
Request Syntax
response = client.update_user_hierarchy_group_name(
Name='string',
HierarchyGroupId='string',
InstanceId='string'
)
[REQUIRED]
The name of the hierarchy group. Must not be more than 100 characters.
[REQUIRED]
The identifier of the hierarchy group.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.DuplicateResourceExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_hierarchy_structure(**kwargs)¶Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
See also: AWS API Documentation
Request Syntax
response = client.update_user_hierarchy_structure(
HierarchyStructure={
'LevelOne': {
'Name': 'string'
},
'LevelTwo': {
'Name': 'string'
},
'LevelThree': {
'Name': 'string'
},
'LevelFour': {
'Name': 'string'
},
'LevelFive': {
'Name': 'string'
}
},
InstanceId='string'
)
[REQUIRED]
The hierarchy levels to update.
The update for level one.
The name of the user hierarchy level. Must not be more than 50 characters.
The update for level two.
The name of the user hierarchy level. Must not be more than 50 characters.
The update for level three.
The name of the user hierarchy level. Must not be more than 50 characters.
The update for level four.
The name of the user hierarchy level. Must not be more than 50 characters.
The update for level five.
The name of the user hierarchy level. Must not be more than 50 characters.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ResourceInUseExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_identity_info(**kwargs)¶Updates the identity information for the specified user.
Warning
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 .
See also: AWS API Documentation
Request Syntax
response = client.update_user_identity_info(
IdentityInfo={
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'SecondaryEmail': 'string',
'Mobile': 'string'
},
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identity information for the user.
The first name. This is required if you are using Amazon Connect or SAML for identity management.
The last name. This is required if you are using Amazon Connect or SAML for identity management.
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
The user's mobile number.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_phone_config(**kwargs)¶Updates the phone configuration settings for the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_phone_config(
PhoneConfig={
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
UserId='string',
InstanceId='string'
)
[REQUIRED]
Information about phone configuration settings for the user.
The phone type.
The Auto accept setting.
The After Call Work (ACW) timeout setting, in seconds.
Note
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
The phone number for the user's desk phone.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_routing_profile(**kwargs)¶Assigns the specified routing profile to the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_routing_profile(
RoutingProfileId='string',
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the routing profile for the user.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionupdate_user_security_profiles(**kwargs)¶Assigns the specified security profiles to the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_security_profiles(
SecurityProfileIds=[
'string',
],
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifiers of the security profiles for the user.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
None
Exceptions
Connect.Client.exceptions.InvalidRequestExceptionConnect.Client.exceptions.InvalidParameterExceptionConnect.Client.exceptions.ResourceNotFoundExceptionConnect.Client.exceptions.ThrottlingExceptionConnect.Client.exceptions.InternalServiceExceptionThe available paginators are:
Connect.Paginator.GetMetricDataConnect.Paginator.ListAgentStatusesConnect.Paginator.ListApprovedOriginsConnect.Paginator.ListBotsConnect.Paginator.ListContactFlowModulesConnect.Paginator.ListContactFlowsConnect.Paginator.ListContactReferencesConnect.Paginator.ListDefaultVocabulariesConnect.Paginator.ListHoursOfOperationsConnect.Paginator.ListInstanceAttributesConnect.Paginator.ListInstanceStorageConfigsConnect.Paginator.ListInstancesConnect.Paginator.ListIntegrationAssociationsConnect.Paginator.ListLambdaFunctionsConnect.Paginator.ListLexBotsConnect.Paginator.ListPhoneNumbersConnect.Paginator.ListPhoneNumbersV2Connect.Paginator.ListPromptsConnect.Paginator.ListQueueQuickConnectsConnect.Paginator.ListQueuesConnect.Paginator.ListQuickConnectsConnect.Paginator.ListRoutingProfileQueuesConnect.Paginator.ListRoutingProfilesConnect.Paginator.ListSecurityKeysConnect.Paginator.ListSecurityProfilePermissionsConnect.Paginator.ListSecurityProfilesConnect.Paginator.ListTaskTemplatesConnect.Paginator.ListTrafficDistributionGroupsConnect.Paginator.ListUseCasesConnect.Paginator.ListUserHierarchyGroupsConnect.Paginator.ListUsersConnect.Paginator.SearchAvailablePhoneNumbersConnect.Paginator.SearchQueuesConnect.Paginator.SearchRoutingProfilesConnect.Paginator.SearchSecurityProfilesConnect.Paginator.SearchUsersConnect.Paginator.SearchVocabulariesConnect.Paginator.GetMetricData¶paginator = client.get_paginator('get_metric_data')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.get_metric_data().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Filters={
'Queues': [
'string',
],
'Channels': [
'VOICE'|'CHAT'|'TASK',
]
},
Groupings=[
'QUEUE'|'CHANNEL',
],
HistoricalMetrics=[
{
'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
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.
[REQUIRED]
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.
[REQUIRED]
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.
Note
To filter by Queues , enter the queue ID/ARN, not the name of the queue.
The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
The channel to use to filter the metrics.
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.
[REQUIRED]
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 .
Note
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
ABANDON_TIME
Unit: SECONDS
Statistic: AVG
AFTER_CONTACT_WORK_TIME
Unit: SECONDS
Statistic: AVG
API_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CALLBACK_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_ABANDONED
Unit: COUNT
Statistic: SUM
CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNT
Statistic: SUM
CONTACTS_CONSULTED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_INCOMING
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_OUTBOUND
Unit: COUNT
Statistic: SUM
CONTACTS_HOLD_ABANDONS
Unit: COUNT
Statistic: SUM
CONTACTS_MISSED
Unit: COUNT
Statistic: SUM
CONTACTS_QUEUED
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNT
Statistic: SUM
HANDLE_TIME
Unit: SECONDS
Statistic: AVG
HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_AND_HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_TIME
Unit: SECONDS
Statistic: AVG
OCCUPANCY
Unit: PERCENT
Statistic: AVG
QUEUE_ANSWER_TIME
Unit: SECONDS
Statistic: AVG
QUEUED_TIME
Unit: SECONDS
Statistic: MAX
SERVICE_LEVEL
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").
Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .
The name of the metric.
The threshold for the metric, used with service level metrics.
The type of comparison. Only "less than" (LT) comparisons are supported.
The threshold value to compare.
The statistic for the metric.
The unit for the metric.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'MetricResults': [
{
'Dimensions': {
'Queue': {
'Id': 'string',
'Arn': 'string'
},
'Channel': 'VOICE'|'CHAT'|'TASK'
},
'Collections': [
{
'Metric': {
'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
'Value': 123.0
},
]
},
]
}
Response Structure
(dict) --
MetricResults (list) --
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
(dict) --
Contains information about the historical metrics retrieved.
Dimensions (dict) --
The dimension for the metrics.
Queue (dict) --
Information about the queue for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Channel (string) --
The channel used for grouping and filters.
Collections (list) --
The set of metrics.
(dict) --
Contains the data for a historical metric.
Metric (dict) --
Information about the metric.
Name (string) --
The name of the metric.
Threshold (dict) --
The threshold for the metric, used with service level metrics.
Comparison (string) --
The type of comparison. Only "less than" (LT) comparisons are supported.
ThresholdValue (float) --
The threshold value to compare.
Statistic (string) --
The statistic for the metric.
Unit (string) --
The unit for the metric.
Value (float) --
The value of the metric.
Connect.Paginator.ListAgentStatuses¶paginator = client.get_paginator('list_agent_statuses')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_agent_statuses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
AgentStatusTypes=[
'ROUTABLE'|'CUSTOM'|'OFFLINE',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Available agent status types.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AgentStatusSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE'
},
]
}
Response Structure
(dict) --
AgentStatusSummaryList (list) --
A summary of agent statuses.
(dict) --
Summary information for an agent status.
Id (string) --
The identifier for an agent status.
Arn (string) --
The Amazon Resource Name (ARN) for the agent status.
Name (string) --
The name of the agent status.
Type (string) --
The type of the agent status.
Connect.Paginator.ListApprovedOrigins¶paginator = client.get_paginator('list_approved_origins')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_approved_origins().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Origins': [
'string',
],
}
Response Structure
(dict) --
Origins (list) --
The approved origins.
Connect.Paginator.ListBots¶paginator = client.get_paginator('list_bots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_bots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
LexVersion='V1'|'V2',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The version of Amazon Lex or Amazon Lex V2.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LexBots': [
{
'LexBot': {
'Name': 'string',
'LexRegion': 'string'
},
'LexV2Bot': {
'AliasArn': 'string'
}
},
],
}
Response Structure
(dict) --
LexBots (list) --
The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.
(dict) --
Configuration information of an Amazon Lex or Amazon Lex V2 bot.
LexBot (dict) --
Configuration information of an Amazon Lex bot.
Name (string) --
The name of the Amazon Lex bot.
LexRegion (string) --
The Amazon Web Services Region where the Amazon Lex bot was created.
LexV2Bot (dict) --
Configuration information of an Amazon Lex V2 bot.
AliasArn (string) --
The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
Connect.Paginator.ListContactFlowModules¶paginator = client.get_paginator('list_contact_flow_modules')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_contact_flow_modules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
ContactFlowModuleState='ACTIVE'|'ARCHIVED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ContactFlowModulesSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'State': 'ACTIVE'|'ARCHIVED'
},
],
}
Response Structure
(dict) --
ContactFlowModulesSummaryList (list) --
Information about the flow module.
(dict) --
Contains summary information about a flow.
Id (string) --
The identifier of the flow module.
Arn (string) --
The Amazon Resource Name (ARN) of the flow module.
Name (string) --
The name of the flow module.
State (string) --
The type of flow module.
Connect.Paginator.ListContactFlows¶paginator = client.get_paginator('list_contact_flows')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_contact_flows().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
ContactFlowTypes=[
'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The type of flow.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ContactFlowSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
'ContactFlowState': 'ACTIVE'|'ARCHIVED'
},
],
}
Response Structure
(dict) --
ContactFlowSummaryList (list) --
Information about the flows.
(dict) --
Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language .
Id (string) --
The identifier of the flow.
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
Name (string) --
The name of the flow.
ContactFlowType (string) --
The type of flow.
ContactFlowState (string) --
The type of flow.
Connect.Paginator.ListContactReferences¶paginator = client.get_paginator('list_contact_references')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_contact_references().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
ContactId='string',
ReferenceTypes=[
'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the initial contact.
[REQUIRED]
The type of reference.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReferenceSummaryList': [
{
'Url': {
'Name': 'string',
'Value': 'string'
},
'Attachment': {
'Name': 'string',
'Value': 'string',
'Status': 'APPROVED'|'REJECTED'
},
'String': {
'Name': 'string',
'Value': 'string'
},
'Number': {
'Name': 'string',
'Value': 'string'
},
'Date': {
'Name': 'string',
'Value': 'string'
},
'Email': {
'Name': 'string',
'Value': 'string'
}
},
],
}
Response Structure
(dict) --
ReferenceSummaryList (list) --
Information about the flows.
(dict) --
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: Url, Attachment, String, Number, Date, Email. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
Url (dict) --
Information about the reference when the referenceType is URL . Otherwise, null.
Name (string) --
Identifier of the URL reference.
Value (string) --
A valid URL.
Attachment (dict) --
Information about the reference when the referenceType is ATTACHMENT . Otherwise, null.
Name (string) --
Identifier of the attachment reference.
Value (string) --
The location path of the attachment reference.
Status (string) --
Status of the attachment reference type.
String (dict) --
Information about a reference when the referenceType is STRING . Otherwise, null.
Name (string) --
Identifier of the string reference.
Value (string) --
A valid string.
Number (dict) --
Information about a reference when the referenceType is NUMBER . Otherwise, null.
Name (string) --
Identifier of the number reference.
Value (string) --
A valid number.
Date (dict) --
Information about a reference when the referenceType is DATE . Otherwise, null.
Name (string) --
Identifier of the date reference.
Value (string) --
A valid date.
Email (dict) --
Information about a reference when the referenceType is EMAIL . Otherwise, null.
Name (string) --
Identifier of the email reference.
Value (string) --
A valid email address.
Connect.Paginator.ListDefaultVocabularies¶paginator = client.get_paginator('list_default_vocabularies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_default_vocabularies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DefaultVocabularyList': [
{
'InstanceId': 'string',
'LanguageCode': 'ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
'VocabularyId': 'string',
'VocabularyName': 'string'
},
],
}
Response Structure
(dict) --
DefaultVocabularyList (list) --
A list of default vocabularies.
(dict) --
Contains information about a default vocabulary.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
LanguageCode (string) --
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
VocabularyId (string) --
The identifier of the custom vocabulary.
VocabularyName (string) --
A unique name of the custom vocabulary.
Connect.Paginator.ListHoursOfOperations¶paginator = client.get_paginator('list_hours_of_operations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_hours_of_operations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'HoursOfOperationSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
HoursOfOperationSummaryList (list) --
Information about the hours of operation.
(dict) --
Contains summary information about hours of operation for a contact center.
Id (string) --
The identifier of the hours of operation.
Arn (string) --
The Amazon Resource Name (ARN) of the hours of operation.
Name (string) --
The name of the hours of operation.
Connect.Paginator.ListInstanceAttributes¶paginator = client.get_paginator('list_instance_attributes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_instance_attributes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Attributes': [
{
'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Attributes (list) --
The attribute types.
(dict) --
A toggle for an individual feature at the instance level.
AttributeType (string) --
The type of attribute.
Value (string) --
The value of the attribute.
Connect.Paginator.ListInstanceStorageConfigs¶paginator = client.get_paginator('list_instance_storage_configs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_instance_storage_configs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
ResourceType='CHAT_TRANSCRIPTS'|'CALL_RECORDINGS'|'SCHEDULED_REPORTS'|'MEDIA_STREAMS'|'CONTACT_TRACE_RECORDS'|'AGENT_EVENTS'|'REAL_TIME_CONTACT_ANALYSIS_SEGMENTS',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
A valid resource type.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'StorageConfigs': [
{
'AssociationId': 'string',
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'S3Config': {
'BucketName': 'string',
'BucketPrefix': 'string',
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisVideoStreamConfig': {
'Prefix': 'string',
'RetentionPeriodHours': 123,
'EncryptionConfig': {
'EncryptionType': 'KMS',
'KeyId': 'string'
}
},
'KinesisStreamConfig': {
'StreamArn': 'string'
},
'KinesisFirehoseConfig': {
'FirehoseArn': 'string'
}
},
],
}
Response Structure
(dict) --
StorageConfigs (list) --
A valid storage type.
(dict) --
The storage configuration for the instance.
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
StorageType (string) --
A valid storage type.
S3Config (dict) --
The S3 bucket configuration.
BucketName (string) --
The S3 bucket name.
BucketPrefix (string) --
The S3 bucket prefix.
EncryptionConfig (dict) --
The Amazon S3 encryption configuration.
EncryptionType (string) --
The type of encryption.
KeyId (string) --
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
KinesisVideoStreamConfig (dict) --
The configuration of the Kinesis video stream.
Prefix (string) --
The prefix of the video stream.
RetentionPeriodHours (integer) --
The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
EncryptionConfig (dict) --
The encryption configuration.
EncryptionType (string) --
The type of encryption.
KeyId (string) --
The full ARN of the encryption key.
Note
Be sure to provide the full ARN of the encryption key, not just the ID.
KinesisStreamConfig (dict) --
The configuration of the Kinesis data stream.
StreamArn (string) --
The Amazon Resource Name (ARN) of the data stream.
KinesisFirehoseConfig (dict) --
The configuration of the Kinesis Firehose delivery stream.
FirehoseArn (string) --
The Amazon Resource Name (ARN) of the delivery stream.
Connect.Paginator.ListInstances¶paginator = client.get_paginator('list_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'InstanceSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'IdentityManagementType': 'SAML'|'CONNECT_MANAGED'|'EXISTING_DIRECTORY',
'InstanceAlias': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ServiceRole': 'string',
'InstanceStatus': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED',
'InboundCallsEnabled': True|False,
'OutboundCallsEnabled': True|False
},
],
}
Response Structure
Information about the instances.
Information about the instance.
The identifier of the instance.
The Amazon Resource Name (ARN) of the instance.
The identity management type of the instance.
The alias of the instance.
When the instance was created.
The service role of the instance.
The state of the instance.
Whether inbound calls are enabled.
Whether outbound calls are enabled.
Connect.Paginator.ListIntegrationAssociations¶paginator = client.get_paginator('list_integration_associations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_integration_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'IntegrationAssociationSummaryList': [
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string',
'InstanceId': 'string',
'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
'IntegrationArn': 'string',
'SourceApplicationUrl': 'string',
'SourceApplicationName': 'string',
'SourceType': 'SALESFORCE'|'ZENDESK'
},
],
}
Response Structure
(dict) --
IntegrationAssociationSummaryList (list) --
The associations.
(dict) --
Contains summary information about the associated AppIntegrations.
IntegrationAssociationId (string) --
The identifier for the AppIntegration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration association.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
IntegrationType (string) --
The integration type.
IntegrationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration.
SourceApplicationUrl (string) --
The URL for the external application.
SourceApplicationName (string) --
The user-provided, friendly name for the external application.
SourceType (string) --
The name of the source.
Connect.Paginator.ListLambdaFunctions¶paginator = client.get_paginator('list_lambda_functions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_lambda_functions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LambdaFunctions': [
'string',
],
}
Response Structure
(dict) --
LambdaFunctions (list) --
The Lambdafunction ARNs associated with the specified instance.
Connect.Paginator.ListLexBots¶paginator = client.get_paginator('list_lex_bots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_lex_bots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LexBots': [
{
'Name': 'string',
'LexRegion': 'string'
},
],
}
Response Structure
(dict) --
LexBots (list) --
The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.
(dict) --
Configuration information of an Amazon Lex bot.
Name (string) --
The name of the Amazon Lex bot.
LexRegion (string) --
The Amazon Web Services Region where the Amazon Lex bot was created.
Connect.Paginator.ListPhoneNumbers¶paginator = client.get_paginator('list_phone_numbers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_phone_numbers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PhoneNumberTypes=[
'TOLL_FREE'|'DID',
],
PhoneNumberCountryCodes=[
'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The type of phone number.
The ISO country code.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PhoneNumberSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'PhoneNumber': 'string',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
],
}
Response Structure
(dict) --
PhoneNumberSummaryList (list) --
Information about the phone numbers.
(dict) --
Contains summary information about a phone number for a contact center.
Id (string) --
The identifier of the phone number.
Arn (string) --
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber (string) --
The phone number.
PhoneNumberType (string) --
The type of phone number.
PhoneNumberCountryCode (string) --
The ISO country code.
Connect.Paginator.ListPhoneNumbersV2¶paginator = client.get_paginator('list_phone_numbers_v2')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_phone_numbers_v2().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TargetArn='string',
PhoneNumberCountryCodes=[
'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
],
PhoneNumberTypes=[
'TOLL_FREE'|'DID',
],
PhoneNumberPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.The ISO country code.
The type of phone number.
+ as part of the country code.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ListPhoneNumbersSummaryList': [
{
'PhoneNumberId': 'string',
'PhoneNumberArn': 'string',
'PhoneNumber': 'string',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'TargetArn': 'string'
},
]
}
Response Structure
(dict) --
ListPhoneNumbersSummaryList (list) --
Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.
(dict) --
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
PhoneNumberId (string) --
A unique identifier for the phone number.
PhoneNumberArn (string) --
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber (string) --
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
PhoneNumberCountryCode (string) --
The ISO country code.
PhoneNumberType (string) --
The type of phone number.
TargetArn (string) --
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
Connect.Paginator.ListPrompts¶paginator = client.get_paginator('list_prompts')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_prompts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PromptSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
PromptSummaryList (list) --
Information about the prompts.
(dict) --
Contains information about the prompt.
Id (string) --
The identifier of the prompt.
Arn (string) --
The Amazon Resource Name (ARN) of the prompt.
Name (string) --
The name of the prompt.
Connect.Paginator.ListQueueQuickConnects¶paginator = client.get_paginator('list_queue_quick_connects')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_queue_quick_connects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
QueueId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the queue.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'QuickConnectSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'
},
]
}
Response Structure
(dict) --
QuickConnectSummaryList (list) --
Information about the quick connects.
(dict) --
Contains summary information about a quick connect.
Id (string) --
The identifier for the quick connect.
Arn (string) --
The Amazon Resource Name (ARN) of the quick connect.
Name (string) --
The name of the quick connect.
QuickConnectType (string) --
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).
Connect.Paginator.ListQueues¶paginator = client.get_paginator('list_queues')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
QueueTypes=[
'STANDARD'|'AGENT',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The type of queue.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'QueueSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QueueType': 'STANDARD'|'AGENT'
},
],
}
Response Structure
(dict) --
QueueSummaryList (list) --
Information about the queues.
(dict) --
Contains summary information about a queue.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Name (string) --
The name of the queue.
QueueType (string) --
The type of queue.
Connect.Paginator.ListQuickConnects¶paginator = client.get_paginator('list_quick_connects')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_quick_connects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
QuickConnectTypes=[
'USER'|'QUEUE'|'PHONE_NUMBER',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'QuickConnectSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'
},
],
}
Response Structure
(dict) --
QuickConnectSummaryList (list) --
Information about the quick connects.
(dict) --
Contains summary information about a quick connect.
Id (string) --
The identifier for the quick connect.
Arn (string) --
The Amazon Resource Name (ARN) of the quick connect.
Name (string) --
The name of the quick connect.
QuickConnectType (string) --
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).
Connect.Paginator.ListRoutingProfileQueues¶paginator = client.get_paginator('list_routing_profile_queues')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_routing_profile_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
RoutingProfileId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier of the routing profile.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RoutingProfileQueueConfigSummaryList': [
{
'QueueId': 'string',
'QueueArn': 'string',
'QueueName': 'string',
'Priority': 123,
'Delay': 123,
'Channel': 'VOICE'|'CHAT'|'TASK'
},
]
}
Response Structure
(dict) --
RoutingProfileQueueConfigSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile queue.
QueueId (string) --
The identifier for the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) of the queue.
QueueName (string) --
The name of the queue.
Priority (integer) --
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay .
Delay (integer) --
The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .
Channel (string) --
The channels this queue supports.
Connect.Paginator.ListRoutingProfiles¶paginator = client.get_paginator('list_routing_profiles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_routing_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RoutingProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
RoutingProfileSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile.
Id (string) --
The identifier of the routing profile.
Arn (string) --
The Amazon Resource Name (ARN) of the routing profile.
Name (string) --
The name of the routing profile.
Connect.Paginator.ListSecurityKeys¶paginator = client.get_paginator('list_security_keys')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_security_keys().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecurityKeys': [
{
'AssociationId': 'string',
'Key': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
SecurityKeys (list) --
The security keys.
(dict) --
Configuration information of the security key.
AssociationId (string) --
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Key (string) --
The key of the security key.
CreationTime (datetime) --
When the security key was created.
Connect.Paginator.ListSecurityProfilePermissions¶paginator = client.get_paginator('list_security_profile_permissions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_security_profile_permissions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SecurityProfileId='string',
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier for the security profle.
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Permissions': [
'string',
],
}
Response Structure
(dict) --
Permissions (list) --
The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions .
Connect.Paginator.ListSecurityProfiles¶paginator = client.get_paginator('list_security_profiles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_security_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecurityProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
SecurityProfileSummaryList (list) --
Information about the security profiles.
(dict) --
Contains information about a security profile.
Id (string) --
The identifier of the security profile.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
Name (string) --
The name of the security profile.
Connect.Paginator.ListTaskTemplates¶paginator = client.get_paginator('list_task_templates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_task_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
Status='ACTIVE'|'INACTIVE',
Name='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TaskTemplates': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'INACTIVE',
'LastModifiedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
TaskTemplates (list) --
Provides details about a list of task templates belonging to an instance.
(dict) --
Contains summary information about the task template.
Id (string) --
A unique identifier for the task template.
Arn (string) --
The Amazon Resource Name (ARN) of the task template.
Name (string) --
The name of the task template.
Description (string) --
The description of the task template.
Status (string) --
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.
LastModifiedTime (datetime) --
The timestamp when the task template was last modified.
CreatedTime (datetime) --
The timestamp when the task template was created.
Connect.Paginator.ListTrafficDistributionGroups¶paginator = client.get_paginator('list_traffic_distribution_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_traffic_distribution_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TrafficDistributionGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'InstanceArn': 'string',
'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS'
},
]
}
Response Structure
(dict) --
TrafficDistributionGroupSummaryList (list) --
A list of traffic distribution groups.
(dict) --
Information about traffic distribution groups.
Id (string) --
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.
Arn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Name (string) --
The name of the traffic distribution group.
InstanceArn (string) --
The Amazon Resource Name (ARN) of the traffic distribution group.
Status (string) --
The status of the traffic distribution group.
CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.Connect.Paginator.ListUseCases¶paginator = client.get_paginator('list_use_cases')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_use_cases().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
IntegrationAssociationId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
[REQUIRED]
The identifier for the integration association.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UseCaseSummaryList': [
{
'UseCaseId': 'string',
'UseCaseArn': 'string',
'UseCaseType': 'RULES_EVALUATION'|'CONNECT_CAMPAIGNS'
},
],
}
Response Structure
(dict) --
UseCaseSummaryList (list) --
The use cases.
(dict) --
Contains the use case.
UseCaseId (string) --
The identifier for the use case.
UseCaseArn (string) --
The Amazon Resource Name (ARN) for the use case.
UseCaseType (string) --
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
Connect.Paginator.ListUserHierarchyGroups¶paginator = client.get_paginator('list_user_hierarchy_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_user_hierarchy_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UserHierarchyGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
UserHierarchyGroupSummaryList (list) --
Information about the hierarchy groups.
(dict) --
Contains summary information about a hierarchy group.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
Connect.Paginator.ListUsers¶paginator = client.get_paginator('list_users')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.list_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UserSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Username': 'string'
},
],
}
Response Structure
(dict) --
UserSummaryList (list) --
Information about the users.
(dict) --
Contains summary information about a user.
Id (string) --
The identifier of the user account.
Arn (string) --
The Amazon Resource Name (ARN) of the user account.
Username (string) --
The Amazon Connect user name of the user account.
Connect.Paginator.SearchAvailablePhoneNumbers¶paginator = client.get_paginator('search_available_phone_numbers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.search_available_phone_numbers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TargetArn='string',
PhoneNumberCountryCode='AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
PhoneNumberType='TOLL_FREE'|'DID',
PhoneNumberPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
[REQUIRED]
The ISO country code.
[REQUIRED]
The type of phone number.
+ as part of the country code.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AvailableNumbersList': [
{
'PhoneNumber': 'string',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
'PhoneNumberType': 'TOLL_FREE'|'DID'
},
]
}
Response Structure
(dict) --
AvailableNumbersList (list) --
A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
(dict) --
Information about available phone numbers.
PhoneNumber (string) --
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code] .
PhoneNumberCountryCode (string) --
The ISO country code.
PhoneNumberType (string) --
The type of phone number.
Connect.Paginator.SearchQueues¶paginator = client.get_paginator('search_queues')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.search_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'QueueTypeCondition': 'STANDARD'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
The search criteria to be used to return queues.
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return queues.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return queues.
A leaf node condition which can be used to specify a string condition.
Note
The currently supported value for FieldName : name
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
The type of queue.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Queues': [
{
'Name': 'string',
'QueueArn': 'string',
'QueueId': 'string',
'Description': 'string',
'OutboundCallerConfig': {
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
},
'HoursOfOperationId': 'string',
'MaxContacts': 123,
'Status': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
}
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Queues (list) --
Information about the queues.
(dict) --
Contains information about a queue.
Name (string) --
The name of the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) for the queue.
QueueId (string) --
The identifier for the queue.
Description (string) --
The description of the queue.
OutboundCallerConfig (dict) --
The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerIdName (string) --
The caller ID name.
OutboundCallerIdNumberId (string) --
The caller ID number.
OutboundFlowId (string) --
The outbound whisper flow to be used during an outbound call.
HoursOfOperationId (string) --
The identifier for the hours of operation.
MaxContacts (integer) --
The maximum number of contacts that can be in the queue before it is considered full.
Status (string) --
The status of the queue.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
ApproximateTotalCount (integer) --
The total number of queues which matched your search query.
Connect.Paginator.SearchRoutingProfiles¶paginator = client.get_paginator('search_routing_profiles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.search_routing_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
The search criteria to be used to return routing profiles.
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return routing profiles.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return routing profiles.
A leaf node condition which can be used to specify a string condition.
Note
The currently supported value for FieldName : name
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RoutingProfiles': [
{
'InstanceId': 'string',
'Name': 'string',
'RoutingProfileArn': 'string',
'RoutingProfileId': 'string',
'Description': 'string',
'MediaConcurrencies': [
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123
},
],
'DefaultOutboundQueueId': 'string',
'Tags': {
'string': 'string'
},
'NumberOfAssociatedQueues': 123,
'NumberOfAssociatedUsers': 123
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
RoutingProfiles (list) --
Information about the routing profiles.
(dict) --
Contains information about a routing profile.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Name (string) --
The name of the routing profile.
RoutingProfileArn (string) --
The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileId (string) --
The identifier of the routing profile.
Description (string) --
The description of the routing profile.
MediaConcurrencies (list) --
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
(dict) --
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
Channel (string) --
The channels that agents can handle in the Contact Control Panel (CCP).
Concurrency (integer) --
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
DefaultOutboundQueueId (string) --
The identifier of the default outbound queue for this routing profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
NumberOfAssociatedQueues (integer) --
The number of associated queues in routing profile.
NumberOfAssociatedUsers (integer) --
The number of associated users in routing profile.
ApproximateTotalCount (integer) --
The total number of routing profiles which matched your search query.
Connect.Paginator.SearchSecurityProfiles¶paginator = client.get_paginator('search_security_profiles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.search_security_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
},
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
The search criteria to be used to return security profiles.
Note
The currently supported value for FieldName : name
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return security profiles.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return security profiles.
A leaf node condition which can be used to specify a string condition.
Note
The currently supported value for FieldName : name
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecurityProfiles': [
{
'Id': 'string',
'OrganizationResourceId': 'string',
'Arn': 'string',
'SecurityProfileName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
}
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
SecurityProfiles (list) --
Information about the security profiles.
(dict) --
Information about the returned security profiles.
Id (string) --
The identifier of the security profile.
OrganizationResourceId (string) --
The organization resource identifier.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
SecurityProfileName (string) --
The name of the security profile.
Description (string) --
The description of the security profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
ApproximateTotalCount (integer) --
The total number of security profiles which matched your search query.
Connect.Paginator.SearchUsers¶paginator = client.get_paginator('search_users')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.search_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'HierarchyGroupCondition': {
'Value': 'string',
'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS'
}
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters to be applied to search results.
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
OR operatorAND operator.A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
The tag key in the tag condition.
The tag value in the tag condition.
A leaf node condition which can be used to specify a tag condition.
The tag key in the tag condition.
The tag value in the tag condition.
The search criteria to be used to return users.
Note
The Username , Firstname , and Lastname 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 result in empty results.
A list of conditions which would be applied together with an OR condition.
The search criteria to be used to return users.
Note
The Username , Firstname , and Lastname 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 result in empty results.
A list of conditions which would be applied together with an AND condition.
The search criteria to be used to return users.
Note
The Username , Firstname , and Lastname 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 result in empty results.
A leaf node condition which can be used to specify a string condition.
The name of the field in the string condition.
The value of the string.
The type of comparison to be made when evaluating the string condition.
A leaf node condition which can be used to specify a hierarchy group condition.
The value in the hierarchy group condition.
The type of hierarchy group match.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Users': [
{
'Arn': 'string',
'DirectoryUserId': 'string',
'HierarchyGroupId': 'string',
'Id': 'string',
'IdentityInfo': {
'FirstName': 'string',
'LastName': 'string'
},
'PhoneConfig': {
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
'RoutingProfileId': 'string',
'SecurityProfileIds': [
'string',
],
'Tags': {
'string': 'string'
},
'Username': 'string'
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Users (list) --
Information about the users.
(dict) --
Information about the returned users.
Arn (string) --
The Amazon Resource Name (ARN) of the user.
DirectoryUserId (string) --
The directory identifier of the user.
HierarchyGroupId (string) --
The identifier of the user's hierarchy group.
Id (string) --
The identifier of the user's summary.
IdentityInfo (dict) --
The user's first name and last name.
FirstName (string) --
The user's first name.
LastName (string) --
The user's last name.
PhoneConfig (dict) --
Contains information about the phone configuration settings for a user.
PhoneType (string) --
The phone type.
AutoAccept (boolean) --
The Auto accept setting.
AfterContactWorkTimeLimit (integer) --
The After Call Work (ACW) timeout setting, in seconds.
Note
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
DeskPhoneNumber (string) --
The phone number for the user's desk phone.
RoutingProfileId (string) --
The identifier of the user's routing profile.
SecurityProfileIds (list) --
The identifiers of the user's security profiles.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Username (string) --
The name of the user.
ApproximateTotalCount (integer) --
The total number of users who matched your search query.
Connect.Paginator.SearchVocabularies¶paginator = client.get_paginator('search_vocabularies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Connect.Client.search_vocabularies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
State='CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
NameStartsWith='string',
LanguageCode='ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'VocabularySummaryList': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'LanguageCode': 'ar-AE'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fr-CA'|'fr-FR'|'hi-IN'|'it-IT'|'ja-JP'|'ko-KR'|'pt-BR'|'pt-PT'|'zh-CN',
'State': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'DELETE_IN_PROGRESS',
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string'
},
],
}
Response Structure
(dict) --
VocabularySummaryList (list) --
The list of the available custom vocabularies.
(dict) --
Contains summary information about the custom vocabulary.
Name (string) --
A unique name of the custom vocabulary.
Id (string) --
The identifier of the custom vocabulary.
Arn (string) --
The Amazon Resource Name (ARN) of the custom vocabulary.
LanguageCode (string) --
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
State (string) --
The current state of the custom vocabulary.
LastModifiedTime (datetime) --
The timestamp when the custom vocabulary was last modified.
FailureReason (string) --
The reason why the custom vocabulary was not created.