Connect#
Client#
- class 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 use an endpoint to connect programmatically to an Amazon Web Services service. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
client = session.create_client('connect')
These are the available methods:
- activate_evaluation_form
- associate_analytics_data_set
- associate_approved_origin
- associate_bot
- associate_default_vocabulary
- associate_flow
- 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
- associate_traffic_distribution_group_user
- associate_user_proficiencies
- batch_associate_analytics_data_set
- batch_disassociate_analytics_data_set
- batch_get_attached_file_metadata
- batch_get_flow_association
- batch_put_contact
- can_paginate
- claim_phone_number
- close
- complete_attached_file_upload
- create_agent_status
- create_contact
- create_contact_flow
- create_contact_flow_module
- create_contact_flow_version
- create_email_address
- create_evaluation_form
- create_hours_of_operation
- create_hours_of_operation_override
- create_instance
- create_integration_association
- create_participant
- create_persistent_contact_association
- create_predefined_attribute
- create_prompt
- create_push_notification_registration
- create_queue
- create_quick_connect
- create_routing_profile
- create_rule
- create_security_profile
- create_task_template
- create_traffic_distribution_group
- create_use_case
- create_user
- create_user_hierarchy_group
- create_view
- create_view_version
- create_vocabulary
- deactivate_evaluation_form
- delete_attached_file
- delete_contact_evaluation
- delete_contact_flow
- delete_contact_flow_module
- delete_email_address
- delete_evaluation_form
- delete_hours_of_operation
- delete_hours_of_operation_override
- delete_instance
- delete_integration_association
- delete_predefined_attribute
- delete_prompt
- delete_push_notification_registration
- delete_queue
- delete_quick_connect
- delete_routing_profile
- delete_rule
- delete_security_profile
- delete_task_template
- delete_traffic_distribution_group
- delete_use_case
- delete_user
- delete_user_hierarchy_group
- delete_view
- delete_view_version
- delete_vocabulary
- describe_agent_status
- describe_authentication_profile
- describe_contact
- describe_contact_evaluation
- describe_contact_flow
- describe_contact_flow_module
- describe_email_address
- describe_evaluation_form
- describe_hours_of_operation
- describe_hours_of_operation_override
- describe_instance
- describe_instance_attribute
- describe_instance_storage_config
- describe_phone_number
- describe_predefined_attribute
- describe_prompt
- describe_queue
- describe_quick_connect
- describe_routing_profile
- describe_rule
- describe_security_profile
- describe_traffic_distribution_group
- describe_user
- describe_user_hierarchy_group
- describe_user_hierarchy_structure
- describe_view
- describe_vocabulary
- disassociate_analytics_data_set
- disassociate_approved_origin
- disassociate_bot
- disassociate_flow
- 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
- disassociate_traffic_distribution_group_user
- disassociate_user_proficiencies
- dismiss_user_contact
- get_attached_file
- get_contact_attributes
- get_current_metric_data
- get_current_user_data
- get_effective_hours_of_operations
- get_federation_token
- get_flow_association
- get_metric_data
- get_metric_data_v2
- get_paginator
- get_prompt_file
- get_task_template
- get_traffic_distribution
- get_waiter
- import_phone_number
- list_agent_statuses
- list_analytics_data_associations
- list_approved_origins
- list_associated_contacts
- list_authentication_profiles
- list_bots
- list_contact_evaluations
- list_contact_flow_modules
- list_contact_flow_versions
- list_contact_flows
- list_contact_references
- list_default_vocabularies
- list_evaluation_form_versions
- list_evaluation_forms
- list_flow_associations
- list_hours_of_operation_overrides
- 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_predefined_attributes
- list_prompts
- list_queue_quick_connects
- list_queues
- list_quick_connects
- list_realtime_contact_analysis_segments_v2
- list_routing_profile_queues
- list_routing_profiles
- list_rules
- list_security_keys
- list_security_profile_applications
- list_security_profile_permissions
- list_security_profiles
- list_tags_for_resource
- list_task_templates
- list_traffic_distribution_group_users
- list_traffic_distribution_groups
- list_use_cases
- list_user_hierarchy_groups
- list_user_proficiencies
- list_users
- list_view_versions
- list_views
- monitor_contact
- pause_contact
- put_user_status
- release_phone_number
- replicate_instance
- resume_contact
- resume_contact_recording
- search_agent_statuses
- search_available_phone_numbers
- search_contact_flow_modules
- search_contact_flows
- search_contacts
- search_email_addresses
- search_hours_of_operation_overrides
- search_hours_of_operations
- search_predefined_attributes
- search_prompts
- search_queues
- search_quick_connects
- search_resource_tags
- search_routing_profiles
- search_security_profiles
- search_user_hierarchy_groups
- search_users
- search_vocabularies
- send_chat_integration_event
- send_outbound_email
- start_attached_file_upload
- start_chat_contact
- start_contact_evaluation
- start_contact_recording
- start_contact_streaming
- start_email_contact
- start_outbound_chat_contact
- start_outbound_email_contact
- start_outbound_voice_contact
- start_screen_sharing
- start_task_contact
- start_web_rtc_contact
- stop_contact
- stop_contact_recording
- stop_contact_streaming
- submit_contact_evaluation
- suspend_contact_recording
- tag_contact
- tag_resource
- transfer_contact
- untag_contact
- untag_resource
- update_agent_status
- update_authentication_profile
- update_contact
- update_contact_attributes
- update_contact_evaluation
- update_contact_flow_content
- update_contact_flow_metadata
- update_contact_flow_module_content
- update_contact_flow_module_metadata
- update_contact_flow_name
- update_contact_routing_data
- update_contact_schedule
- update_email_address_metadata
- update_evaluation_form
- update_hours_of_operation
- update_hours_of_operation_override
- update_instance_attribute
- update_instance_storage_config
- update_participant_authentication
- update_participant_role_config
- update_phone_number
- update_phone_number_metadata
- update_predefined_attribute
- update_prompt
- update_queue_hours_of_operation
- update_queue_max_contacts
- update_queue_name
- update_queue_outbound_caller_config
- update_queue_outbound_email_config
- update_queue_status
- update_quick_connect_config
- update_quick_connect_name
- update_routing_profile_agent_availability_timer
- update_routing_profile_concurrency
- update_routing_profile_default_outbound_queue
- update_routing_profile_name
- update_routing_profile_queues
- update_rule
- 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_proficiencies
- update_user_routing_profile
- update_user_security_profiles
- update_view_content
- update_view_metadata
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AccessDeniedException
- ConditionalOperationFailedException
- ConflictException
- ContactFlowNotPublishedException
- ContactNotFoundException
- DestinationNotAllowedException
- DuplicateResourceException
- IdempotencyException
- InternalServiceException
- InvalidContactFlowException
- InvalidContactFlowModuleException
- InvalidParameterException
- InvalidRequestException
- LimitExceededException
- MaximumResultReturnedException
- OutboundContactNotPermittedException
- OutputTypeNotFoundException
- PropertyValidationException
- ResourceConflictException
- ResourceInUseException
- ResourceNotFoundException
- ResourceNotReadyException
- ServiceQuotaExceededException
- ThrottlingException
- TooManyRequestsException
- UserNotFoundException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
- GetMetricData
- ListAgentStatuses
- ListApprovedOrigins
- ListAuthenticationProfiles
- ListBots
- ListContactEvaluations
- ListContactFlowModules
- ListContactFlowVersions
- ListContactFlows
- ListContactReferences
- ListDefaultVocabularies
- ListEvaluationFormVersions
- ListEvaluationForms
- ListFlowAssociations
- ListHoursOfOperationOverrides
- ListHoursOfOperations
- ListInstanceAttributes
- ListInstanceStorageConfigs
- ListInstances
- ListIntegrationAssociations
- ListLambdaFunctions
- ListLexBots
- ListPhoneNumbers
- ListPhoneNumbersV2
- ListPredefinedAttributes
- ListPrompts
- ListQueueQuickConnects
- ListQueues
- ListQuickConnects
- ListRoutingProfileQueues
- ListRoutingProfiles
- ListRules
- ListSecurityKeys
- ListSecurityProfileApplications
- ListSecurityProfilePermissions
- ListSecurityProfiles
- ListTaskTemplates
- ListTrafficDistributionGroupUsers
- ListTrafficDistributionGroups
- ListUseCases
- ListUserHierarchyGroups
- ListUserProficiencies
- ListUsers
- ListViewVersions
- ListViews
- SearchAgentStatuses
- SearchAvailablePhoneNumbers
- SearchContactFlowModules
- SearchContactFlows
- SearchContacts
- SearchHoursOfOperationOverrides
- SearchHoursOfOperations
- SearchPredefinedAttributes
- SearchPrompts
- SearchQueues
- SearchQuickConnects
- SearchResourceTags
- SearchRoutingProfiles
- SearchSecurityProfiles
- SearchUserHierarchyGroups
- SearchUsers
- SearchVocabularies