Connect ******* Client ====== class Connect.Client A low-level client representing Amazon Connect Service * Amazon Connect actions * Amazon Connect data types 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. import boto3 client = boto3.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_contact_flow_version * 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_contact_metrics * 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_analytics_data_lake_data_sets * 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 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 Connect / Paginator / SearchVocabularies SearchVocabularies ****************** class 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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **State** (*string*) -- The current state of the custom vocabulary. * **NameStartsWith** (*string*) -- The starting pattern of the name of the 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? * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', '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. Connect / Paginator / ListPhoneNumbers ListPhoneNumbers **************** class 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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', ], 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PhoneNumberTypes** (*list*) -- The type of phone number. Note: We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types "UIFN", "SHARED", "THIRD_PARTY_TF", and "THIRD_PARTY_DID", it incorrectly lists them as "TOLL_FREE" or "DID". * *(string) --* * **PhoneNumberCountryCodes** (*list*) -- The ISO country code. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PhoneNumberSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'PhoneNumber': 'string', 'PhoneNumberType': 'TOLL_FREE'|'DID'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', '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 / ListTrafficDistributionGroupUsers ListTrafficDistributionGroupUsers ********************************* class Connect.Paginator.ListTrafficDistributionGroupUsers paginator = client.get_paginator('list_traffic_distribution_group_users') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_traffic_distribution_group_users()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TrafficDistributionGroupId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TrafficDistributionGroupUserSummaryList': [ { 'UserId': 'string' }, ] } **Response Structure** * *(dict) --* * **TrafficDistributionGroupUserSummaryList** *(list) --* A list of traffic distribution group users. * *(dict) --* Summary information about a traffic distribution group user. * **UserId** *(string) --* The identifier for the user. This can be the ID or the ARN of the user. Connect / Paginator / ListQueueQuickConnects ListQueueQuickConnects ********************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'QuickConnectSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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 admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListUseCases ListUseCases ************ class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationAssociationId** (*string*) -- **[REQUIRED]** The identifier for the integration association. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListUserProficiencies ListUserProficiencies ********************* class Connect.Paginator.ListUserProficiencies paginator = client.get_paginator('list_user_proficiencies') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_user_proficiencies()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', UserId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'UserProficiencyList': [ { 'AttributeName': 'string', 'AttributeValue': 'string', 'Level': ... }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **Response Structure** * *(dict) --* * **UserProficiencyList** *(list) --* Information about the user proficiencies. * *(dict) --* Information about proficiency of a user. * **AttributeName** *(string) --* The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance. * **AttributeValue** *(string) --* The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance. * **Level** *(float) --* The level of the proficiency. The valid values are 1, 2, 3, 4 and 5. * **LastModifiedTime** *(datetime) --* The last time that the user's proficiencies are were modified. * **LastModifiedRegion** *(string) --* The region in which a user's proficiencies were last modified. Connect / Paginator / SearchContactFlows SearchContactFlows ****************** class Connect.Paginator.SearchContactFlows paginator = client.get_paginator('search_contact_flows') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_contact_flows()". 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' }, 'TypeCondition': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN', 'StateCondition': 'ACTIVE'|'ARCHIVED', 'StatusCondition': 'PUBLISHED'|'SAVED' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return flows. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return flows. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return flows. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **TypeCondition** *(string) --* The type of flow. * **StateCondition** *(string) --* The state of the flow. * **StatusCondition** *(string) --* The status of the flow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ContactFlows': [ { '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'|'CAMPAIGN', 'State': 'ACTIVE'|'ARCHIVED', 'Status': 'PUBLISHED'|'SAVED', 'Description': 'string', 'Content': 'string', 'Tags': { 'string': 'string' }, 'FlowContentSha256': 'string', 'Version': 123, 'VersionDescription': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **ContactFlows** *(list) --* Information about the flows. * *(dict) --* Contains information about a 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. * **Status** *(string) --* The status of the flow. * **Description** *(string) --* The description of the flow. * **Content** *(string) --* The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **FlowContentSha256** *(string) --* Indicates the checksum value of the flow content. * **Version** *(integer) --* The identifier of the flow version. * **VersionDescription** *(string) --* The description of the flow version. * **LastModifiedTime** *(datetime) --* The time at which the flow was last modified. * **LastModifiedRegion** *(string) --* The region in which the flow was last modified * **ApproximateTotalCount** *(integer) --* The total number of flows which matched your search query. Connect / Paginator / ListPrompts ListPrompts *********** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PromptSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListHoursOfOperations ListHoursOfOperations ********************* class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HoursOfOperationSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListBots ListBots ******** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **LexVersion** (*string*) -- **[REQUIRED]** The version of Amazon Lex or Amazon Lex V2. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListAuthenticationProfiles ListAuthenticationProfiles ************************** class Connect.Paginator.ListAuthenticationProfiles paginator = client.get_paginator('list_authentication_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_authentication_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AuthenticationProfileSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'IsDefault': True|False, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], } **Response Structure** * *(dict) --* * **AuthenticationProfileSummaryList** *(list) --* A summary of a given authentication profile. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport. A summary of a given authentication profile. * **Id** *(string) --* The unique identifier of the authentication profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the authentication profile summary. * **Name** *(string) --* The name of the authentication profile summary. * **IsDefault** *(boolean) --* Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile. * **LastModifiedTime** *(datetime) --* The timestamp when the authentication profile summary was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region when the authentication profile summary was last modified. Connect / Paginator / ListDefaultVocabularies ListDefaultVocabularies *********************** class 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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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? * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', '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 instance ID in the Amazon Resource Name (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 / ListAgentStatuses ListAgentStatuses ***************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AgentStatusTypes** (*list*) -- Available agent status types. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AgentStatusSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ] } **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListEvaluationFormVersions ListEvaluationFormVersions ************************** class Connect.Paginator.ListEvaluationFormVersions paginator = client.get_paginator('list_evaluation_form_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_evaluation_form_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', EvaluationFormId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EvaluationFormVersionSummaryList': [ { 'EvaluationFormArn': 'string', 'EvaluationFormId': 'string', 'EvaluationFormVersion': 123, 'Locked': True|False, 'Status': 'DRAFT'|'ACTIVE', 'CreatedTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': 'string' }, ], } **Response Structure** * *(dict) --* * **EvaluationFormVersionSummaryList** *(list) --* Provides details about a list of evaluation forms belonging to an instance. * *(dict) --* Summary information about an evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormVersion** *(integer) --* A version of the evaluation form. * **Locked** *(boolean) --* The flag indicating whether the evaluation form is locked for changes. * **Status** *(string) --* The status of the evaluation form. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation form was created. * **CreatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who created the evaluation form. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation form was last updated. * **LastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation form. Connect / Paginator / GetMetricData GetMetricData ************* class Connect.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'|'EMAIL', ], 'RoutingProfiles': [ 'string', ], 'RoutingStepExpressions': [ 'string', ] }, Groupings=[ 'QUEUE'|'CHANNEL'|'ROUTING_PROFILE'|'ROUTING_STEP_EXPRESSION', ], 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **StartTime** (*datetime*) -- **[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. * **EndTime** (*datetime*) -- **[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. * **Filters** (*dict*) -- **[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. RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features. Note: To filter by "Queues", enter the queue ID/ARN, not the name of the queue. * **Queues** *(list) --* 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. * *(string) --* * **Channels** *(list) --* The channel to use to filter the metrics. * *(string) --* * **RoutingProfiles** *(list) --* A list of up to 100 routing profile IDs or ARNs. * *(string) --* * **RoutingStepExpressions** *(list) --* A list of expressions as a filter, in which an expression is an object of a step in a routing criteria. * *(string) --* * **Groupings** (*list*) -- 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. RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features. * *(string) --* * **HistoricalMetrics** (*list*) -- **[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 Metrics definition 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 UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time 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"). UI name: Average queue abandon time * *(dict) --* Contains information about a historical metric. * **Name** *(string) --* The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the *Amazon Connect Administrator Guide*. ABANDON_TIME Unit: SECONDS Statistic: AVG UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time 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"). UI name: Service level X * **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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MetricResults': [ { 'Dimensions': { 'Queue': { 'Id': 'string', 'Arn': 'string' }, 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'RoutingProfile': { 'Id': 'string', 'Arn': 'string' }, 'RoutingStepExpression': 'string' }, '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. * **RoutingProfile** *(dict) --* Information about the routing profile assigned to the user. * **Id** *(string) --* The identifier of the routing profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the routing profile. * **RoutingStepExpression** *(string) --* The expression of a step in a routing criteria. * **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. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the *Amazon Connect Administrator Guide*. ABANDON_TIME Unit: SECONDS Statistic: AVG UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time 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"). UI name: Service level X * **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 / SearchHoursOfOperations SearchHoursOfOperations *********************** class Connect.Paginator.SearchHoursOfOperations paginator = client.get_paginator('search_hours_of_operations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_hours_of_operations()". 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return hours of operations. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return hours of operations. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return hours of operations. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", "timezone", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HoursOfOperations': [ { '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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **HoursOfOperations** *(list) --* Information about the hours of operations. * *(dict) --* Information about of 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **ApproximateTotalCount** *(integer) --* The total number of hours of operations which matched your search query. Connect / Paginator / ListPhoneNumbersV2 ListPhoneNumbersV2 ****************** class 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', InstanceId='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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', ], PhoneNumberPrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both "TargetArn" and "InstanceId" input are 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. * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both "TargetArn" and "InstanceId" are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request. * **PhoneNumberCountryCodes** (*list*) -- The ISO country code. * *(string) --* * **PhoneNumberTypes** (*list*) -- The type of phone number. * *(string) --* * **PhoneNumberPrefix** (*string*) -- The prefix of the phone number. If provided, it must contain "+" as part of the country code. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', 'TargetArn': 'string', 'InstanceId': 'string', 'PhoneNumberDescription': 'string', 'SourcePhoneNumberArn': '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 number inbound traffic is routed through. * **InstanceId** *(string) --* The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PhoneNumberDescription** *(string) --* The description of the phone number. * **SourcePhoneNumberArn** *(string) --* The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging. Connect / Paginator / SearchHoursOfOperationOverrides SearchHoursOfOperationOverrides ******************************* class Connect.Paginator.SearchHoursOfOperationOverrides paginator = client.get_paginator('search_hours_of_operation_overrides') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_hours_of_operation_overrides()". 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' }, 'DateCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return hours of operations overrides. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return hours of operations overrides. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return hours of operations overrides. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **DateCondition** *(dict) --* A leaf node condition which can be used to specify a date condition. * **FieldName** *(string) --* An object to specify the hours of operation override date field. * **Value** *(string) --* An object to specify the hours of operation override date value. * **ComparisonType** *(string) --* An object to specify the hours of operation override date condition "comparisonType". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HoursOfOperationOverrides': [ { 'HoursOfOperationOverrideId': 'string', 'HoursOfOperationId': 'string', 'HoursOfOperationArn': 'string', 'Name': 'string', 'Description': 'string', 'Config': [ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], 'EffectiveFrom': 'string', 'EffectiveTill': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **HoursOfOperationOverrides** *(list) --* Information about the hours of operations overrides. * *(dict) --* Information about the hours of operations override. * **HoursOfOperationOverrideId** *(string) --* The identifier for the hours of operation override. * **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 of the hours of operation override. * **Description** *(string) --* The description of the hours of operation override. * **Config** *(list) --* Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EffectiveFrom** *(string) --* The date from which the hours of operation override would be effective. * **EffectiveTill** *(string) --* The date till which the hours of operation override would be effective. * **ApproximateTotalCount** *(integer) --* The total number of hours of operations which matched your search query. Connect / Paginator / ListInstances ListInstances ************* class 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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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, 'InstanceAccessUrl': '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. * **InstanceAccessUrl** *(string) --* This URL allows contact center users to access the Amazon Connect admin website. Connect / Paginator / ListRoutingProfileQueues ListRoutingProfileQueues ************************ class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RoutingProfileQueueConfigSummaryList': [ { 'QueueId': 'string', 'QueueArn': 'string', 'QueueName': 'string', 'Priority': 123, 'Delay': 123, 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL' }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListViewVersions ListViewVersions **************** class Connect.Paginator.ListViewVersions paginator = client.get_paginator('list_view_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_view_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', ViewId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ViewVersionSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Description': 'string', 'Name': 'string', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Version': 123, 'VersionDescription': 'string' }, ], } **Response Structure** * *(dict) --* * **ViewVersionSummaryList** *(list) --* A list of view version summaries. * *(dict) --* A summary of a view version's metadata. * **Id** *(string) --* The identifier of the view version. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view version. * **Description** *(string) --* The description of the view version. * **Name** *(string) --* The name of the view version. * **Type** *(string) --* The type of the view version. * **Version** *(integer) --* The sequentially incremented version of the view version. * **VersionDescription** *(string) --* The description of the view version. Connect / Paginator / ListApprovedOrigins ListApprovedOrigins ******************* class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Origins': [ 'string', ], } **Response Structure** * *(dict) --* * **Origins** *(list) --* The approved origins. * *(string) --* Connect / Paginator / ListUsers ListUsers ********* class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'UserSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Username': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / SearchPredefinedAttributes SearchPredefinedAttributes ************************** class Connect.Paginator.SearchPredefinedAttributes paginator = client.get_paginator('search_predefined_attributes') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_predefined_attributes()". 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' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchCriteria** (*dict*) -- The search criteria to be used to return predefined attributes. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return predefined attributes. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return predefined attributes. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PredefinedAttributes': [ { 'Name': 'string', 'Values': { 'StringList': [ 'string', ] }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **PredefinedAttributes** *(list) --* Predefined attributes matched by the search criteria. * *(dict) --* Information about a predefined attribute. * **Name** *(string) --* The name of the predefined attribute. * **Values** *(dict) --* The values of the predefined attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringList". 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'} * **StringList** *(list) --* Predefined attribute values of type string list. * *(string) --* * **LastModifiedTime** *(datetime) --* Last modified time. * **LastModifiedRegion** *(string) --* Last modified region. * **ApproximateTotalCount** *(integer) --* The approximate number of predefined attributes which matched your search query. Connect / Paginator / ListPredefinedAttributes ListPredefinedAttributes ************************ class Connect.Paginator.ListPredefinedAttributes paginator = client.get_paginator('list_predefined_attributes') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_predefined_attributes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PredefinedAttributeSummaryList': [ { 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ] } **Response Structure** * *(dict) --* * **PredefinedAttributeSummaryList** *(list) --* Summary of the predefined attributes. * *(dict) --* Summary of a predefined attribute. * **Name** *(string) --* The name of the predefined attribute. * **LastModifiedTime** *(datetime) --* Last modified time. * **LastModifiedRegion** *(string) --* Last modified region. Connect / Paginator / SearchAvailablePhoneNumbers SearchAvailablePhoneNumbers *************************** class 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', InstanceId='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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', PhoneNumberPrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter "InstanceId" or "TargetArn". * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter "InstanceId" or "TargetArn". * **PhoneNumberCountryCode** (*string*) -- **[REQUIRED]** The ISO country code. * **PhoneNumberType** (*string*) -- **[REQUIRED]** The type of phone number. * **PhoneNumberPrefix** (*string*) -- The prefix of the phone number. If provided, it must contain "+" as part of the country code. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE' }, ] } **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 / ListIntegrationAssociations ListIntegrationAssociations *************************** class 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'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL', IntegrationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationType** (*string*) -- The integration type. * **IntegrationArn** (*string*) -- The Amazon Resource Name (ARN) of the integration. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IntegrationAssociationSummaryList': [ { 'IntegrationAssociationId': 'string', 'IntegrationAssociationArn': 'string', 'InstanceId': 'string', 'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL', 'IntegrationArn': 'string', 'SourceApplicationUrl': 'string', 'SourceApplicationName': 'string', 'SourceType': 'SALESFORCE'|'ZENDESK'|'CASES' }, ], } **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 instance ID in the Amazon Resource Name (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 / SearchSecurityProfiles SearchSecurityProfiles ********************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchCriteria** (*dict*) -- The search criteria to be used to return security profiles. Note: The "name" field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. Note: The currently supported value for "FieldName": "name" * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return security profiles. Note: The "name" field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return security profiles. Note: The "name" field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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"} }. * *(string) --* * *(string) --* * **ApproximateTotalCount** *(integer) --* The total number of security profiles which matched your search query. Connect / Paginator / ListContactFlows ListContactFlows **************** class 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'|'CAMPAIGN', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowTypes** (*list*) -- The type of flow. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'CAMPAIGN', 'ContactFlowState': 'ACTIVE'|'ARCHIVED', 'ContactFlowStatus': 'PUBLISHED'|'SAVED' }, ], } **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. * **ContactFlowStatus** *(string) --* The status of the flow. Connect / Paginator / ListSecurityProfiles ListSecurityProfiles ******************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SecurityProfileSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / SearchQuickConnects SearchQuickConnects ******************* class Connect.Paginator.SearchQuickConnects paginator = client.get_paginator('search_quick_connects') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_quick_connects()". 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return quick connects. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return quick connects. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return quick connects. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'QuickConnects': [ { '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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **QuickConnects** *(list) --* Information about the quick connects. * *(dict) --* Contains information about a 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 admin website, 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **ApproximateTotalCount** *(integer) --* The total number of quick connects which matched your search query. Connect / Paginator / ListInstanceStorageConfigs ListInstanceStorageConfigs ************************** class 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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **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.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **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 / ListContactFlowModules ListContactFlowModules ********************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowModuleState** (*string*) -- The state of the flow module. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListSecurityProfileApplications ListSecurityProfileApplications ******************************* class Connect.Paginator.ListSecurityProfileApplications paginator = client.get_paginator('list_security_profile_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_security_profile_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SecurityProfileId='string', InstanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Applications': [ { 'Namespace': 'string', 'ApplicationPermissions': [ 'string', ] }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **Response Structure** * *(dict) --* * **Applications** *(list) --* A list of the third-party application's metadata. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. A third-party application's metadata. * **Namespace** *(string) --* Namespace of the application that you want to give access to. * **ApplicationPermissions** *(list) --* The permissions that the agent is granted on the application. Only the "ACCESS" permission is supported. * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListContactFlowVersions ListContactFlowVersions *********************** class Connect.Paginator.ListContactFlowVersions paginator = client.get_paginator('list_contact_flow_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_contact_flow_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', ContactFlowId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ContactFlowVersionSummaryList': [ { 'Arn': 'string', 'VersionDescription': 'string', 'Version': 123 }, ], } **Response Structure** * *(dict) --* * **ContactFlowVersionSummaryList** *(list) --* A list of flow version summaries. * *(dict) --* A summary of a flow version's metadata. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view version. * **VersionDescription** *(string) --* The description of the flow version. * **Version** *(integer) --* The identifier of the flow version. Connect / Paginator / ListQueues ListQueues ********** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueTypes** (*list*) -- The type of queue. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'QueueSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'QueueType': 'STANDARD'|'AGENT', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListSecurityKeys ListSecurityKeys **************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / SearchContacts SearchContacts ************** class Connect.Paginator.SearchContacts paginator = client.get_paginator('search_contacts') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_contacts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', TimeRange={ 'Type': 'INITIATION_TIMESTAMP'|'SCHEDULED_TIMESTAMP'|'CONNECTED_TO_AGENT_TIMESTAMP'|'DISCONNECT_TIMESTAMP', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, SearchCriteria={ 'AgentIds': [ 'string', ], 'AgentHierarchyGroups': { 'L1Ids': [ 'string', ], 'L2Ids': [ 'string', ], 'L3Ids': [ 'string', ], 'L4Ids': [ 'string', ], 'L5Ids': [ 'string', ] }, 'Channels': [ 'VOICE'|'CHAT'|'TASK'|'EMAIL', ], 'ContactAnalysis': { 'Transcript': { 'Criteria': [ { 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'SearchText': [ 'string', ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' }, ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' } }, 'InitiationMethods': [ 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', ], 'QueueIds': [ 'string', ], 'SearchableContactAttributes': { 'Criteria': [ { 'Key': 'string', 'Values': [ 'string', ] }, ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' }, 'SearchableSegmentAttributes': { 'Criteria': [ { 'Key': 'string', 'Values': [ 'string', ] }, ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' } }, Sort={ 'FieldName': 'INITIATION_TIMESTAMP'|'SCHEDULED_TIMESTAMP'|'CONNECTED_TO_AGENT_TIMESTAMP'|'DISCONNECT_TIMESTAMP'|'INITIATION_METHOD'|'CHANNEL', 'Order': 'ASCENDING'|'DESCENDING' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **TimeRange** (*dict*) -- **[REQUIRED]** Time range that you want to search results. * **Type** *(string) --* **[REQUIRED]** The type of timestamp to search. * **StartTime** *(datetime) --* **[REQUIRED]** The start time of the time range. * **EndTime** *(datetime) --* **[REQUIRED]** The end time of the time range. * **SearchCriteria** (*dict*) -- The search criteria to be used to return contacts. * **AgentIds** *(list) --* The identifiers of agents who handled the contacts. * *(string) --* * **AgentHierarchyGroups** *(dict) --* The agent hierarchy groups of the agent at the time of handling the contact. * **L1Ids** *(list) --* The identifiers for level 1 hierarchy groups. * *(string) --* * **L2Ids** *(list) --* The identifiers for level 2 hierarchy groups. * *(string) --* * **L3Ids** *(list) --* The identifiers for level 3 hierarchy groups. * *(string) --* * **L4Ids** *(list) --* The identifiers for level 4 hierarchy groups. * *(string) --* * **L5Ids** *(list) --* The identifiers for level 5 hierarchy groups. * *(string) --* * **Channels** *(list) --* The list of channels associated with contacts. * *(string) --* * **ContactAnalysis** *(dict) --* Search criteria based on analysis outputs from Amazon Connect Contact Lens. * **Transcript** *(dict) --* Search criteria based on transcript analyzed by Amazon Connect Contact Lens. * **Criteria** *(list) --* **[REQUIRED]** The list of search criteria based on Contact Lens conversational analytics transcript. * *(dict) --* A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript. * **ParticipantRole** *(string) --* **[REQUIRED]** The participant role in a transcript * **SearchText** *(list) --* **[REQUIRED]** The words or phrases used to search within a transcript. * *(string) --* * **MatchType** *(string) --* **[REQUIRED]** The match type combining search criteria using multiple search texts in a transcript criteria. * **MatchType** *(string) --* The match type combining search criteria using multiple transcript criteria. * **InitiationMethods** *(list) --* The list of initiation methods associated with contacts. * *(string) --* * **QueueIds** *(list) --* The list of queue IDs associated with contacts. * *(string) --* * **SearchableContactAttributes** *(dict) --* The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the *Amazon Connect Administrator Guide*. Warning: To use "SearchableContactAttributes" in a search request, the "GetContactAttributes" action is required to perform an API request. For more information, see >>`<`__Actions defined by Amazon Connect. * **Criteria** *(list) --* **[REQUIRED]** The list of criteria based on user-defined contact attributes that are configured for contact search. * *(dict) --* The search criteria based on user-defined contact attribute key and values to search on. * **Key** *(string) --* **[REQUIRED]** The key containing a searchable user-defined contact attribute. * **Values** *(list) --* **[REQUIRED]** The list of values to search for within a user- defined contact attribute. * *(string) --* * **MatchType** *(string) --* The match type combining search criteria using multiple searchable contact attributes. * **SearchableSegmentAttributes** *(dict) --* The search criteria based on searchable segment attributes of a contact. * **Criteria** *(list) --* **[REQUIRED]** The list of criteria based on searchable segment attributes. * *(dict) --* The search criteria based on searchable segment attribute key and values to search on. * **Key** *(string) --* **[REQUIRED]** The key containing a searchable segment attribute. * **Values** *(list) --* **[REQUIRED]** The list of values to search for within a searchable segment attribute. * *(string) --* * **MatchType** *(string) --* The match type combining search criteria using multiple searchable segment attributes. * **Sort** (*dict*) -- Specifies a field to sort by and a sort order. * **FieldName** *(string) --* **[REQUIRED]** The name of the field on which to sort. * **Order** *(string) --* **[REQUIRED]** An ascending or descending sort. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Contacts': [ { 'Arn': 'string', 'Id': 'string', 'InitialContactId': 'string', 'PreviousContactId': 'string', 'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', '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), 'ScheduledTimestamp': datetime(2015, 1, 1), 'SegmentAttributes': { 'string': { 'ValueString': 'string' } } }, ], 'TotalCount': 123 } **Response Structure** * *(dict) --* * **Contacts** *(list) --* Information about the contacts. * *(dict) --* Information of returned contact. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the contact. * **Id** *(string) --* The identifier of the contact summary. * **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. * **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. For "EXTERNAL_OUTBOUND", this is when the agent started dialing the external participant. For "MONITOR", this is when the supervisor started listening to a contact. * **DisconnectTimestamp** *(datetime) --* The timestamp when the customer endpoint disconnected from Amazon Connect. * **ScheduledTimestamp** *(datetime) --* The timestamp, in Unix epoch time format, at which to start running the inbound flow. * **SegmentAttributes** *(dict) --* Set of segment attributes for a contact. * *(string) --* * *(dict) --* The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute. * **ValueString** *(string) --* The value of a segment attribute represented as a string. * **TotalCount** *(integer) --* The total number of contacts which matched your search query. Connect / Paginator / ListTaskTemplates ListTaskTemplates ***************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **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. * **Name** (*string*) -- The name of the task template. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListQuickConnects ListQuickConnects ***************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QuickConnectTypes** (*list*) -- The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'QuickConnectSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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 admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / SearchAgentStatuses SearchAgentStatuses ******************* class Connect.Paginator.SearchAgentStatuses paginator = client.get_paginator('search_agent_statuses') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_agent_statuses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', SearchFilter={ 'AttributeFilter': { 'OrConditions': [ { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, ], 'AndCondition': { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, '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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **AttributeFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * The top level list specifies conditions that need to be applied with "OR" operator. * The inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **AndCondition** *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return agent statuses. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return agent statuses. * **AndConditions** *(list) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", "state", "type", "displayOrder", and "resourceID". * *(dict) --* The search criteria to be used to return agent statuses. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", "state", "type", "displayOrder", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. type PaginationConfig: dict param PaginationConfig: A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. rtype: dict returns: **Response Syntax** { 'AgentStatuses': [ { 'AgentStatusARN': 'string', 'AgentStatusId': 'string', 'Name': 'string', 'Description': 'string', 'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE', 'DisplayOrder': 123, 'State': 'ENABLED'|'DISABLED', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **AgentStatuses** *(list) --* The search criteria to be used to return agent statuses. * *(dict) --* Contains information about an 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **ApproximateTotalCount** *(integer) --* The total number of agent statuses which matched your search query. Connect / Paginator / ListViews ListViews ********* class Connect.Paginator.ListViews paginator = client.get_paginator('list_views') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_views()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', Type='CUSTOMER_MANAGED'|'AWS_MANAGED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **Type** (*string*) -- The type of the view. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ViewsSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Status': 'PUBLISHED'|'SAVED', 'Description': 'string' }, ], } **Response Structure** * *(dict) --* * **ViewsSummaryList** *(list) --* A list of view summaries. * *(dict) --* A summary of a view's metadata. * **Id** *(string) --* The identifier of the view. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view. * **Name** *(string) --* The name of the view. * **Type** *(string) --* The type of the view. * **Status** *(string) --* Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Description** *(string) --* The description of the view. Connect / Paginator / SearchRoutingProfiles SearchRoutingProfiles ********************* class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return routing profiles. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return routing profiles. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return routing profiles. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "associatedQueueIds", "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RoutingProfiles': [ { 'InstanceId': 'string', 'Name': 'string', 'RoutingProfileArn': 'string', 'RoutingProfileId': 'string', 'Description': 'string', 'MediaConcurrencies': [ { 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'Concurrency': 123, 'CrossChannelBehavior': { 'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL' } }, ], 'DefaultOutboundQueueId': 'string', 'Tags': { 'string': 'string' }, 'NumberOfAssociatedQueues': 123, 'NumberOfAssociatedUsers': 123, 'AgentAvailabilityTimer': 'TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string', 'IsDefault': True|False, 'AssociatedQueueIds': [ '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 instance ID in the Amazon Resource Name (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. * **CrossChannelBehavior** *(dict) --* Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel. * **BehaviorType** *(string) --* Specifies the other channels that can be routed to an agent handling their current channel. * **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"} }. * *(string) --* * *(string) --* * **NumberOfAssociatedQueues** *(integer) --* The number of associated queues in routing profile. * **NumberOfAssociatedUsers** *(integer) --* The number of associated users in routing profile. * **AgentAvailabilityTimer** *(string) --* Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **IsDefault** *(boolean) --* Whether this a default routing profile. * **AssociatedQueueIds** *(list) --* The IDs of the associated queue. * *(string) --* * **ApproximateTotalCount** *(integer) --* The total number of routing profiles which matched your search query. Connect / Paginator / SearchPrompts SearchPrompts ************* class Connect.Paginator.SearchPrompts paginator = client.get_paginator('search_prompts') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_prompts()". 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return prompts. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return prompts. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return prompts. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Prompts': [ { 'PromptARN': 'string', 'PromptId': 'string', 'Name': 'string', 'Description': 'string', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **Prompts** *(list) --* Information about the prompts. * *(dict) --* Information about a prompt. * **PromptARN** *(string) --* The Amazon Resource Name (ARN) of the prompt. * **PromptId** *(string) --* A unique identifier for the prompt. * **Name** *(string) --* The name of the prompt. * **Description** *(string) --* The description of the prompt. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **ApproximateTotalCount** *(integer) --* The total number of quick connects which matched your search query. Connect / Paginator / ListFlowAssociations ListFlowAssociations ******************** class Connect.Paginator.ListFlowAssociations paginator = client.get_paginator('list_flow_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_flow_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceType** (*string*) -- A valid resource type. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'FlowAssociationSummaryList': [ { 'ResourceId': 'string', 'FlowId': 'string', 'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR' }, ], } **Response Structure** * *(dict) --* * **FlowAssociationSummaryList** *(list) --* Summary of flow associations. * *(dict) --* Information about flow associations. * **ResourceId** *(string) --* The identifier of the resource. * **FlowId** *(string) --* The identifier of the flow. * **ResourceType** *(string) --* The type of resource association. Connect / Paginator / ListContactReferences ListContactReferences ********************* class 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'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', ], PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the initial contact. * **ReferenceTypes** (*list*) -- **[REQUIRED]** The type of reference. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ReferenceSummaryList': [ { 'Url': { 'Name': 'string', 'Value': 'string' }, 'Attachment': { 'Name': 'string', 'Value': 'string', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string' }, 'EmailMessage': { 'Name': 'string', 'Arn': 'string' }, '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", "EmailMessage", "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. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the attachment reference. * **EmailMessage** *(dict) --* Information about the reference when the referenceType is "EMAIL_MESSAGE". Otherwise, null. * **Name** *(string) --* The name of the email message reference * **Arn** *(string) --* The Amazon Resource Name (ARN) of the email message reference * **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 / ListInstanceAttributes ListInstanceAttributes ********************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE', '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 / ListTrafficDistributionGroups ListTrafficDistributionGroups ***************************** class 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' } ) Parameters: * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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', 'IsDefault': True|False }, ] } **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. * **IsDefault** *(boolean) --* Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the "DeleteTrafficDistributionGroup" API. The default traffic distribution group is deleted as part of the process for deleting a replica. Connect / Paginator / ListEvaluationForms ListEvaluationForms ******************* class Connect.Paginator.ListEvaluationForms paginator = client.get_paginator('list_evaluation_forms') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_evaluation_forms()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EvaluationFormSummaryList': [ { 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string', 'Title': 'string', 'CreatedTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': 'string', 'LastActivatedTime': datetime(2015, 1, 1), 'LastActivatedBy': 'string', 'LatestVersion': 123, 'ActiveVersion': 123 }, ], } **Response Structure** * *(dict) --* * **EvaluationFormSummaryList** *(list) --* Provides details about a list of evaluation forms belonging to an instance. * *(dict) --* Summary information about an evaluation form. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **Title** *(string) --* A title of the evaluation form. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation form was created. * **CreatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who created the evaluation form. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation form was last updated. * **LastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation form. * **LastActivatedTime** *(datetime) --* The timestamp for when the evaluation form was last activated. * **LastActivatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last activated the evaluation form. * **LatestVersion** *(integer) --* The version number of the latest evaluation form version. * **ActiveVersion** *(integer) --* The version of the active evaluation form version. Connect / Paginator / ListSecurityProfilePermissions ListSecurityProfilePermissions ****************************** class 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' } ) Parameters: * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Permissions': [ 'string', ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListUserHierarchyGroups ListUserHierarchyGroups *********************** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'UserHierarchyGroupSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / ListHoursOfOperationOverrides ListHoursOfOperationOverrides ***************************** class Connect.Paginator.ListHoursOfOperationOverrides paginator = client.get_paginator('list_hours_of_operation_overrides') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_hours_of_operation_overrides()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', HoursOfOperationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HoursOfOperationOverrideList': [ { 'HoursOfOperationOverrideId': 'string', 'HoursOfOperationId': 'string', 'HoursOfOperationArn': 'string', 'Name': 'string', 'Description': 'string', 'Config': [ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], 'EffectiveFrom': 'string', 'EffectiveTill': 'string' }, ], 'LastModifiedRegion': 'string', 'LastModifiedTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **HoursOfOperationOverrideList** *(list) --* Information about the hours of operation override. * *(dict) --* Information about the hours of operations override. * **HoursOfOperationOverrideId** *(string) --* The identifier for the hours of operation override. * **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 of the hours of operation override. * **Description** *(string) --* The description of the hours of operation override. * **Config** *(list) --* Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EffectiveFrom** *(string) --* The date from which the hours of operation override would be effective. * **EffectiveTill** *(string) --* The date till which the hours of operation override would be effective. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. Connect / Paginator / SearchUsers SearchUsers *********** class 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' } }, 'UserAttributeFilter': { 'OrConditions': [ { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, ], 'AndCondition': { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, 'TagCondition': { 'TagKey': 'string', 'TagValue': 'string' }, 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } } }, SearchCriteria={ 'OrConditions': [ {'... recursive ...'}, ], 'AndConditions': [ {'... recursive ...'}, ], 'StringCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' }, 'ListCondition': { 'TargetListType': 'PROFICIENCIES', 'Conditions': [ { 'StringCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' }, 'NumberCondition': { 'FieldName': 'string', 'MinValue': 123, 'MaxValue': 123, 'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE' } }, ] }, 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **UserAttributeFilter** *(dict) --* An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter. This accepts an "OR" of "AND" (List of List) input where: * The top level list specifies conditions that need to be applied with "OR" operator. * The inner list specifies conditions that need to be applied with "AND" operator. Note: Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **AndCondition** *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **SearchCriteria** (*dict*) -- The search criteria to be used to return users. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return users. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return users. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. The currently supported values for "FieldName" are "Username", "FirstName", "LastName", "RoutingProfileId", "SecurityProfileId", "ResourceId". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **ListCondition** *(dict) --* A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies. * **TargetListType** *(string) --* The type of target list that will be used to filter the users. * **Conditions** *(list) --* A list of Condition objects which would be applied together with an AND condition. * *(dict) --* A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name" and "value". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **NumberCondition** *(dict) --* A leaf node condition which can be used to specify a numeric condition. * **FieldName** *(string) --* The name of the field in the number condition. * **MinValue** *(integer) --* The minValue to be used while evaluating the number condition. * **MaxValue** *(integer) --* The maxValue to be used while evaluating the number condition. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the number condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. type PaginationConfig: dict param PaginationConfig: A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. rtype: dict returns: **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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. 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. * *(string) --* * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **Username** *(string) --* The name of the user. * **ApproximateTotalCount** *(integer) --* The total number of users who matched your search query. Connect / Paginator / SearchUserHierarchyGroups SearchUserHierarchyGroups ************************* class Connect.Paginator.SearchUserHierarchyGroups paginator = client.get_paginator('search_user_hierarchy_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_user_hierarchy_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', SearchFilter={ 'AttributeFilter': { 'OrConditions': [ { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, ], 'AndCondition': { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, '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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **AttributeFilter** *(dict) --* An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where: * The top level list specifies conditions that need to be applied with "OR" operator. * The inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **AndCondition** *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return UserHierarchyGroups. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return userHierarchyGroup. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return userHierarchyGroup. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "parentId", "levelId", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. type PaginationConfig: dict param PaginationConfig: A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. rtype: dict returns: **Response Syntax** { 'UserHierarchyGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LevelId': 'string', 'HierarchyPath': { 'LevelOne': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelTwo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelThree': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFour': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFive': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } }, 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **UserHierarchyGroups** *(list) --* Information about the userHierarchyGroups. * *(dict) --* Contains 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. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **ApproximateTotalCount** *(integer) --* The total number of userHierarchyGroups which matched your search query. Connect / Paginator / ListLexBots ListLexBots *********** class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListContactEvaluations ListContactEvaluations ********************** class Connect.Paginator.ListContactEvaluations paginator = client.get_paginator('list_contact_evaluations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_contact_evaluations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', ContactId='string', PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EvaluationSummaryList': [ { 'EvaluationId': 'string', 'EvaluationArn': 'string', 'EvaluationFormTitle': 'string', 'EvaluationFormId': 'string', 'Status': 'DRAFT'|'SUBMITTED', 'EvaluatorArn': 'string', 'Score': { 'Percentage': 123.0, 'NotApplicable': True|False, 'AutomaticFail': True|False }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **EvaluationSummaryList** *(list) --* Provides details about a list of contact evaluations belonging to an instance. * *(dict) --* Summary information about a contact evaluation. * **EvaluationId** *(string) --* A unique identifier for the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. * **EvaluationFormTitle** *(string) --* A title of the evaluation form. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **Status** *(string) --* The status of the contact evaluation. * **EvaluatorArn** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation. * **Score** *(dict) --* The overall score of the contact evaluation. * **Percentage** *(float) --* The score percentage for an item in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the item as not applicable for scoring. * **AutomaticFail** *(boolean) --* The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation was created. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation was last updated. Connect / Paginator / ListLambdaFunctions ListLambdaFunctions ******************* class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LambdaFunctions': [ 'string', ], } **Response Structure** * *(dict) --* * **LambdaFunctions** *(list) --* The Lambdafunction ARNs associated with the specified instance. * *(string) --* Connect / Paginator / ListRoutingProfiles ListRoutingProfiles ******************* class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RoutingProfileSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. Connect / Paginator / SearchQueues SearchQueues ************ class 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return queues. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return queues. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return queues. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **QueueTypeCondition** *(string) --* The type of queue. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Queues': [ { 'Name': 'string', 'QueueArn': 'string', 'QueueId': 'string', 'Description': 'string', 'OutboundCallerConfig': { 'OutboundCallerIdName': 'string', 'OutboundCallerIdNumberId': 'string', 'OutboundFlowId': 'string' }, 'OutboundEmailConfig': { 'OutboundEmailAddressId': 'string' }, 'HoursOfOperationId': 'string', 'MaxContacts': 123, 'Status': 'ENABLED'|'DISABLED', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **OutboundEmailConfig** *(dict) --* The outbound email address ID for a specified queue. * **OutboundEmailAddressId** *(string) --* The identifier of the email address. * **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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **ApproximateTotalCount** *(integer) --* The total number of queues which matched your search query. Connect / Paginator / SearchContactFlowModules SearchContactFlowModules ************************ class Connect.Paginator.SearchContactFlowModules paginator = client.get_paginator('search_contact_flow_modules') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_contact_flow_modules()". 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' }, 'StateCondition': 'ACTIVE'|'ARCHIVED', 'StatusCondition': 'PUBLISHED'|'SAVED' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return flow modules. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return flow modules. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return flow modules. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **StateCondition** *(string) --* The state of the flow. * **StatusCondition** *(string) --* The status of the flow. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ContactFlowModules': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Content': 'string', 'Description': 'string', 'State': 'ACTIVE'|'ARCHIVED', 'Status': 'PUBLISHED'|'SAVED', 'Tags': { 'string': 'string' } }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **ContactFlowModules** *(list) --* The search criteria to be used to return flow modules. * *(dict) --* Contains information about a 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 JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. * **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"} }. * *(string) --* * *(string) --* * **ApproximateTotalCount** *(integer) --* The total number of flows which matched your search query. Connect / Paginator / ListRules ListRules ********* class Connect.Paginator.ListRules paginator = client.get_paginator('list_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.list_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', PublishStatus='DRAFT'|'PUBLISHED', EventSourceName='OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PublishStatus** (*string*) -- The publish status of the rule. * **EventSourceName** (*string*) -- The name of the event source. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RuleSummaryList': [ { 'Name': 'string', 'RuleId': 'string', 'RuleArn': 'string', 'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach', 'PublishStatus': 'DRAFT'|'PUBLISHED', 'ActionSummaries': [ { 'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION' }, ], 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **RuleSummaryList** *(list) --* Summary information about a rule. * *(dict) --* A list of "ActionTypes" associated with a rule. * **Name** *(string) --* The name of the rule. * **RuleId** *(string) --* A unique identifier for the rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **EventSourceName** *(string) --* The name of the event source. * **PublishStatus** *(string) --* The publish status of the rule. * **ActionSummaries** *(list) --* A list of ActionTypes associated with a rule. * *(dict) --* Information about an action. * **ActionType** *(string) --* The action type. * **CreatedTime** *(datetime) --* The timestamp for when the rule was created. * **LastUpdatedTime** *(datetime) --* The timestamp for when the rule was last updated. Connect / Paginator / SearchResourceTags SearchResourceTags ****************** class Connect.Paginator.SearchResourceTags paginator = client.get_paginator('search_resource_tags') paginate(**kwargs) Creates an iterator that will paginate through responses from "Connect.Client.search_resource_tags()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceId='string', ResourceTypes=[ 'string', ], SearchCriteria={ 'TagSearchCondition': { 'tagKey': 'string', 'tagValue': 'string', 'tagKeyComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT', 'tagValueComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance. * **ResourceTypes** (*list*) -- The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required. **Supported resource types** * agent * agent-state * routing-profile * standard-queue * security-profile * operating-hours * prompt * contact-flow * flow- module * transfer-destination (also known as quick connect) * *(string) --* * **SearchCriteria** (*dict*) -- The search criteria to be used to return tags. * **TagSearchCondition** *(dict) --* The search criteria to be used to return tags. * **tagKey** *(string) --* The tag key used in the tag search condition. * **tagValue** *(string) --* The tag value used in the tag search condition. * **tagKeyComparisonType** *(string) --* The type of comparison to be made when evaluating the tag key in tag search condition. * **tagValueComparisonType** *(string) --* The type of comparison to be made when evaluating the tag value in tag search condition. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'key': 'string', 'value': 'string' }, ], } **Response Structure** * *(dict) --* * **Tags** *(list) --* A list of tags used in the Amazon Connect instance. * *(dict) --* A tag set contains tag key and tag value. * **key** *(string) --* The tag key in the TagSet. * **value** *(string) --* The tag value in the tagSet. Connect / Client / get_task_template get_task_template ***************** Connect.Client.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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **TaskTemplateId** (*string*) -- **[REQUIRED]** A unique identifier for the task template. * **SnapshotVersion** (*string*) -- The system generated version of a task template that is associated with a task, when the task is created. Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Description': 'string', 'ContactFlowId': 'string', 'SelfAssignFlowId': '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'|'SELF_ASSIGN'|'EXPIRY_DURATION', '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 instance ID in the Amazon Resource Name (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. * **SelfAssignFlowId** *(string) --* The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task. * **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. * *(string) --* * **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"} }. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_attached_file delete_attached_file ******************** Connect.Client.delete_attached_file(**kwargs) Deletes an attached file along with the underlying S3 Object. Warning: The attached file is **permanently deleted** if S3 bucket versioning is not enabled. See also: AWS API Documentation **Request Syntax** response = client.delete_attached_file( InstanceId='string', FileId='string', AssociatedResourceArn='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Connect instance. * **FileId** (*string*) -- **[REQUIRED]** The unique identifier of the attached file resource. * **AssociatedResourceArn** (*string*) -- **[REQUIRED]** The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. Note: This value must be a valid ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Response from DeleteAttachedFile API **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_queue describe_queue ************** Connect.Client.describe_queue(**kwargs) Describes the specified queue. See also: AWS API Documentation **Request Syntax** response = client.describe_queue( InstanceId='string', QueueId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. Return type: dict Returns: **Response Syntax** { 'Queue': { 'Name': 'string', 'QueueArn': 'string', 'QueueId': 'string', 'Description': 'string', 'OutboundCallerConfig': { 'OutboundCallerIdName': 'string', 'OutboundCallerIdNumberId': 'string', 'OutboundFlowId': 'string' }, 'OutboundEmailConfig': { 'OutboundEmailAddressId': 'string' }, 'HoursOfOperationId': 'string', 'MaxContacts': 123, 'Status': 'ENABLED'|'DISABLED', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **OutboundEmailConfig** *(dict) --* The outbound email address ID for a specified queue. * **OutboundEmailAddressId** *(string) --* The identifier of the email address. * **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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_security_profile create_security_profile *********************** Connect.Client.create_security_profile(**kwargs) Creates a security profile. For information about security profiles, see Security Profiles in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. See also: AWS API Documentation **Request Syntax** response = client.create_security_profile( SecurityProfileName='string', Description='string', Permissions=[ 'string', ], InstanceId='string', Tags={ 'string': 'string' }, AllowedAccessControlTags={ 'string': 'string' }, TagRestrictedResources=[ 'string', ], Applications=[ { 'Namespace': 'string', 'ApplicationPermissions': [ 'string', ] }, ], HierarchyRestrictedResources=[ 'string', ], AllowedAccessControlHierarchyGroupId='string' ) Parameters: * **SecurityProfileName** (*string*) -- **[REQUIRED]** The name of the security profile. * **Description** (*string*) -- The description of the security profile. * **Permissions** (*list*) -- Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions. * *(string) --* * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **AllowedAccessControlTags** (*dict*) -- The list of tags that a security profile uses to restrict access to resources in Amazon Connect. * *(string) --* * *(string) --* * **TagRestrictedResources** (*list*) -- The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see Add tags to resources in Amazon Connect in the *Amazon Connect Administrator Guide*. * *(string) --* * **Applications** (*list*) -- A list of third-party applications that the security profile will give access to. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. A third-party application's metadata. * **Namespace** *(string) --* Namespace of the application that you want to give access to. * **ApplicationPermissions** *(list) --* The permissions that the agent is granted on the application. Only the "ACCESS" permission is supported. * *(string) --* * **HierarchyRestrictedResources** (*list*) -- The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: "User". * *(string) --* * **AllowedAccessControlHierarchyGroupId** (*string*) -- The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_phone_numbers list_phone_numbers ****************** Connect.Client.list_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: * We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types "UIFN", "SHARED", "THIRD_PARTY_TF", and "THIRD_PARTY_DID". While it returns numbers of those types, it incorrectly lists them as "TOLL_FREE" or "DID". * 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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', ], 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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PhoneNumberTypes** (*list*) -- The type of phone number. Note: We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types "UIFN", "SHARED", "THIRD_PARTY_TF", and "THIRD_PARTY_DID", it incorrectly lists them as "TOLL_FREE" or "DID". * *(string) --* * **PhoneNumberCountryCodes** (*list*) -- The ISO country code. * *(string) --* * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'PhoneNumberSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'PhoneNumber': 'string', 'PhoneNumberType': 'TOLL_FREE'|'DID'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', '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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / put_user_status put_user_status *************** Connect.Client.put_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' ) Parameters: * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AgentStatusId** (*string*) -- **[REQUIRED]** The identifier of the agent status. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / batch_associate_analytics_data_set batch_associate_analytics_data_set ********************************** Connect.Client.batch_associate_analytics_data_set(**kwargs) Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call. See also: AWS API Documentation **Request Syntax** response = client.batch_associate_analytics_data_set( InstanceId='string', DataSetIds=[ 'string', ], TargetAccountId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **DataSetIds** (*list*) -- **[REQUIRED]** An array of dataset identifiers to associate. * *(string) --* * **TargetAccountId** (*string*) -- The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance. Return type: dict Returns: **Response Syntax** { 'Created': [ { 'DataSetId': 'string', 'TargetAccountId': 'string', 'ResourceShareId': 'string', 'ResourceShareArn': 'string', 'ResourceShareStatus': 'string' }, ], 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **Created** *(list) --* Information about associations that are successfully created: "DataSetId", "TargetAccountId", "ResourceShareId", "ResourceShareArn". * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. Information about associations that are successfully created: "DataSetId", "TargetAccountId", "ResourceShareId", "ResourceShareArn". * **DataSetId** *(string) --* The identifier of the dataset. * **TargetAccountId** *(string) --* The identifier of the target account. * **ResourceShareId** *(string) --* The Resource Access Manager share ID. * **ResourceShareArn** *(string) --* The Amazon Resource Name (ARN) of the Resource Access Manager share. * **ResourceShareStatus** *(string) --* The Amazon Web Services Resource Access Manager status of association. * **Errors** *(list) --* A list of errors for datasets that aren't successfully associated with the target account. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. List of errors for dataset association failures. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The corresponding error message for the error code. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_security_profile update_security_profile *********************** Connect.Client.update_security_profile(**kwargs) Updates a security profile. For information about security profiles, see Security Profiles in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. See also: AWS API Documentation **Request Syntax** response = client.update_security_profile( Description='string', Permissions=[ 'string', ], SecurityProfileId='string', InstanceId='string', AllowedAccessControlTags={ 'string': 'string' }, TagRestrictedResources=[ 'string', ], Applications=[ { 'Namespace': 'string', 'ApplicationPermissions': [ 'string', ] }, ], HierarchyRestrictedResources=[ 'string', ], AllowedAccessControlHierarchyGroupId='string' ) Parameters: * **Description** (*string*) -- The description of the security profile. * **Permissions** (*list*) -- The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions. * *(string) --* * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AllowedAccessControlTags** (*dict*) -- The list of tags that a security profile uses to restrict access to resources in Amazon Connect. * *(string) --* * *(string) --* * **TagRestrictedResources** (*list*) -- The list of resources that a security profile applies tag restrictions to in Amazon Connect. * *(string) --* * **Applications** (*list*) -- A list of the third-party application's metadata. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. A third-party application's metadata. * **Namespace** *(string) --* Namespace of the application that you want to give access to. * **ApplicationPermissions** *(list) --* The permissions that the agent is granted on the application. Only the "ACCESS" permission is supported. * *(string) --* * **HierarchyRestrictedResources** (*list*) -- The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: "User". * *(string) --* * **AllowedAccessControlHierarchyGroupId** (*string*) -- The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_contact_references list_contact_references *********************** Connect.Client.list_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. *References* are links to documents that are related to a contact, such as emails, attachments, or URLs. See also: AWS API Documentation **Request Syntax** response = client.list_contact_references( InstanceId='string', ContactId='string', ReferenceTypes=[ 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', ], NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the initial contact. * **ReferenceTypes** (*list*) -- **[REQUIRED]** The type of reference. * *(string) --* * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Warning: This is not expected to be set, because the value returned in the previous response is always null. Return type: dict Returns: **Response Syntax** { 'ReferenceSummaryList': [ { 'Url': { 'Name': 'string', 'Value': 'string' }, 'Attachment': { 'Name': 'string', 'Value': 'string', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string' }, 'EmailMessage': { 'Name': 'string', 'Arn': 'string' }, '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", "EmailMessage", "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. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the attachment reference. * **EmailMessage** *(dict) --* Information about the reference when the referenceType is "EMAIL_MESSAGE". Otherwise, null. * **Name** *(string) --* The name of the email message reference * **Arn** *(string) --* The Amazon Resource Name (ARN) of the email message reference * **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / search_agent_statuses search_agent_statuses ********************* Connect.Client.search_agent_statuses(**kwargs) Searches AgentStatuses in an Amazon Connect instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_agent_statuses( InstanceId='string', NextToken='string', MaxResults=123, SearchFilter={ 'AttributeFilter': { 'OrConditions': [ { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, ], 'AndCondition': { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, 'TagCondition': { 'TagKey': 'string', 'TagValue': 'string' } } }, SearchCriteria={ 'OrConditions': [ {'... recursive ...'}, ], 'AndConditions': [ {'... recursive ...'}, ], 'StringCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' } } ) type InstanceId: string param InstanceId: **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. type NextToken: string param NextToken: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. type MaxResults: integer param MaxResults: The maximum number of results to return per page. type SearchFilter: dict param SearchFilter: Filters to be applied to search results. * **AttributeFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * The top level list specifies conditions that need to be applied with "OR" operator. * The inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **AndCondition** *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. type SearchCriteria: dict param SearchCriteria: The search criteria to be used to return agent statuses. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return agent statuses. * **AndConditions** *(list) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", "state", "type", "displayOrder", and "resourceID". * *(dict) --* The search criteria to be used to return agent statuses. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", "state", "type", "displayOrder", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. rtype: dict returns: **Response Syntax** { 'AgentStatuses': [ { 'AgentStatusARN': 'string', 'AgentStatusId': 'string', 'Name': 'string', 'Description': 'string', 'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE', 'DisplayOrder': 123, 'State': 'ENABLED'|'DISABLED', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **AgentStatuses** *(list) --* The search criteria to be used to return agent statuses. * *(dict) --* Contains information about an 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of agent statuses which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_contact update_contact ************** Connect.Client.update_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'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } }, SegmentAttributes={ 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } }, QueueInfo={ 'Id': 'string' }, UserInfo={ 'UserId': 'string' }, CustomerEndpoint={ 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string' }, SystemEndpoint={ 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center. * **Name** (*string*) -- The name of the contact. * **Description** (*string*) -- The description of the contact. * **References** (*dict*) -- Well-formed data on contact, shown to agents on Contact Control Panel (CCP). * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **SegmentAttributes** (*dict*) -- A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows. Attribute keys can include only alphanumeric, -, and _. This field can be used to show channel subtype, such as "connect:Guide". Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. * **QueueInfo** (*dict*) -- Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the *Amazon Connect Administrator Guide*. * **Id** *(string) --* The identifier of the queue. * **UserInfo** (*dict*) -- Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the *Amazon Connect Administrator Guide*. * **UserId** *(string) --* The user identifier for the contact. * **CustomerEndpoint** (*dict*) -- The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the *Amazon Connect Administrator Guide*. * **Type** *(string) --* Type of the endpoint. * **Address** *(string) --* Address of the endpoint. * **SystemEndpoint** (*dict*) -- External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the *Amazon Connect Administrator Guide*. * **Type** *(string) --* Type of the endpoint. * **Address** *(string) --* Address of the endpoint. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ConflictException" Connect / Client / get_paginator get_paginator ************* Connect.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Connect / Client / search_available_phone_numbers search_available_phone_numbers ****************************** Connect.Client.search_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', InstanceId='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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', PhoneNumberPrefix='string', MaxResults=123, NextToken='string' ) Parameters: * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter "InstanceId" or "TargetArn". * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter "InstanceId" or "TargetArn". * **PhoneNumberCountryCode** (*string*) -- **[REQUIRED]** The ISO country code. * **PhoneNumberType** (*string*) -- **[REQUIRED]** The type of phone number. * **PhoneNumberPrefix** (*string*) -- The prefix of the phone number. If provided, it must contain "+" as part of the country code. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE' }, ] } **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.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / update_quick_connect_name update_quick_connect_name ************************* Connect.Client.update_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QuickConnectId** (*string*) -- **[REQUIRED]** The identifier for the quick connect. * **Name** (*string*) -- The name of the quick connect. * **Description** (*string*) -- The description of the quick connect. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_traffic_distribution update_traffic_distribution *************************** Connect.Client.update_traffic_distribution(**kwargs) Updates the traffic distribution for a given traffic distribution group. Warning: When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls. Note: The "SignInConfig" distribution is available only on a default "TrafficDistributionGroup" (see the "IsDefault" parameter in the TrafficDistributionGroup data type). If you call "UpdateTrafficDistribution" with a modified "SignInConfig" and a non-default "TrafficDistributionGroup", an "InvalidRequestException" is returned. 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 }, ] }, SignInConfig={ 'Distributions': [ { 'Region': 'string', 'Enabled': True|False }, ] }, AgentConfig={ 'Distributions': [ { 'Region': 'string', 'Percentage': 123 }, ] } ) Parameters: * **Id** (*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. * **TelephonyConfig** (*dict*) -- The distribution of traffic between the instance and its replica(s). * **Distributions** *(list) --* **[REQUIRED]** Information about traffic distributions. * *(dict) --* Information about a traffic distribution. * **Region** *(string) --* **[REQUIRED]** The Amazon Web Services Region where the traffic is distributed. * **Percentage** *(integer) --* **[REQUIRED]** The percentage of the traffic that is distributed, in increments of 10. * **SignInConfig** (*dict*) -- The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s). * **Distributions** *(list) --* **[REQUIRED]** Information about traffic distributions. * *(dict) --* The distribution of sign in traffic between the instance and its replica(s). * **Region** *(string) --* **[REQUIRED]** The Amazon Web Services Region of the sign in distribution. * **Enabled** *(boolean) --* **[REQUIRED]** Whether sign in distribution is enabled. * **AgentConfig** (*dict*) -- The distribution of agents between the instance and its replica(s). * **Distributions** *(list) --* **[REQUIRED]** Information about traffic distributions. * *(dict) --* Information about a traffic distribution. * **Region** *(string) --* **[REQUIRED]** The Amazon Web Services Region where the traffic is distributed. * **Percentage** *(integer) --* **[REQUIRED]** The percentage of the traffic that is distributed, in increments of 10. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_contact_flow_version create_contact_flow_version *************************** Connect.Client.create_contact_flow_version(**kwargs) Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the "FlowContentSha256" provided is different from the "FlowContentSha256" of the "$LATEST" published flow content, then an error is returned. This API only supports creating versions for flows of type "Campaign". See also: AWS API Documentation **Request Syntax** response = client.create_contact_flow_version( InstanceId='string', Description='string', ContactFlowId='string', FlowContentSha256='string', ContactFlowVersion=123, LastModifiedTime=datetime(2015, 1, 1), LastModifiedRegion='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **Description** (*string*) -- The description of the flow version. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **FlowContentSha256** (*string*) -- Indicates the checksum value of the flow content. * **ContactFlowVersion** (*integer*) -- The identifier of the flow version. * **LastModifiedTime** (*datetime*) -- The Amazon Web Services Region where this resource was last modified. * **LastModifiedRegion** (*string*) -- The Amazon Web Services Region where this resource was last modified. Return type: dict Returns: **Response Syntax** { 'ContactFlowArn': 'string', 'Version': 123 } **Response Structure** * *(dict) --* * **ContactFlowArn** *(string) --* The Amazon Resource Name (ARN) of the flow. * **Version** *(integer) --* The identifier of the flow version. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / get_flow_association get_flow_association ******************** Connect.Client.get_flow_association(**kwargs) Retrieves the flow associated for a given resource. See also: AWS API Documentation **Request Syntax** response = client.get_flow_association( InstanceId='string', ResourceId='string', ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceId** (*string*) -- **[REQUIRED]** The identifier of the resource. * Amazon Web Services End User Messaging SMS phone number ARN when using "SMS_PHONE_NUMBER" * Amazon Web Services End User Messaging Social phone number ARN when using "WHATSAPP_MESSAGING_PHONE_NUMBER" * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. Return type: dict Returns: **Response Syntax** { 'ResourceId': 'string', 'FlowId': 'string', 'ResourceType': 'SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER' } **Response Structure** * *(dict) --* * **ResourceId** *(string) --* The identifier of the resource. * **FlowId** *(string) --* The identifier of the flow. * **ResourceType** *(string) --* A valid resource type. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / get_contact_metrics get_contact_metrics ******************* Connect.Client.get_contact_metrics(**kwargs) Gets the real-time metrics of the specified contact. **Use cases** Following are common uses cases for this API: * You can use this API to retrieve the position of the contact in the queue. **Endpoints**: See Amazon Connect endpoints and quotas. See also: AWS API Documentation **Request Syntax** response = client.get_contact_metrics( InstanceId='string', ContactId='string', Metrics=[ { 'Name': 'POSITION_IN_QUEUE' }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **Metrics** (*list*) -- **[REQUIRED]** A list of contact-level metrics to retrieve. * *(dict) --* The object that contains information about metric being requested. * **Name** *(string) --* **[REQUIRED]** The name of the metric being retrieved in type String. Return type: dict Returns: **Response Syntax** { 'MetricResults': [ { 'Name': 'POSITION_IN_QUEUE', 'Value': { 'Number': 123.0 } }, ], 'Id': 'string', 'Arn': 'string' } **Response Structure** * *(dict) --* * **MetricResults** *(list) --* A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding calculated value. * *(dict) --* Object containing information about metric requested for the contact. * **Name** *(string) --* The name of the metric being retrieved in type String. * **Value** *(dict) --* Object result associated with the metric received. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Number". 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'} * **Number** *(float) --* The number of type Double. This number is the contact's position in queue. * **Id** *(string) --* The unique identifier of the contact for which metrics were retrieved. * **Arn** *(string) --* The ARN of the contact for which metrics were retrieved. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_users search_users ************ Connect.Client.search_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' } }, 'UserAttributeFilter': { 'OrConditions': [ { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, ], 'AndCondition': { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, 'TagCondition': { 'TagKey': 'string', 'TagValue': 'string' }, 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } } }, SearchCriteria={ 'OrConditions': [ {'... recursive ...'}, ], 'AndConditions': [ {'... recursive ...'}, ], 'StringCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' }, 'ListCondition': { 'TargetListType': 'PROFICIENCIES', 'Conditions': [ { 'StringCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' }, 'NumberCondition': { 'FieldName': 'string', 'MinValue': 123, 'MaxValue': 123, 'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE' } }, ] }, 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } } ) type InstanceId: string param InstanceId: **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. type NextToken: string param NextToken: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. type MaxResults: integer param MaxResults: The maximum number of results to return per page. type SearchFilter: dict param SearchFilter: Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **UserAttributeFilter** *(dict) --* An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter. This accepts an "OR" of "AND" (List of List) input where: * The top level list specifies conditions that need to be applied with "OR" operator. * The inner list specifies conditions that need to be applied with "AND" operator. Note: Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **AndCondition** *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. type SearchCriteria: dict param SearchCriteria: The search criteria to be used to return users. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return users. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return users. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. The currently supported values for "FieldName" are "Username", "FirstName", "LastName", "RoutingProfileId", "SecurityProfileId", "ResourceId". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **ListCondition** *(dict) --* A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies. * **TargetListType** *(string) --* The type of target list that will be used to filter the users. * **Conditions** *(list) --* A list of Condition objects which would be applied together with an AND condition. * *(dict) --* A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and ProficiencyLimit. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name" and "value". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **NumberCondition** *(dict) --* A leaf node condition which can be used to specify a numeric condition. * **FieldName** *(string) --* The name of the field in the number condition. * **MinValue** *(integer) --* The minValue to be used while evaluating the number condition. * **MaxValue** *(integer) --* The maxValue to be used while evaluating the number condition. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the number condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. rtype: dict returns: **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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. 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. * *(string) --* * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_phone_number_contact_flow associate_phone_number_contact_flow *********************************** Connect.Client.associate_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' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** A unique identifier for the phone number. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / create_evaluation_form create_evaluation_form ********************** Connect.Client.create_evaluation_form(**kwargs) Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form. See also: AWS API Documentation **Request Syntax** response = client.create_evaluation_form( InstanceId='string', Title='string', Description='string', Items=[ { 'Section': { 'Title': 'string', 'RefId': 'string', 'Instructions': 'string', 'Items': {'... recursive ...'}, 'Weight': 123.0 }, 'Question': { 'Title': 'string', 'Instructions': 'string', 'RefId': 'string', 'NotApplicableEnabled': True|False, 'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC', 'QuestionTypeProperties': { 'Numeric': { 'MinValue': 123, 'MaxValue': 123, 'Options': [ { 'MinValue': 123, 'MaxValue': 123, 'Score': 123, 'AutomaticFail': True|False }, ], 'Automation': { 'PropertyValue': { 'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME' } } }, 'SingleSelect': { 'Options': [ { 'RefId': 'string', 'Text': 'string', 'Score': 123, 'AutomaticFail': True|False }, ], 'DisplayAs': 'DROPDOWN'|'RADIO', 'Automation': { 'Options': [ { 'RuleCategory': { 'Category': 'string', 'Condition': 'PRESENT'|'NOT_PRESENT', 'OptionRefId': 'string' } }, ], 'DefaultOptionRefId': 'string' } } }, 'Weight': 123.0 } }, ], ScoringStrategy={ 'Mode': 'QUESTION_ONLY'|'SECTION_ONLY', 'Status': 'ENABLED'|'DISABLED' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Title** (*string*) -- **[REQUIRED]** A title of the evaluation form. * **Description** (*string*) -- The description of the evaluation form. * **Items** (*list*) -- **[REQUIRED]** Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. * *(dict) --* Information about an item from an evaluation form. The item must be either a section or a question. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Section", "Question". * **Section** *(dict) --* The information of the section. * **Title** *(string) --* **[REQUIRED]** The title of the section. * **RefId** *(string) --* **[REQUIRED]** The identifier of the section. An identifier must be unique within the evaluation form. * **Instructions** *(string) --* The instructions of the section. * **Items** *(list) --* The items of the section. * **Weight** *(float) --* The scoring weight of the section. * **Question** *(dict) --* The information of the question. * **Title** *(string) --* **[REQUIRED]** The title of the question. * **Instructions** *(string) --* The instructions of the section. * **RefId** *(string) --* **[REQUIRED]** The identifier of the question. An identifier must be unique within the evaluation form. * **NotApplicableEnabled** *(boolean) --* The flag to enable not applicable answers to the question. * **QuestionType** *(string) --* **[REQUIRED]** The type of the question. * **QuestionTypeProperties** *(dict) --* The properties of the type of question. Text questions do not have to define question type properties. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Numeric", "SingleSelect". * **Numeric** *(dict) --* The properties of the numeric question. * **MinValue** *(integer) --* **[REQUIRED]** The minimum answer value. * **MaxValue** *(integer) --* **[REQUIRED]** The maximum answer value. * **Options** *(list) --* The scoring options of the numeric question. * *(dict) --* Information about the option range used for scoring in numeric questions. * **MinValue** *(integer) --* **[REQUIRED]** The minimum answer value of the range option. * **MaxValue** *(integer) --* **[REQUIRED]** The maximum answer value of the range option. * **Score** *(integer) --* The score assigned to answer values within the range option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **Automation** *(dict) --* The automation properties of the numeric question. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PropertyValue". * **PropertyValue** *(dict) --* The property value of the automation. * **Label** *(string) --* **[REQUIRED]** The property label of the automation. * **SingleSelect** *(dict) --* The properties of the numeric question. * **Options** *(list) --* **[REQUIRED]** The answer options of the single select question. * *(dict) --* Information about the automation configuration in single select questions. * **RefId** *(string) --* **[REQUIRED]** The identifier of the answer option. An identifier must be unique within the question. * **Text** *(string) --* **[REQUIRED]** The title of the answer option. * **Score** *(integer) --* The score assigned to the answer option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **DisplayAs** *(string) --* The display mode of the single select question. * **Automation** *(dict) --* The display mode of the single select question. * **Options** *(list) --* **[REQUIRED]** The automation options of the single select question. * *(dict) --* Information about the automation option of a single select question. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "RuleCategory". * **RuleCategory** *(dict) --* The automation option based on a rule category for the single select question. * **Category** *(string) --* **[REQUIRED]** The category name, as defined in Rules. * **Condition** *(string) --* **[REQUIRED]** The condition to apply for the automation option. If the condition is "PRESENT", then the option is applied when the contact data includes the category. Similarly, if the condition is "NOT_PRESENT", then the option is applied when the contact data does not include the category. * **OptionRefId** *(string) --* **[REQUIRED]** The identifier of the answer option. * **DefaultOptionRefId** *(string) --* The identifier of the default answer option, when none of the automation options match the criteria. * **Weight** *(float) --* The scoring weight of the section. * **ScoringStrategy** (*dict*) -- A scoring strategy of the evaluation form. * **Mode** *(string) --* **[REQUIRED]** The scoring mode of the evaluation form. * **Status** *(string) --* **[REQUIRED]** The scoring status of the evaluation form. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string' } **Response Structure** * *(dict) --* * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. **Exceptions** * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / update_phone_number_metadata update_phone_number_metadata **************************** Connect.Client.update_phone_number_metadata(**kwargs) Updates a phone number’s metadata. Warning: To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API. See also: AWS API Documentation **Request Syntax** response = client.update_phone_number_metadata( PhoneNumberId='string', PhoneNumberDescription='string', ClientToken='string' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) or resource ID of the phone number. * **PhoneNumberDescription** (*string*) -- The description of the phone number. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_contact_flow delete_contact_flow ******************* Connect.Client.delete_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_analytics_data_lake_data_sets list_analytics_data_lake_data_sets ********************************** Connect.Client.list_analytics_data_lake_data_sets(**kwargs) Lists the data lake datasets available to associate with for a given Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_analytics_data_lake_data_sets( InstanceId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'DataSetId': 'string', 'DataSetName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Results** *(list) --* An array of successful results: "DataSetId", "DataSetName". This is a paginated API, so "nextToken" is given if there are more results to be returned. * *(dict) --* Information about datasets that are available to associate with: "DataSetId", "DataSetName". * **DataSetId** *(string) --* The identifier of the dataset. * **DataSetName** *(string) --* The name of the dataset. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_quick_connect create_quick_connect ******************** Connect.Client.create_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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** A unique name of the quick connect. * **Description** (*string*) -- The description of the quick connect. * **QuickConnectConfig** (*dict*) -- **[REQUIRED]** Configuration settings for the quick connect. * **QuickConnectType** *(string) --* **[REQUIRED]** The type of quick connect. In the Amazon Connect admin website, 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) --* **[REQUIRED]** The identifier of the user. * **ContactFlowId** *(string) --* **[REQUIRED]** The identifier of the flow. * **QueueConfig** *(dict) --* The queue configuration. This is required only if QuickConnectType is QUEUE. * **QueueId** *(string) --* **[REQUIRED]** The identifier for the queue. * **ContactFlowId** *(string) --* **[REQUIRED]** The identifier of the flow. * **PhoneConfig** *(dict) --* The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER. * **PhoneNumber** *(string) --* **[REQUIRED]** 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"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_rule create_rule *********** Connect.Client.create_rule(**kwargs) Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule. See also: AWS API Documentation **Request Syntax** response = client.create_rule( InstanceId='string', Name='string', TriggerEventSource={ 'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach', 'IntegrationAssociationId': 'string' }, Function='string', Actions=[ { 'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION', 'TaskAction': { 'Name': 'string', 'Description': 'string', 'ContactFlowId': 'string', 'References': { 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } } }, 'EventBridgeAction': { 'Name': 'string' }, 'AssignContactCategoryAction': {} , 'SendNotificationAction': { 'DeliveryMethod': 'EMAIL', 'Subject': 'string', 'Content': 'string', 'ContentType': 'PLAIN_TEXT', 'Recipient': { 'UserTags': { 'string': 'string' }, 'UserIds': [ 'string', ] } }, 'CreateCaseAction': { 'Fields': [ { 'Id': 'string', 'Value': { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {} , 'StringValue': 'string' } }, ], 'TemplateId': 'string' }, 'UpdateCaseAction': { 'Fields': [ { 'Id': 'string', 'Value': { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {} , 'StringValue': 'string' } }, ] }, 'AssignSlaAction': { 'SlaAssignmentType': 'CASES', 'CaseSlaConfiguration': { 'Name': 'string', 'Type': 'CaseField', 'FieldId': 'string', 'TargetFieldValues': [ { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {} , 'StringValue': 'string' }, ], 'TargetSlaMinutes': 123 } }, 'EndAssociatedTasksAction': {} , 'SubmitAutoEvaluationAction': { 'EvaluationFormId': 'string' } }, ], PublishStatus='DRAFT'|'PUBLISHED', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** A unique name for the rule. * **TriggerEventSource** (*dict*) -- **[REQUIRED]** The event source to trigger the rule. * **EventSourceName** *(string) --* **[REQUIRED]** The name of the event source. * **IntegrationAssociationId** *(string) --* The identifier for the integration association. * **Function** (*string*) -- **[REQUIRED]** The conditions of the rule. * **Actions** (*list*) -- **[REQUIRED]** A list of actions to be run when the rule is triggered. * *(dict) --* Information about the action to be performed when a rule is triggered. * **ActionType** *(string) --* **[REQUIRED]** The type of action that creates a rule. * **TaskAction** *(dict) --* Information about the task action. This field is required if "TriggerEventSource" is one of the following values: "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **Name** *(string) --* **[REQUIRED]** The name. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **Description** *(string) --* The description. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **ContactFlowId** *(string) --* **[REQUIRED]** The identifier of the flow. * **References** *(dict) --* Information about the reference when the "referenceType" is "URL". Otherwise, null. (Supports variable injection in the "Value" field.) * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **EventBridgeAction** *(dict) --* Information about the EventBridge action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnContactEvaluationSubmit" | "OnMetricDataUpdate" * **Name** *(string) --* **[REQUIRED]** The name. * **AssignContactCategoryAction** *(dict) --* Information about the contact category action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **SendNotificationAction** *(dict) --* Information about the send notification action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnContactEvaluationSubmit" | "OnMetricDataUpdate" * **DeliveryMethod** *(string) --* **[REQUIRED]** Notification delivery method. * **Subject** *(string) --* The subject of the email if the delivery method is "EMAIL". Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **Content** *(string) --* **[REQUIRED]** Notification content. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **ContentType** *(string) --* **[REQUIRED]** Content type format. * **Recipient** *(dict) --* **[REQUIRED]** Notification recipient. * **UserTags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified. * *(string) --* * *(string) --* * **UserIds** *(list) --* A list of user IDs. Supports variable injection of "$.ContactLens.ContactEvaluation.Agent.AgentId" for "OnContactEvaluationSubmit" event source. * *(string) --* * **CreateCaseAction** *(dict) --* Information about the create case action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnPostChatAnalysisAvailable". * **Fields** *(list) --* **[REQUIRED]** An array of objects with "Field ID" and "Value" data. * *(dict) --* Object for case field values. * **Id** *(string) --* **[REQUIRED]** Unique identifier of a field. * **Value** *(dict) --* **[REQUIRED]** Union of potential field value types. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **TemplateId** *(string) --* **[REQUIRED]** A unique identifier of a template. * **UpdateCaseAction** *(dict) --* Information about the update case action. Supported only for "TriggerEventSource" values: "OnCaseCreate" | "OnCaseUpdate". * **Fields** *(list) --* **[REQUIRED]** An array of objects with "Field ID" and Value data. * *(dict) --* Object for case field values. * **Id** *(string) --* **[REQUIRED]** Unique identifier of a field. * **Value** *(dict) --* **[REQUIRED]** Union of potential field value types. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **AssignSlaAction** *(dict) --* Information about the assign SLA action. * **SlaAssignmentType** *(string) --* **[REQUIRED]** Type of SLA assignment. * **CaseSlaConfiguration** *(dict) --* The SLA configuration for Case SLA Assignment. * **Name** *(string) --* **[REQUIRED]** Name of an SLA. * **Type** *(string) --* **[REQUIRED]** Type of SLA for Case SlaAssignmentType. * **FieldId** *(string) --* Unique identifier of a Case field. * **TargetFieldValues** *(list) --* Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value. * *(dict) --* Object to store union of Field values. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **TargetSlaMinutes** *(integer) --* **[REQUIRED]** Target duration in minutes within which an SLA should be completed. * **EndAssociatedTasksAction** *(dict) --* Information about the end associated tasks action. Supported only for "TriggerEventSource" values: "OnCaseUpdate". * **SubmitAutoEvaluationAction** *(dict) --* Information about the submit automated evaluation action. * **EvaluationFormId** *(string) --* **[REQUIRED]** The identifier of the auto-evaluation enabled form. * **PublishStatus** (*string*) -- **[REQUIRED]** The publish status of the rule. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'RuleArn': 'string', 'RuleId': 'string' } **Response Structure** * *(dict) --* * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **RuleId** *(string) --* A unique identifier for the rule. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.ServiceQuotaExceededException" Connect / Client / associate_routing_profile_queues associate_routing_profile_queues ******************************** Connect.Client.associate_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'|'EMAIL' }, 'Priority': 123, 'Delay': 123 }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **QueueConfigs** (*list*) -- **[REQUIRED]** The queues to associate with this routing profile. * *(dict) --* Contains information about the queue and channel for which priority and delay can be set. * **QueueReference** *(dict) --* **[REQUIRED]** Contains information about a queue resource. * **QueueId** *(string) --* **[REQUIRED]** The identifier for the queue. * **Channel** *(string) --* **[REQUIRED]** The channels agents can handle in the Contact Control Panel (CCP) for this routing profile. * **Priority** *(integer) --* **[REQUIRED]** The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay. * **Delay** *(integer) --* **[REQUIRED]** 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*. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_queue delete_queue ************ Connect.Client.delete_queue(**kwargs) Deletes a queue. See also: AWS API Documentation **Request Syntax** response = client.delete_queue( InstanceId='string', QueueId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_predefined_attribute create_predefined_attribute *************************** Connect.Client.create_predefined_attribute(**kwargs) Creates a new predefined attribute for the specified Amazon Connect instance. *Predefined attributes* are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. See also: AWS API Documentation **Request Syntax** response = client.create_predefined_attribute( InstanceId='string', Name='string', Values={ 'StringList': [ 'string', ] } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the predefined attribute. * **Values** (*dict*) -- **[REQUIRED]** The values of the predefined attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringList". * **StringList** *(list) --* Predefined attribute values of type string list. * *(string) --* Returns: None **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_email_contact start_email_contact ******************* Connect.Client.start_email_contact(**kwargs) Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created. See also: AWS API Documentation **Request Syntax** response = client.start_email_contact( InstanceId='string', FromEmailAddress={ 'EmailAddress': 'string', 'DisplayName': 'string' }, DestinationEmailAddress='string', Description='string', References={ 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } }, Name='string', EmailMessage={ 'MessageSourceType': 'RAW', 'RawMessage': { 'Subject': 'string', 'Body': 'string', 'ContentType': 'string', 'Headers': { 'string': 'string' } } }, AdditionalRecipients={ 'ToAddresses': [ { 'EmailAddress': 'string', 'DisplayName': 'string' }, ], 'CcAddresses': [ { 'EmailAddress': 'string', 'DisplayName': 'string' }, ] }, Attachments=[ { 'FileName': 'string', 'S3Url': 'string' }, ], ContactFlowId='string', RelatedContactId='string', Attributes={ 'string': 'string' }, SegmentAttributes={ 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **FromEmailAddress** (*dict*) -- **[REQUIRED]** The email address of the customer. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **DestinationEmailAddress** (*string*) -- **[REQUIRED]** The email address associated with the Amazon Connect instance. * **Description** (*string*) -- A description of the email contact. * **References** (*dict*) -- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: "URL" | "NUMBER" | "STRING" | "DATE". "EMAIL" | "EMAIL_MESSAGE" | "ATTACHMENT" are not a supported reference type during email creation. * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **Name** (*string*) -- The name of a email that is shown to an agent in the Contact Control Panel (CCP). * **EmailMessage** (*dict*) -- **[REQUIRED]** The email message body to be sent to the newly created email. * **MessageSourceType** *(string) --* **[REQUIRED]** The message source type, that is, "RAW". * **RawMessage** *(dict) --* The raw email body content. * **Subject** *(string) --* **[REQUIRED]** The email subject. * **Body** *(string) --* **[REQUIRED]** The email message body. * **ContentType** *(string) --* **[REQUIRED]** Type of content, that is, "text/plain" or "text/html". * **Headers** *(dict) --* Headers present in inbound email. * *(string) --* * *(string) --* * **AdditionalRecipients** (*dict*) -- The additional recipients address of the email. * **ToAddresses** *(list) --* The **additional** recipients information present in to list. You must have 1 required recipient ( "DestinationEmailAddress"). You can then specify up to 49 additional recipients (across "ToAddresses" and "CcAddresses"), for a total of 50 recipients. * *(dict) --* Contains information about a source or destination email address. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **CcAddresses** *(list) --* The **additional** recipients information present in cc list. You must have 1 required recipient ( "DestinationEmailAddress"). You can then specify up to 49 additional recipients (across "ToAddresses" and "CcAddresses"), for a total of 50 recipients. * *(dict) --* Contains information about a source or destination email address. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **Attachments** (*list*) -- List of S3 presigned URLs of email attachments and their file name. * *(dict) --* Information about the email attachment files. * **FileName** *(string) --* **[REQUIRED]** A case-sensitive name of the attached file being uploaded. * **S3Url** *(string) --* **[REQUIRED]** The pre-signed URLs for the S3 bucket where the email attachment is stored. * **ContactFlowId** (*string*) -- The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **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** * **RelatedContactId** (*string*) -- The contactId that is related to this contact. Linking emails together by using "RelatedContactID" copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using "RelatedContactId". * **Attributes** (*dict*) -- 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. * *(string) --* * *(string) --* * **SegmentAttributes** (*dict*) -- A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows. Attribute keys can include only alphanumeric, -, and _. This field can be used to show channel subtype, such as "connect:Guide". Note: To set contact expiry, a "ValueMap" must be specified containing the integer number of minutes the contact will be active for before expiring, with "SegmentAttributes" like { ""connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}". * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ContactId': 'string' } **Response Structure** * *(dict) --* * **ContactId** *(string) --* The identifier of this contact within the Amazon Connect instance. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" Connect / Client / can_paginate can_paginate ************ Connect.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. Connect / Client / list_predefined_attributes list_predefined_attributes ************************** Connect.Client.list_predefined_attributes(**kwargs) Lists predefined attributes for the specified Amazon Connect instance. *Predefined attributes* are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. See also: AWS API Documentation **Request Syntax** response = client.list_predefined_attributes( InstanceId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'PredefinedAttributeSummaryList': [ { 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **PredefinedAttributeSummaryList** *(list) --* Summary of the predefined attributes. * *(dict) --* Summary of a predefined attribute. * **Name** *(string) --* The name of the predefined attribute. * **LastModifiedTime** *(datetime) --* Last modified time. * **LastModifiedRegion** *(string) --* Last modified region. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_lambda_functions list_lambda_functions ********************* Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'LambdaFunctions': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LambdaFunctions** *(list) --* The Lambdafunction ARNs associated with the specified instance. * *(string) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / search_contacts search_contacts *************** Connect.Client.search_contacts(**kwargs) Searches contacts in an Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.search_contacts( InstanceId='string', TimeRange={ 'Type': 'INITIATION_TIMESTAMP'|'SCHEDULED_TIMESTAMP'|'CONNECTED_TO_AGENT_TIMESTAMP'|'DISCONNECT_TIMESTAMP', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, SearchCriteria={ 'AgentIds': [ 'string', ], 'AgentHierarchyGroups': { 'L1Ids': [ 'string', ], 'L2Ids': [ 'string', ], 'L3Ids': [ 'string', ], 'L4Ids': [ 'string', ], 'L5Ids': [ 'string', ] }, 'Channels': [ 'VOICE'|'CHAT'|'TASK'|'EMAIL', ], 'ContactAnalysis': { 'Transcript': { 'Criteria': [ { 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'SearchText': [ 'string', ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' }, ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' } }, 'InitiationMethods': [ 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', ], 'QueueIds': [ 'string', ], 'SearchableContactAttributes': { 'Criteria': [ { 'Key': 'string', 'Values': [ 'string', ] }, ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' }, 'SearchableSegmentAttributes': { 'Criteria': [ { 'Key': 'string', 'Values': [ 'string', ] }, ], 'MatchType': 'MATCH_ALL'|'MATCH_ANY' } }, MaxResults=123, NextToken='string', Sort={ 'FieldName': 'INITIATION_TIMESTAMP'|'SCHEDULED_TIMESTAMP'|'CONNECTED_TO_AGENT_TIMESTAMP'|'DISCONNECT_TIMESTAMP'|'INITIATION_METHOD'|'CHANNEL', 'Order': 'ASCENDING'|'DESCENDING' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **TimeRange** (*dict*) -- **[REQUIRED]** Time range that you want to search results. * **Type** *(string) --* **[REQUIRED]** The type of timestamp to search. * **StartTime** *(datetime) --* **[REQUIRED]** The start time of the time range. * **EndTime** *(datetime) --* **[REQUIRED]** The end time of the time range. * **SearchCriteria** (*dict*) -- The search criteria to be used to return contacts. * **AgentIds** *(list) --* The identifiers of agents who handled the contacts. * *(string) --* * **AgentHierarchyGroups** *(dict) --* The agent hierarchy groups of the agent at the time of handling the contact. * **L1Ids** *(list) --* The identifiers for level 1 hierarchy groups. * *(string) --* * **L2Ids** *(list) --* The identifiers for level 2 hierarchy groups. * *(string) --* * **L3Ids** *(list) --* The identifiers for level 3 hierarchy groups. * *(string) --* * **L4Ids** *(list) --* The identifiers for level 4 hierarchy groups. * *(string) --* * **L5Ids** *(list) --* The identifiers for level 5 hierarchy groups. * *(string) --* * **Channels** *(list) --* The list of channels associated with contacts. * *(string) --* * **ContactAnalysis** *(dict) --* Search criteria based on analysis outputs from Amazon Connect Contact Lens. * **Transcript** *(dict) --* Search criteria based on transcript analyzed by Amazon Connect Contact Lens. * **Criteria** *(list) --* **[REQUIRED]** The list of search criteria based on Contact Lens conversational analytics transcript. * *(dict) --* A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript. * **ParticipantRole** *(string) --* **[REQUIRED]** The participant role in a transcript * **SearchText** *(list) --* **[REQUIRED]** The words or phrases used to search within a transcript. * *(string) --* * **MatchType** *(string) --* **[REQUIRED]** The match type combining search criteria using multiple search texts in a transcript criteria. * **MatchType** *(string) --* The match type combining search criteria using multiple transcript criteria. * **InitiationMethods** *(list) --* The list of initiation methods associated with contacts. * *(string) --* * **QueueIds** *(list) --* The list of queue IDs associated with contacts. * *(string) --* * **SearchableContactAttributes** *(dict) --* The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the *Amazon Connect Administrator Guide*. Warning: To use "SearchableContactAttributes" in a search request, the "GetContactAttributes" action is required to perform an API request. For more information, see >>`<`__Actions defined by Amazon Connect. * **Criteria** *(list) --* **[REQUIRED]** The list of criteria based on user-defined contact attributes that are configured for contact search. * *(dict) --* The search criteria based on user-defined contact attribute key and values to search on. * **Key** *(string) --* **[REQUIRED]** The key containing a searchable user-defined contact attribute. * **Values** *(list) --* **[REQUIRED]** The list of values to search for within a user-defined contact attribute. * *(string) --* * **MatchType** *(string) --* The match type combining search criteria using multiple searchable contact attributes. * **SearchableSegmentAttributes** *(dict) --* The search criteria based on searchable segment attributes of a contact. * **Criteria** *(list) --* **[REQUIRED]** The list of criteria based on searchable segment attributes. * *(dict) --* The search criteria based on searchable segment attribute key and values to search on. * **Key** *(string) --* **[REQUIRED]** The key containing a searchable segment attribute. * **Values** *(list) --* **[REQUIRED]** The list of values to search for within a searchable segment attribute. * *(string) --* * **MatchType** *(string) --* The match type combining search criteria using multiple searchable segment attributes. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **Sort** (*dict*) -- Specifies a field to sort by and a sort order. * **FieldName** *(string) --* **[REQUIRED]** The name of the field on which to sort. * **Order** *(string) --* **[REQUIRED]** An ascending or descending sort. Return type: dict Returns: **Response Syntax** { 'Contacts': [ { 'Arn': 'string', 'Id': 'string', 'InitialContactId': 'string', 'PreviousContactId': 'string', 'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', '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), 'ScheduledTimestamp': datetime(2015, 1, 1), 'SegmentAttributes': { 'string': { 'ValueString': 'string' } } }, ], 'NextToken': 'string', 'TotalCount': 123 } **Response Structure** * *(dict) --* * **Contacts** *(list) --* Information about the contacts. * *(dict) --* Information of returned contact. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the contact. * **Id** *(string) --* The identifier of the contact summary. * **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. * **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. For "EXTERNAL_OUTBOUND", this is when the agent started dialing the external participant. For "MONITOR", this is when the supervisor started listening to a contact. * **DisconnectTimestamp** *(datetime) --* The timestamp when the customer endpoint disconnected from Amazon Connect. * **ScheduledTimestamp** *(datetime) --* The timestamp, in Unix epoch time format, at which to start running the inbound flow. * **SegmentAttributes** *(dict) --* Set of segment attributes for a contact. * *(string) --* * *(dict) --* The value of a segment attribute. This is structured as a map with a single key-value pair. The key 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value of the segment attribute. * **ValueString** *(string) --* The value of a segment attribute represented as a string. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **TotalCount** *(integer) --* The total number of contacts which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / search_prompts search_prompts ************** Connect.Client.search_prompts(**kwargs) Searches prompts in an Amazon Connect instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_prompts( 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' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return prompts. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return prompts. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return prompts. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. Return type: dict Returns: **Response Syntax** { 'Prompts': [ { 'PromptARN': 'string', 'PromptId': 'string', 'Name': 'string', 'Description': 'string', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **Prompts** *(list) --* Information about the prompts. * *(dict) --* Information about a prompt. * **PromptARN** *(string) --* The Amazon Resource Name (ARN) of the prompt. * **PromptId** *(string) --* A unique identifier for the prompt. * **Name** *(string) --* The name of the prompt. * **Description** *(string) --* The description of the prompt. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of quick connects which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_user_hierarchy_groups search_user_hierarchy_groups **************************** Connect.Client.search_user_hierarchy_groups(**kwargs) Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. Warning: The UserHierarchyGroup with ""LevelId": "0"" is the foundation for building levels on top of an instance. It is not user- definable, nor is it visible in the UI. See also: AWS API Documentation **Request Syntax** response = client.search_user_hierarchy_groups( InstanceId='string', NextToken='string', MaxResults=123, SearchFilter={ 'AttributeFilter': { 'OrConditions': [ { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, ], 'AndCondition': { 'TagConditions': [ { 'TagKey': 'string', 'TagValue': 'string' }, ], 'HierarchyGroupCondition': { 'Value': 'string', 'HierarchyGroupMatchType': 'EXACT'|'WITH_CHILD_GROUPS' } }, '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' } } ) type InstanceId: string param InstanceId: **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. type NextToken: string param NextToken: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. type MaxResults: integer param MaxResults: The maximum number of results to return per page. type SearchFilter: dict param SearchFilter: Filters to be applied to search results. * **AttributeFilter** *(dict) --* An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where: * The top level list specifies conditions that need to be applied with "OR" operator. * The inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **AndCondition** *(dict) --* A list of conditions which would be applied together with an "AND" condition. * **TagConditions** *(list) --* A leaf node condition which can be used to specify a tag condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. type SearchCriteria: dict param SearchCriteria: The search criteria to be used to return UserHierarchyGroups. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return userHierarchyGroup. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return userHierarchyGroup. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "parentId", "levelId", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **HierarchyGroupCondition** *(dict) --* A leaf node condition which can be used to specify a hierarchy group condition. * **Value** *(string) --* The value in the hierarchy group condition. * **HierarchyGroupMatchType** *(string) --* The type of hierarchy group match. rtype: dict returns: **Response Syntax** { 'UserHierarchyGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LevelId': 'string', 'HierarchyPath': { 'LevelOne': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelTwo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelThree': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFour': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFive': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } }, 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **UserHierarchyGroups** *(list) --* Information about the userHierarchyGroups. * *(dict) --* Contains 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. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of userHierarchyGroups which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_task_contact start_task_contact ****************** Connect.Client.start_task_contact(**kwargs) Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the *Amazon Connect Administrator Guide*. When using "PreviousContactId" and "RelatedContactId" input parameters, note the following: * "PreviousContactId" * Any updates to user-defined task contact attributes on any contact linked through the same "PreviousContactId" will affect every contact in the chain. * There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same "PreviousContactId". * "RelatedContactId" * Copies contact attributes from the related task contact to the new contact. * Any update on attributes in a new task contact does not update attributes on previous contact. * There’s no limit on the number of task contacts that can be created that use the same "RelatedContactId". In addition, when calling StartTaskContact include only one of these parameters: "ContactFlowID", "QuickConnectID", or "TaskTemplateID". Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the "TaskTemplateID" is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created. A "ServiceQuotaExceededException" occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same "PreviousContactId". For more information about service quotas for task contacts, see Amazon Connect service quotas in the *Amazon Connect Administrator Guide*. 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'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } }, Description='string', ClientToken='string', ScheduledTime=datetime(2015, 1, 1), TaskTemplateId='string', QuickConnectId='string', RelatedContactId='string', SegmentAttributes={ 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PreviousContactId** (*string*) -- The identifier of the previous chat, voice, or task contact. Any updates to user- defined attributes to task contacts linked using the same "PreviousContactID" will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain. * **ContactFlowId** (*string*) -- The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **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** * **Attributes** (*dict*) -- 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. * *(string) --* * *(string) --* * **Name** (*string*) -- **[REQUIRED]** The name of a task that is shown to an agent in the Contact Control Panel (CCP). * **References** (*dict*) -- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: "URL" | "NUMBER" | "STRING" | "DATE" | "EMAIL". "ATTACHMENT" is not a supported reference type during task creation. * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **Description** (*string*) -- A description of the task that is shown to an agent in the Contact Control Panel (CCP). * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **ScheduledTime** (*datetime*) -- The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. * **TaskTemplateId** (*string*) -- A unique identifier for the task template. For more information about task templates, see Create task templates in the *Amazon Connect Administrator Guide*. * **QuickConnectId** (*string*) -- The identifier for the quick connect. Tasks that are created by using "QuickConnectId" will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects. * **RelatedContactId** (*string*) -- The contactId that is related to this contact. Linking tasks together by using "RelatedContactID" copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using "PreviousContactID". There are no limits to the number of contacts that can be linked by using "RelatedContactId". * **SegmentAttributes** (*dict*) -- A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows. Attribute keys can include only alphanumeric, -, and _. This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task. Note: To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with "SegmentAttributes" like { ""connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}".To set the created by user, a valid AgentResourceId must be supplied, with "SegmentAttributes" like { ""connect:CreatedByUser" { "ValueString": "arn:aws:connect:us- west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx- xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx- xxxxxxxxxxxx"}}}". * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. Return type: dict Returns: **Response Syntax** { 'ContactId': 'string' } **Response Structure** * *(dict) --* * **ContactId** *(string) --* The identifier of this contact within the Amazon Connect instance. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_phone_numbers_v2 list_phone_numbers_v2 ********************* Connect.Client.list_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*. Note: * When given an instance ARN, "ListPhoneNumbersV2" returns only the phone numbers claimed to the instance. * When given a traffic distribution group ARN "ListPhoneNumbersV2" returns only the phone numbers claimed to the traffic distribution group. See also: AWS API Documentation **Request Syntax** response = client.list_phone_numbers_v2( TargetArn='string', InstanceId='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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', ], PhoneNumberPrefix='string' ) Parameters: * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both "TargetArn" and "InstanceId" input are 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. * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both "TargetArn" and "InstanceId" are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **PhoneNumberCountryCodes** (*list*) -- The ISO country code. * *(string) --* * **PhoneNumberTypes** (*list*) -- The type of phone number. * *(string) --* * **PhoneNumberPrefix** (*string*) -- The prefix of the phone number. If provided, it must contain "+" as part of the country code. Return type: dict Returns: **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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', 'TargetArn': 'string', 'InstanceId': 'string', 'PhoneNumberDescription': 'string', 'SourcePhoneNumberArn': '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 number inbound traffic is routed through. * **InstanceId** *(string) --* The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PhoneNumberDescription** *(string) --* The description of the phone number. * **SourcePhoneNumberArn** *(string) --* The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / describe_vocabulary describe_vocabulary ******************* Connect.Client.describe_vocabulary(**kwargs) Describes the specified vocabulary. See also: AWS API Documentation **Request Syntax** response = client.describe_vocabulary( InstanceId='string', VocabularyId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **VocabularyId** (*string*) -- **[REQUIRED]** The identifier of the custom vocabulary. Return type: dict Returns: **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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', '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"} }. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / update_contact_flow_module_metadata update_contact_flow_module_metadata *********************************** Connect.Client.update_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowModuleId** (*string*) -- **[REQUIRED]** The identifier of the flow module. * **Name** (*string*) -- The name of the flow module. * **Description** (*string*) -- The description of the flow module. * **State** (*string*) -- The state of flow module. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_rule delete_rule *********** Connect.Client.delete_rule(**kwargs) Deletes a rule for the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.delete_rule( InstanceId='string', RuleId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RuleId** (*string*) -- **[REQUIRED]** A unique identifier for the rule. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / delete_predefined_attribute delete_predefined_attribute *************************** Connect.Client.delete_predefined_attribute(**kwargs) Deletes a predefined attribute from the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.delete_predefined_attribute( InstanceId='string', Name='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the predefined attribute. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_quick_connects search_quick_connects ********************* Connect.Client.search_quick_connects(**kwargs) Searches quick connects in an Amazon Connect instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_quick_connects( 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' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return quick connects. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return quick connects. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return quick connects. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. Return type: dict Returns: **Response Syntax** { 'QuickConnects': [ { '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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **QuickConnects** *(list) --* Information about the quick connects. * *(dict) --* Contains information about a 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 admin website, 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of quick connects which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_security_profile_permissions list_security_profile_permissions ********************************* Connect.Client.list_security_profile_permissions(**kwargs) Lists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. See also: AWS API Documentation **Request Syntax** response = client.list_security_profile_permissions( SecurityProfileId='string', InstanceId='string', NextToken='string', MaxResults=123 ) Parameters: * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'Permissions': [ 'string', ], 'NextToken': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * *(string) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / stop_contact stop_contact ************ Connect.Client.stop_contact(**kwargs) Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: * DISCONNECT * TRANSFER * QUEUE_TRANSFER * EXTERNAL_OUTBOUND * MONITOR Chat and task contacts can be terminated in any state, regardless of initiation method. See also: AWS API Documentation **Request Syntax** response = client.stop_contact( ContactId='string', InstanceId='string', DisconnectReason={ 'Code': 'string' } ) Parameters: * **ContactId** (*string*) -- **[REQUIRED]** The ID of the contact. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **DisconnectReason** (*dict*) -- The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field. * **Code** *(string) --* A code that indicates how the contact was terminated. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ContactNotFoundException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_participant create_participant ****************** Connect.Client.create_participant(**kwargs) Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants. See also: AWS API Documentation **Request Syntax** response = client.create_participant( InstanceId='string', ContactId='string', ClientToken='string', ParticipantDetails={ 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'DisplayName': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **ParticipantDetails** (*dict*) -- **[REQUIRED]** Information identifying the participant. Warning: The only Valid value for "ParticipantRole" is "CUSTOM_BOT"."DisplayName" is **Required**. * **ParticipantRole** *(string) --* The role of the participant being added. * **DisplayName** *(string) --* The display name of the participant. Return type: dict Returns: **Response Syntax** { 'ParticipantCredentials': { 'ParticipantToken': 'string', 'Expiry': 'string' }, 'ParticipantId': 'string' } **Response Structure** * *(dict) --* * **ParticipantCredentials** *(dict) --* The token used by the chat participant to call "CreateParticipantConnection". The participant token is valid for the lifetime of a chat participant. * **ParticipantToken** *(string) --* The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant. * **Expiry** *(string) --* The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. * **ParticipantId** *(string) --* The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_authentication_profiles list_authentication_profiles **************************** Connect.Client.list_authentication_profiles(**kwargs) This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport. Provides summary information about the authentication profiles in a specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_authentication_profiles( InstanceId='string', MaxResults=123, NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'AuthenticationProfileSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'IsDefault': True|False, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AuthenticationProfileSummaryList** *(list) --* A summary of a given authentication profile. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport. A summary of a given authentication profile. * **Id** *(string) --* The unique identifier of the authentication profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the authentication profile summary. * **Name** *(string) --* The name of the authentication profile summary. * **IsDefault** *(boolean) --* Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile. * **LastModifiedTime** *(datetime) --* The timestamp when the authentication profile summary was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region when the authentication profile summary was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_persistent_contact_association create_persistent_contact_association ************************************* Connect.Client.create_persistent_contact_association(**kwargs) Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_persistent_contact_association( InstanceId='string', InitialContactId='string', RehydrationType='ENTIRE_PAST_SESSION'|'FROM_SEGMENT', SourceContactId='string', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **InitialContactId** (*string*) -- **[REQUIRED]** This is the contactId of the current contact that the "CreatePersistentContactAssociation" API is being called from. * **RehydrationType** (*string*) -- **[REQUIRED]** The contactId chosen for rehydration depends on the type chosen. * "ENTIRE_PAST_SESSION": Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the "initialContactId" of the past ended chat session in the "sourceContactId" field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. * "FROM_SEGMENT": Rehydrates a chat from the specified past chat contact provided in the "sourceContactId" field. The actual contactId used for rehydration is provided in the response of this API. To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID **C1**. Agent a1 then transfers the chat to Agent a2. This creates another contact ID **C2**. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID **C3**. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases: * **Use Case 1**: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration: * **Configuration** * SourceContactId = "C2" * RehydrationType = "FROM_SEGMENT" * **Expected behavior** * This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session. * **Use Case 2**: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration: * **Configuration** * SourceContactId = "C1" * RehydrationType = "ENTIRE_PAST_SESSION" * **Expected behavior** * This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session. * **SourceContactId** (*string*) -- **[REQUIRED]** The contactId from which a persistent chat session must be started. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. Return type: dict Returns: **Response Syntax** { 'ContinuedFromContactId': 'string' } **Response Structure** * *(dict) --* * **ContinuedFromContactId** *(string) --* The contactId from which a persistent chat session is started. This field is populated only for persistent chat. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_lex_bot disassociate_lex_bot ******************** Connect.Client.disassociate_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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **BotName** (*string*) -- **[REQUIRED]** The name of the Amazon Lex bot. Maximum character limit of 50. * **LexRegion** (*string*) -- **[REQUIRED]** The Amazon Web Services Region in which the Amazon Lex bot has been created. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / associate_lambda_function associate_lambda_function ************************* Connect.Client.associate_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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **FunctionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_prompt describe_prompt *************** Connect.Client.describe_prompt(**kwargs) Describes the prompt. See also: AWS API Documentation **Request Syntax** response = client.describe_prompt( InstanceId='string', PromptId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PromptId** (*string*) -- **[REQUIRED]** A unique identifier for the prompt. Return type: dict Returns: **Response Syntax** { 'Prompt': { 'PromptARN': 'string', 'PromptId': 'string', 'Name': 'string', 'Description': 'string', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } } **Response Structure** * *(dict) --* * **Prompt** *(dict) --* Information about the prompt. * **PromptARN** *(string) --* The Amazon Resource Name (ARN) of the prompt. * **PromptId** *(string) --* A unique identifier for the prompt. * **Name** *(string) --* The name of the prompt. * **Description** *(string) --* The description of the prompt. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_traffic_distribution_group describe_traffic_distribution_group *********************************** Connect.Client.describe_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' ) Parameters: **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. Return type: dict Returns: **Response Syntax** { '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' }, 'IsDefault': True|False } } **Response Structure** * *(dict) --* * **TrafficDistributionGroup** *(dict) --* Information about the traffic distribution group. * **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. * **Description** *(string) --* The description of the traffic distribution group. * **InstanceArn** *(string) --* The Amazon Resource Name (ARN). * **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 UpdateTrafficDistribution operation is still in progress and has not yet completed. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **IsDefault** *(boolean) --* Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the "DeleteTrafficDistributionGroup" API. The default traffic distribution group is deleted as part of the process for deleting a replica. Note: The "SignInConfig" distribution is available only on a default "TrafficDistributionGroup" (see the "IsDefault" parameter in the TrafficDistributionGroup data type). If you call "UpdateTrafficDistribution" with a modified "SignInConfig" and a non-default "TrafficDistributionGroup", an "InvalidRequestException" is returned. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_agent_status update_agent_status ******************* Connect.Client.update_agent_status(**kwargs) 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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AgentStatusId** (*string*) -- **[REQUIRED]** The identifier of the agent status. * **Name** (*string*) -- The name of the agent status. * **Description** (*string*) -- The description of the agent status. * **State** (*string*) -- The state of the agent status. * **DisplayOrder** (*integer*) -- The display order of the agent status. * **ResetOrderNumber** (*boolean*) -- A number indicating the reset order of the agent status. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_hours_of_operation_overrides search_hours_of_operation_overrides *********************************** Connect.Client.search_hours_of_operation_overrides(**kwargs) Searches the hours of operation overrides. See also: AWS API Documentation **Request Syntax** response = client.search_hours_of_operation_overrides( 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' }, 'DateCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return hours of operations overrides. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return hours of operations overrides. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return hours of operations overrides. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **DateCondition** *(dict) --* A leaf node condition which can be used to specify a date condition. * **FieldName** *(string) --* An object to specify the hours of operation override date field. * **Value** *(string) --* An object to specify the hours of operation override date value. * **ComparisonType** *(string) --* An object to specify the hours of operation override date condition "comparisonType". Return type: dict Returns: **Response Syntax** { 'HoursOfOperationOverrides': [ { 'HoursOfOperationOverrideId': 'string', 'HoursOfOperationId': 'string', 'HoursOfOperationArn': 'string', 'Name': 'string', 'Description': 'string', 'Config': [ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], 'EffectiveFrom': 'string', 'EffectiveTill': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **HoursOfOperationOverrides** *(list) --* Information about the hours of operations overrides. * *(dict) --* Information about the hours of operations override. * **HoursOfOperationOverrideId** *(string) --* The identifier for the hours of operation override. * **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 of the hours of operation override. * **Description** *(string) --* The description of the hours of operation override. * **Config** *(list) --* Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EffectiveFrom** *(string) --* The date from which the hours of operation override would be effective. * **EffectiveTill** *(string) --* The date till which the hours of operation override would be effective. * **NextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of hours of operations which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_queue_outbound_caller_config update_queue_outbound_caller_config *********************************** Connect.Client.update_queue_outbound_caller_config(**kwargs) Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. Warning: * If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for "OutboundCallerIdNumberId". However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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". * Only use the phone number ARN format that doesn't contain "instance" in the path, for example, "arn:aws:connect:us- east-1:1234567890:phone-number/uuid". This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. * If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **OutboundCallerConfig** (*dict*) -- **[REQUIRED]** 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. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / pause_contact pause_contact ************* Connect.Client.pause_contact(**kwargs) Allows pausing an ongoing task contact. See also: AWS API Documentation **Request Syntax** response = client.pause_contact( ContactId='string', InstanceId='string', ContactFlowId='string' ) Parameters: * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the "instanceId" in the ARN of the instance. * **ContactFlowId** (*string*) -- The identifier of the flow. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ConflictException" Connect / Client / list_contact_flows list_contact_flows ****************** Connect.Client.list_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'|'CAMPAIGN', ], NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowTypes** (*list*) -- The type of flow. * *(string) --* * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **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'|'CAMPAIGN', 'ContactFlowState': 'ACTIVE'|'ARCHIVED', 'ContactFlowStatus': 'PUBLISHED'|'SAVED' }, ], '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. * **ContactFlowStatus** *(string) --* The status of the flow. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_evaluation_form delete_evaluation_form ********************** Connect.Client.delete_evaluation_form(**kwargs) Deletes an evaluation form in the specified Amazon Connect instance. * If the version property is provided, only the specified version of the evaluation form is deleted. * If no version is provided, then the full form (all versions) is deleted. See also: AWS API Documentation **Request Syntax** response = client.delete_evaluation_form( InstanceId='string', EvaluationFormId='string', EvaluationFormVersion=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **EvaluationFormVersion** (*integer*) -- The unique identifier for the evaluation form. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / disassociate_approved_origin disassociate_approved_origin **************************** Connect.Client.disassociate_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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Origin** (*string*) -- **[REQUIRED]** The domain URL of the integrated application. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_predefined_attribute update_predefined_attribute *************************** Connect.Client.update_predefined_attribute(**kwargs) Updates a predefined attribute for the specified Amazon Connect instance. *Predefined attributes* are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. See also: AWS API Documentation **Request Syntax** response = client.update_predefined_attribute( InstanceId='string', Name='string', Values={ 'StringList': [ 'string', ] } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the predefined attribute. * **Values** (*dict*) -- The values of the predefined attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringList". * **StringList** *(list) --* Predefined attribute values of type string list. * *(string) --* Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_flow disassociate_flow ***************** Connect.Client.disassociate_flow(**kwargs) Disassociates a connect resource from a flow. See also: AWS API Documentation **Request Syntax** response = client.disassociate_flow( InstanceId='string', ResourceId='string', ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceId** (*string*) -- **[REQUIRED]** The identifier of the resource. * Amazon Web Services End User Messaging SMS phone number ARN when using "SMS_PHONE_NUMBER" * Amazon Web Services End User Messaging Social phone number ARN when using "WHATSAPP_MESSAGING_PHONE_NUMBER" * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_instance_attribute describe_instance_attribute *************************** Connect.Client.describe_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'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AttributeType** (*string*) -- **[REQUIRED]** The type of attribute. Return type: dict Returns: **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'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE', '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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / delete_contact_flow_version delete_contact_flow_version *************************** Connect.Client.delete_contact_flow_version(**kwargs) Deletes the particular version specified in flow version identifier. See also: AWS API Documentation **Request Syntax** response = client.delete_contact_flow_version( InstanceId='string', ContactFlowId='string', ContactFlowVersion=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **ContactFlowVersion** (*integer*) -- **[REQUIRED]** The identifier of the flow version. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_user_routing_profile update_user_routing_profile *************************** Connect.Client.update_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' ) Parameters: * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile for the user. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_traffic_distribution_group_user disassociate_traffic_distribution_group_user ******************************************** Connect.Client.disassociate_traffic_distribution_group_user(**kwargs) Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. See also: AWS API Documentation **Request Syntax** response = client.disassociate_traffic_distribution_group_user( TrafficDistributionGroupId='string', UserId='string', InstanceId='string' ) Parameters: * **TrafficDistributionGroupId** (*string*) -- **[REQUIRED]** The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group. * **UserId** (*string*) -- **[REQUIRED]** The identifier for the user. This can be the ID or the ARN of the user. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_queue_quick_connects list_queue_quick_connects ************************* Connect.Client.list_queue_quick_connects(**kwargs) 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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'QuickConnectSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **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 admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_outbound_email_contact start_outbound_email_contact **************************** Connect.Client.start_outbound_email_contact(**kwargs) Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer. See also: AWS API Documentation **Request Syntax** response = client.start_outbound_email_contact( InstanceId='string', ContactId='string', FromEmailAddress={ 'EmailAddress': 'string', 'DisplayName': 'string' }, DestinationEmailAddress={ 'EmailAddress': 'string', 'DisplayName': 'string' }, AdditionalRecipients={ 'CcEmailAddresses': [ { 'EmailAddress': 'string', 'DisplayName': 'string' }, ] }, EmailMessage={ 'MessageSourceType': 'TEMPLATE'|'RAW', 'TemplatedMessageConfig': { 'KnowledgeBaseId': 'string', 'MessageTemplateId': 'string', 'TemplateAttributes': { 'CustomAttributes': { 'string': 'string' }, 'CustomerProfileAttributes': 'string' } }, 'RawMessage': { 'Subject': 'string', 'Body': 'string', 'ContentType': 'string' } }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **FromEmailAddress** (*dict*) -- The email address associated with the Amazon Connect instance. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **DestinationEmailAddress** (*dict*) -- **[REQUIRED]** The email address of the customer. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **AdditionalRecipients** (*dict*) -- The additional recipients address of email in CC. * **CcEmailAddresses** *(list) --* Information about the **additional** CC email address recipients. Email recipients are limited to 50 total addresses: 1 required recipient in the DestinationEmailAddress field and up to 49 recipients in the 'CcEmailAddresses' field. * *(dict) --* Contains information about a source or destination email address. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **EmailMessage** (*dict*) -- **[REQUIRED]** The email message body to be sent to the newly created email. * **MessageSourceType** *(string) --* **[REQUIRED]** The message source type, that is, "RAW" or "TEMPLATE". * **TemplatedMessageConfig** *(dict) --* Information about template message configuration. * **KnowledgeBaseId** *(string) --* **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **MessageTemplateId** *(string) --* **[REQUIRED]** The identifier of the message template Id. * **TemplateAttributes** *(dict) --* **[REQUIRED]** Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes. * **CustomAttributes** *(dict) --* An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. * *(string) --* * *(string) --* * **CustomerProfileAttributes** *(string) --* An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. * **RawMessage** *(dict) --* The raw email body content. * **Subject** *(string) --* **[REQUIRED]** The email subject. * **Body** *(string) --* **[REQUIRED]** The email message body. * **ContentType** *(string) --* **[REQUIRED]** Type of content, that is, "text/plain" or "text/html". * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ContactId': 'string' } **Response Structure** * *(dict) --* * **ContactId** *(string) --* The identifier of the contact in this instance of Amazon Connect. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" Connect / Client / update_routing_profile_agent_availability_timer update_routing_profile_agent_availability_timer *********************************************** Connect.Client.update_routing_profile_agent_availability_timer(**kwargs) Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*. See also: AWS API Documentation **Request Syntax** response = client.update_routing_profile_agent_availability_timer( InstanceId='string', RoutingProfileId='string', AgentAvailabilityTimer='TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **AgentAvailabilityTimer** (*string*) -- **[REQUIRED]** Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_instance_storage_config update_instance_storage_config ****************************** Connect.Client.update_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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES', 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' } }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AssociationId** (*string*) -- **[REQUIRED]** The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. * **StorageConfig** (*dict*) -- **[REQUIRED]** 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) --* **[REQUIRED]** A valid storage type. * **S3Config** *(dict) --* The S3 bucket configuration. * **BucketName** *(string) --* **[REQUIRED]** The S3 bucket name. * **BucketPrefix** *(string) --* **[REQUIRED]** The S3 bucket prefix. * **EncryptionConfig** *(dict) --* The Amazon S3 encryption configuration. * **EncryptionType** *(string) --* **[REQUIRED]** The type of encryption. * **KeyId** *(string) --* **[REQUIRED]** The full ARN of the encryption key. Note: Be sure to provide the full ARN of the encryption key, not just the ID.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **KinesisVideoStreamConfig** *(dict) --* The configuration of the Kinesis video stream. * **Prefix** *(string) --* **[REQUIRED]** The prefix of the video stream. * **RetentionPeriodHours** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** The encryption configuration. * **EncryptionType** *(string) --* **[REQUIRED]** The type of encryption. * **KeyId** *(string) --* **[REQUIRED]** The full ARN of the encryption key. Note: Be sure to provide the full ARN of the encryption key, not just the ID.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **KinesisStreamConfig** *(dict) --* The configuration of the Kinesis data stream. * **StreamArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the data stream. * **KinesisFirehoseConfig** *(dict) --* The configuration of the Kinesis Firehose delivery stream. * **FirehoseArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the delivery stream. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_prompt update_prompt ************* Connect.Client.update_prompt(**kwargs) Updates a prompt. See also: AWS API Documentation **Request Syntax** response = client.update_prompt( InstanceId='string', PromptId='string', Name='string', Description='string', S3Uri='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PromptId** (*string*) -- **[REQUIRED]** A unique identifier for the prompt. * **Name** (*string*) -- The name of the prompt. * **Description** (*string*) -- A description of the prompt. * **S3Uri** (*string*) -- The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs. Return type: dict Returns: **Response Syntax** { 'PromptARN': 'string', 'PromptId': 'string' } **Response Structure** * *(dict) --* * **PromptARN** *(string) --* The Amazon Resource Name (ARN) of the prompt. * **PromptId** *(string) --* A unique identifier for the prompt. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_evaluation_form_versions list_evaluation_form_versions ***************************** Connect.Client.list_evaluation_form_versions(**kwargs) Lists versions of an evaluation form in the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_evaluation_form_versions( InstanceId='string', EvaluationFormId='string', MaxResults=123, NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'EvaluationFormVersionSummaryList': [ { 'EvaluationFormArn': 'string', 'EvaluationFormId': 'string', 'EvaluationFormVersion': 123, 'Locked': True|False, 'Status': 'DRAFT'|'ACTIVE', 'CreatedTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EvaluationFormVersionSummaryList** *(list) --* Provides details about a list of evaluation forms belonging to an instance. * *(dict) --* Summary information about an evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormVersion** *(integer) --* A version of the evaluation form. * **Locked** *(boolean) --* The flag indicating whether the evaluation form is locked for changes. * **Status** *(string) --* The status of the evaluation form. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation form was created. * **CreatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who created the evaluation form. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation form was last updated. * **LastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation form. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / activate_evaluation_form activate_evaluation_form ************************ Connect.Client.activate_evaluation_form(**kwargs) Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form. See also: AWS API Documentation **Request Syntax** response = client.activate_evaluation_form( InstanceId='string', EvaluationFormId='string', EvaluationFormVersion=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **EvaluationFormVersion** (*integer*) -- **[REQUIRED]** The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated. Return type: dict Returns: **Response Syntax** { 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string', 'EvaluationFormVersion': 123 } **Response Structure** * *(dict) --* * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **EvaluationFormVersion** *(integer) --* A version of the evaluation form. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / list_traffic_distribution_group_users list_traffic_distribution_group_users ************************************* Connect.Client.list_traffic_distribution_group_users(**kwargs) Lists traffic distribution group users. See also: AWS API Documentation **Request Syntax** response = client.list_traffic_distribution_group_users( TrafficDistributionGroupId='string', MaxResults=123, NextToken='string' ) Parameters: * **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. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'TrafficDistributionGroupUserSummaryList': [ { 'UserId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **TrafficDistributionGroupUserSummaryList** *(list) --* A list of traffic distribution group users. * *(dict) --* Summary information about a traffic distribution group user. * **UserId** *(string) --* The identifier for the user. This can be the ID or the ARN of the user. **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_authentication_profile update_authentication_profile ***************************** Connect.Client.update_authentication_profile(**kwargs) This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport. Updates the selected authentication profile. See also: AWS API Documentation **Request Syntax** response = client.update_authentication_profile( AuthenticationProfileId='string', InstanceId='string', Name='string', Description='string', AllowedIps=[ 'string', ], BlockedIps=[ 'string', ], PeriodicSessionDuration=123 ) Parameters: * **AuthenticationProfileId** (*string*) -- **[REQUIRED]** A unique identifier for the authentication profile. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- The name for the authentication profile. * **Description** (*string*) -- The description for the authentication profile. * **AllowedIps** (*list*) -- A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see Configure session timeouts in the *Amazon Connect Administrator Guide*. * *(string) --* * **BlockedIps** (*list*) -- A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the *Amazon Connect Administrator Guide*. * *(string) --* * **PeriodicSessionDuration** (*integer*) -- The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the *Amazon Connect Administrator Guide*. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / get_attached_file get_attached_file ***************** Connect.Client.get_attached_file(**kwargs) Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is "APPROVED". See also: AWS API Documentation **Request Syntax** response = client.get_attached_file( InstanceId='string', FileId='string', UrlExpiryInSeconds=123, AssociatedResourceArn='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Connect instance. * **FileId** (*string*) -- **[REQUIRED]** The unique identifier of the attached file resource. * **UrlExpiryInSeconds** (*integer*) -- Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300. * **AssociatedResourceArn** (*string*) -- **[REQUIRED]** The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. Note: This value must be a valid ARN. Return type: dict Returns: **Response Syntax** { 'FileArn': 'string', 'FileId': 'string', 'CreationTime': 'string', 'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'FileName': 'string', 'FileSizeInBytes': 123, 'AssociatedResourceArn': 'string', 'FileUseCaseType': 'EMAIL_MESSAGE'|'ATTACHMENT', 'CreatedBy': { 'ConnectUserArn': 'string', 'AWSIdentityArn': 'string' }, 'DownloadUrlMetadata': { 'Url': 'string', 'UrlExpiry': 'string' }, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* Response from GetAttachedFile API. * **FileArn** *(string) --* The unique identifier of the attached file resource (ARN). * **FileId** *(string) --* The unique identifier of the attached file resource. * **CreationTime** *(string) --* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: "yyyy-MM- ddThh:mm:ss.SSSZ". For example, "2024-05-03T02:41:28.172Z". * **FileStatus** *(string) --* The current status of the attached file. * **FileName** *(string) --* A case-sensitive name of the attached file being uploaded. * **FileSizeInBytes** *(integer) --* The size of the attached file in bytes. * **AssociatedResourceArn** *(string) --* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. * **FileUseCaseType** *(string) --* The use case for the file. * **CreatedBy** *(dict) --* Represents the identity that created the file. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ConnectUserArn", "AWSIdentityArn". 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'} * **ConnectUserArn** *(string) --* An agent ARN representing a connect user. * **AWSIdentityArn** *(string) --* STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if "ConnectUserArn" is not provided. * **DownloadUrlMetadata** *(dict) --* URL and expiry to be used when downloading the attached file. * **Url** *(string) --* A pre-signed URL that should be used to download the attached file. * **UrlExpiry** *(string) --* The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, "{ "Tags": {"key1":"value1", "key2":"value2"} }". * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / delete_task_template delete_task_template ******************** Connect.Client.delete_task_template(**kwargs) Deletes the task template. See also: AWS API Documentation **Request Syntax** response = client.delete_task_template( InstanceId='string', TaskTemplateId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **TaskTemplateId** (*string*) -- **[REQUIRED]** A unique identifier for the task template. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_routing_profile delete_routing_profile ********************** Connect.Client.delete_routing_profile(**kwargs) Deletes a routing profile. See also: AWS API Documentation **Request Syntax** response = client.delete_routing_profile( InstanceId='string', RoutingProfileId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_security_key disassociate_security_key ************************* Connect.Client.disassociate_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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AssociationId** (*string*) -- **[REQUIRED]** The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / associate_default_vocabulary associate_default_vocabulary **************************** Connect.Client.associate_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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', VocabularyId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **LanguageCode** (*string*) -- **[REQUIRED]** 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. If this is empty, the default is set to none. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / get_current_user_data get_current_user_data ********************* Connect.Client.get_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', ] }, 'RoutingProfiles': [ 'string', ], 'Agents': [ 'string', ], 'UserHierarchyGroups': [ 'string', ] }, NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Filters** (*dict*) -- **[REQUIRED]** The filters to apply to returned user data. You can filter up to the following limits: * Queues: 100 * Routing profiles: 100 * Agents: 100 * Contact states: 9 * User hierarchy groups: 1 The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups. Currently tagging is only supported on the resources that are passed in the filter. * **Queues** *(list) --* A list of up to 100 queues or ARNs. * *(string) --* * **ContactFilter** *(dict) --* A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states. * **ContactStates** *(list) --* A list of up to 9 contact states. * *(string) --* * **RoutingProfiles** *(list) --* A list of up to 100 routing profile IDs or ARNs. * *(string) --* * **Agents** *(list) --* A list of up to 100 agent IDs or ARNs. * *(string) --* * **UserHierarchyGroups** *(list) --* A UserHierarchyGroup ID or ARN. * *(string) --* * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **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', 'StatusName': 'string' }, 'AvailableSlotsByChannel': { 'string': 123 }, 'MaxSlotsByChannel': { 'string': 123 }, 'ActiveSlotsByChannel': { 'string': 123 }, 'Contacts': [ { 'ContactId': 'string', 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', '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' } }, ], 'NextStatus': 'string' }, ], 'ApproximateTotalCount': 123 } **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. * **StatusName** *(string) --* The name of the agent 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. * *(string) --* * *(integer) --* * **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. * *(string) --* * *(integer) --* * **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. * *(string) --* * *(integer) --* * **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. Note: When "AgentContactState" is set to "CONNECTED_ONHOLD", "StateStartTimestamp" is not changed. Instead, "StateStartTimestamp" reflects the time the contact was "CONNECTED" to the agent. * **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. * **NextStatus** *(string) --* The Next status of the agent. * **ApproximateTotalCount** *(integer) --* The total count of the result, regardless of the current page size. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / create_user create_user *********** Connect.Client.create_user(**kwargs) Creates a user account for the specified Amazon Connect instance. Warning: Certain UserIdentityInfo parameters are required in some situations. For example, "Email", "FirstName" and "LastName" are required if you are using Amazon Connect or SAML for identity management. For information about how to create users using the Amazon Connect admin website, 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' } ) Parameters: * **Username** (*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_<<-.@]+. Username can include @ only if used in an email format. For example: * Correct: testuser * Correct: testuser@example.com * Incorrect: testuser@example * **Password** (*string*) -- The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password. * **IdentityInfo** (*dict*) -- The information about the identity of the user. * **FirstName** *(string) --* The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. * **LastName** *(string) --* The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. * **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*) -- **[REQUIRED]** The phone settings for the user. * **PhoneType** *(string) --* **[REQUIRED]** The phone type. * **AutoAccept** *(boolean) --* The Auto accept setting. * **AfterContactWorkTimeLimit** *(integer) --* The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. 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. 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. * **SecurityProfileIds** (*list*) -- **[REQUIRED]** The identifier of the security profile for the user. * *(string) --* * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile for the user. * **HierarchyGroupId** (*string*) -- The identifier of the hierarchy group for the user. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_prompts list_prompts ************ Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'PromptSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_integration_association delete_integration_association ****************************** Connect.Client.delete_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationAssociationId** (*string*) -- **[REQUIRED]** The identifier for the integration association. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_predefined_attribute describe_predefined_attribute ***************************** Connect.Client.describe_predefined_attribute(**kwargs) Describes a predefined attribute for the specified Amazon Connect instance. *Predefined attributes* are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. See also: AWS API Documentation **Request Syntax** response = client.describe_predefined_attribute( InstanceId='string', Name='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the predefined attribute. Return type: dict Returns: **Response Syntax** { 'PredefinedAttribute': { 'Name': 'string', 'Values': { 'StringList': [ 'string', ] }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } } **Response Structure** * *(dict) --* * **PredefinedAttribute** *(dict) --* Information about the predefined attribute. * **Name** *(string) --* The name of the predefined attribute. * **Values** *(dict) --* The values of the predefined attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringList". 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'} * **StringList** *(list) --* Predefined attribute values of type string list. * *(string) --* * **LastModifiedTime** *(datetime) --* Last modified time. * **LastModifiedRegion** *(string) --* Last modified region. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_use_case delete_use_case *************** Connect.Client.delete_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationAssociationId** (*string*) -- **[REQUIRED]** The identifier for the integration association. * **UseCaseId** (*string*) -- **[REQUIRED]** The identifier for the use case. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_agent_status describe_agent_status ********************* Connect.Client.describe_agent_status(**kwargs) Describes an agent status. See also: AWS API Documentation **Request Syntax** response = client.describe_agent_status( InstanceId='string', AgentStatusId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AgentStatusId** (*string*) -- **[REQUIRED]** The identifier for the agent status. Return type: dict Returns: **Response Syntax** { 'AgentStatus': { 'AgentStatusARN': 'string', 'AgentStatusId': 'string', 'Name': 'string', 'Description': 'string', 'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE', 'DisplayOrder': 123, 'State': 'ENABLED'|'DISABLED', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_hours_of_operation_override create_hours_of_operation_override ********************************** Connect.Client.create_hours_of_operation_override(**kwargs) Creates an hours of operation override in an Amazon Connect hours of operation resource. See also: AWS API Documentation **Request Syntax** response = client.create_hours_of_operation_override( InstanceId='string', HoursOfOperationId='string', Name='string', Description='string', Config=[ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], EffectiveFrom='string', EffectiveTill='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation * **Name** (*string*) -- **[REQUIRED]** The name of the hours of operation override. * **Description** (*string*) -- The description of the hours of operation override. * **Config** (*list*) -- **[REQUIRED]** Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **EffectiveFrom** (*string*) -- **[REQUIRED]** The date from when the hours of operation override is effective. * **EffectiveTill** (*string*) -- **[REQUIRED]** The date until when the hours of operation override is effective. Return type: dict Returns: **Response Syntax** { 'HoursOfOperationOverrideId': 'string' } **Response Structure** * *(dict) --* * **HoursOfOperationOverrideId** *(string) --* The identifier for the hours of operation override. **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / get_metric_data_v2 get_metric_data_v2 ****************** Connect.Client.get_metric_data_v2(**kwargs) Gets metric data from the specified Amazon Connect instance. "GetMetricDataV2" offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are supported by "GetMetricDataV2" and "GetMetricData", see Metrics definitions in the *Amazon Connect Administrator Guide*. Note: When you make a successful API request, you can expect the following metric values in the response: * **Metric value is null**: The calculation cannot be performed due to divide by zero or insufficient data * **Metric value is a number (including 0) of defined type**: The number provided is the calculation result * **MetricResult list is empty**: The request cannot find any data in the system The following guidelines can help you work with the API: * Each dimension in the metric response must contain a value * Each item in MetricResult must include all requested metrics * If the response is slow due to large result sets, try these approaches: * Narrow the time range of your request * Add filters to reduce the amount of data returned See also: AWS API Documentation **Request Syntax** response = client.get_metric_data_v2( ResourceArn='string', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), Interval={ 'TimeZone': 'string', 'IntervalPeriod': 'FIFTEEN_MIN'|'THIRTY_MIN'|'HOUR'|'DAY'|'WEEK'|'TOTAL' }, Filters=[ { 'FilterKey': 'string', 'FilterValues': [ 'string', ] }, ], Groupings=[ 'string', ], Metrics=[ { 'Name': 'string', 'Threshold': [ { 'Comparison': 'string', 'ThresholdValue': 123.0 }, ], 'MetricFilters': [ { 'MetricFilterKey': 'string', 'MetricFilterValues': [ 'string', ], 'Negate': True|False }, ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. This includes the "instanceId" an Amazon Connect instance. * **StartTime** (*datetime*) -- **[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 before the end time timestamp. The start and end time depends on the "IntervalPeriod" selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months. * **EndTime** (*datetime*) -- **[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 later than the start time timestamp. It cannot be later than the current timestamp. * **Interval** (*dict*) -- The interval period and timezone to apply to returned metrics. * "IntervalPeriod": An aggregated grouping applied to request metrics. Valid "IntervalPeriod" values are: "FIFTEEN_MIN" | "THIRTY_MIN" | "HOUR" | "DAY" | "WEEK" | "TOTAL". For example, if "IntervalPeriod" is selected "THIRTY_MIN", "StartTime" and "EndTime" differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the "TOTAL" interval period. The following list describes restrictions on "StartTime" and "EndTime" based on which "IntervalPeriod" is requested. * "FIFTEEN_MIN": The difference between "StartTime" and "EndTime" must be less than 3 days. * "THIRTY_MIN": The difference between "StartTime" and "EndTime" must be less than 3 days. * "HOUR": The difference between "StartTime" and "EndTime" must be less than 3 days. * "DAY": The difference between "StartTime" and "EndTime" must be less than 35 days. * "WEEK": The difference between "StartTime" and "EndTime" must be less than 35 days. * "TOTAL": The difference between "StartTime" and "EndTime" must be less than 35 days. * "TimeZone": The timezone applied to requested metrics. * **TimeZone** *(string) --* The timezone applied to requested metrics. * **IntervalPeriod** *(string) --* "IntervalPeriod": An aggregated grouping applied to request metrics. Valid "IntervalPeriod" values are: "FIFTEEN_MIN" | "THIRTY_MIN" | "HOUR" | "DAY" | "WEEK" | "TOTAL". For example, if "IntervalPeriod" is selected "THIRTY_MIN", "StartTime" and "EndTime" differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the "TOTAL" interval period. The following list describes restrictions on "StartTime" and "EndTime" based on what "IntervalPeriod" is requested. * "FIFTEEN_MIN": The difference between "StartTime" and "EndTime" must be less than 3 days. * "THIRTY_MIN": The difference between "StartTime" and "EndTime" must be less than 3 days. * "HOUR": The difference between "StartTime" and "EndTime" must be less than 3 days. * "DAY": The difference between "StartTime" and "EndTime" must be less than 35 days. * "WEEK": The difference between "StartTime" and "EndTime" must be less than 35 days. * "TOTAL": The difference between "StartTime" and "EndTime" must be less than 35 days. * **Filters** (*list*) -- **[REQUIRED]** The filters to apply to returned metrics. You can filter on the following resources: * Agents * Campaigns * Channels * Feature * Queues * Routing profiles * Routing step expression * User hierarchy groups At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups. For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement. To filter by phone number, see Create a historical metrics report in the *Amazon Connect Administrator Guide*. Note the following limits: * **Filter keys**: A maximum of 5 filter keys are supported in a single request. Valid filter keys: "AGENT" | "AGENT_HIERARCHY_LEVEL_ONE" | "AGENT_HIERARCHY_LEVEL_TWO" | "AGENT_HIERARCHY_LEVEL_THREE" | "AGENT_HIERARCHY_LEVEL_FOUR" | "AGENT_HIERARCHY_LEVEL_FIVE" | "ANSWERING_MACHINE_DETECTION_STATUS" | "BOT_ID" | "BOT_ALIAS" | "BOT_VERSION" | "BOT_LOCALE" | "BOT_INTENT_NAME" | "CAMPAIGN" | "CAMPAIGN_DELIVERY_EVENT_TYPE" | "CAMPAIGN_EXCLUDED_EVENT_TYPE" | "CASE_TEMPLATE_ARN" | "CASE_STATUS" | "CHANNEL" | "contact/segmentAttributes/connect:Subtype" | "DISCONNECT_REASON" | "EVALUATION_FORM" | "EVALUATION_SECTION" | "EVALUATION_QUESTION" | "EVALUATION_SOURCE" | "FEATURE" | "FLOW_ACTION_ID" | "FLOW_TYPE" | "FLOWS_MODULE_RESOURCE_ID" | "FLOWS_NEXT_RESOURCE_ID" | "FLOWS_NEXT_RESOURCE_QUEUE_ID" | "FLOWS_OUTCOME_TYPE" | "FLOWS_RESOURCE_ID" | "FORM_VERSION" | "INITIATION_METHOD" | "INVOKING_RESOURCE_PUBLISHED_TIMESTAMP" | "INVOKING_RESOURCE_TYPE" | "PARENT_FLOWS_RESOURCE_ID" | "RESOURCE_PUBLISHED_TIMESTAMP" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION" | "QUEUE" | "Q_CONNECT_ENABLED" | * **Filter values**: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid "filterValue" for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. "contact_lens_conversational_analytics" is a valid filterValue for the "FEATURE" filter key. It is available only to contacts analyzed by Contact Lens conversational analytics. "connect:Chat", "connect:SMS", "connect:Telephony", and "connect:WebRTC" are valid "filterValue" examples (not exhaustive) for the "contact/segmentAttributes/connect:Subtype filter" key. "ROUTING_STEP_EXPRESSION" is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is. "Q_CONNECT_ENABLED". TRUE and FALSE are the only valid filterValues for the "Q_CONNECT_ENABLED" filter key. * TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow. * FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow This filter is available only for contact record-driven metrics. Campaign ARNs are valid "filterValues" for the "CAMPAIGN" filter key. * *(dict) --* Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API. * **FilterKey** *(string) --* The key to use for filtering data. For example, "QUEUE", "ROUTING_PROFILE, AGENT", "CHANNEL", "AGENT_HIERARCHY_LEVEL_ONE", "AGENT_HIERARCHY_LEVEL_TWO", "AGENT_HIERARCHY_LEVEL_THREE", "AGENT_HIERARCHY_LEVEL_FOUR", "AGENT_HIERARCHY_LEVEL_FIVE". There must be at least 1 key and a maximum 5 keys. * **FilterValues** *(list) --* The identifiers to use for filtering data. For example, if you have a filter key of "QUEUE", you would add queue IDs or ARNs in "FilterValues". * *(string) --* * **Groupings** (*list*) -- The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues. If no grouping is specified, a summary of all metrics is returned. Valid grouping keys: "AGENT" | "AGENT_HIERARCHY_LEVEL_ONE" | "AGENT_HIERARCHY_LEVEL_TWO" | "AGENT_HIERARCHY_LEVEL_THREE" | "AGENT_HIERARCHY_LEVEL_FOUR" | "AGENT_HIERARCHY_LEVEL_FIVE" | "ANSWERING_MACHINE_DETECTION_STATUS" | "BOT_ID" | "BOT_ALIAS" | "BOT_VERSION" | "BOT_LOCALE" | "BOT_INTENT_NAME" | "CAMPAIGN" | "CAMPAIGN_DELIVERY_EVENT_TYPE" | "CAMPAIGN_EXCLUDED_EVENT_TYPE" | "CAMPAIGN_EXECUTION_TIMESTAMP" | "CASE_TEMPLATE_ARN" | "CASE_STATUS" | "CHANNEL" | "contact/segmentAttributes/connect:Subtype" | "DISCONNECT_REASON" | "EVALUATION_FORM" | "EVALUATION_SECTION" | "EVALUATION_QUESTION" | "EVALUATION_SOURCE" | "FLOWS_RESOURCE_ID" | "FLOWS_MODULE_RESOURCE_ID" | "FLOW_ACTION_ID" | "FLOW_TYPE" | "FLOWS_OUTCOME_TYPE" | "FORM_VERSION" | "INITIATION_METHOD" | "INVOKING_RESOURCE_PUBLISHED_TIMESTAMP" | "INVOKING_RESOURCE_TYPE" | "PARENT_FLOWS_RESOURCE_ID" | "Q_CONNECT_ENABLED" | "QUEUE" | "RESOURCE_PUBLISHED_TIMESTAMP" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION" Type: Array of strings Array Members: Maximum number of 4 items Required: No * *(string) --* * **Metrics** (*list*) -- **[REQUIRED]** The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the *Amazon Connect Administrator Guide*. ABANDONMENT_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Abandonment rate AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherent time AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent non-response without customer abandons AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Occupancy AGENT_SCHEDULE_ADHERENCE This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherence AGENT_SCHEDULED_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Scheduled time AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average queue abandon time AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Average active time AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: "INITIATION_METHOD" Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average after contact work time Note: Feature is a valid filter but not a valid grouping.AVG_AGENT_CONNECTING_TIME Unit: Seconds Valid metric filter key: "INITIATION_METHOD". For now, this metric only supports the following as "INITIATION_METHOD": "INBOUND" | "OUTBOUND" | "CALLBACK" | "API" Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent API connecting time Note: The "Negate" key in metric-level filters is not applicable for this metric.AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Average agent pause time AVG_BOT_CONVERSATION_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID UI name: Average bot conversation time AVG_BOT_CONVERSATION_TURNS Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID UI name: Average bot conversation turns AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average contacts per case AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average case resolution time AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average contact duration Note: Feature is a valid filter but not a valid grouping.AVG_CONTACT_FIRST_RESPONSE_TIME_AGENT Unit: Seconds Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Agent average contact first response wait time AVG_CONVERSATION_CLOSE_TIME Unit: Seconds Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average conversation close time AVG_CONVERSATION_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average conversation duration AVG_DIALS_PER_MINUTE This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes. Unit: Count Valid groupings and filters: Agent, Campaign, Queue, Routing Profile UI name: Average dials per minute AVG_EVALUATION_SCORE Unit: Percent Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile UI name: Average evaluation score AVG_FIRST_RESPONSE_TIME_AGENT Unit: Seconds Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average agent first response time AVG_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Average flow time AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent greeting time AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Average handle time Note: Feature is a valid filter but not a valid grouping.AVG_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer hold time Note: Feature is a valid filter but not a valid grouping.AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer hold time all contacts AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average holds Note: Feature is a valid filter but not a valid grouping.AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interaction and customer hold time AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: "INITIATION_METHOD" Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interaction time Note: Feature is a valid filter but not a valid grouping.AVG_INTERRUPTIONS_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interruptions AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent interruption time AVG_MESSAGE_LENGTH_AGENT Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average agent message length AVG_MESSAGE_LENGTH_CUSTOMER Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average customer message length AVG_MESSAGES Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average messages AVG_MESSAGES_AGENT Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average agent messages AVG_MESSAGES_BOT Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average bot messages AVG_MESSAGES_CUSTOMER Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average customer messages AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average non-talk time AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average queue answer time Note: Feature is a valid filter but not a valid grouping.AVG_RESPONSE_TIME_AGENT Unit: Seconds Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average agent response time AVG_RESPONSE_TIME_CUSTOMER Unit: Seconds Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Average customer response time AVG_RESOLUTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average resolution time AVG_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average talk time AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average agent talk time AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Average customer talk time AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes. Unit: Seconds Valid groupings and filters: Campaign UI name: Average wait time after customer connection AVG_WEIGHTED_EVALUATION_SCORE Unit: Percent Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile UI name: Average weighted evaluation score BOT_CONVERSATIONS_COMPLETED Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID UI name: Bot conversations completed BOT_INTENTS_COMPLETED Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID UI name: Bot intents completed CAMPAIGN_CONTACTS_ABANDONED_AFTER_X This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes. Unit: Count Valid groupings and filters: Agent, Campaign Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you must enter "GT" (for *Greater than*). UI name: Campaign contacts abandoned after X CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes. Unit: Percent Valid groupings and filters: Agent, Campaign Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you must enter "GT" (for *Greater than*). UI name: Campaign contacts abandoned after X rate CAMPAIGN_INTERACTIONS This metric is available only for outbound campaigns using the email delivery mode. Unit: Count Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE Valid groupings and filters: Campaign UI name: Campaign interactions CAMPAIGN_PROGRESS_RATE This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns. Unit: Percent Valid groupings and filters: Campaign, Campaign Execution Timestamp UI name: Campaign progress rate CAMPAIGN_SEND_ATTEMPTS This metric is available only for outbound campaigns. Unit: Count Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype UI name: Campaign send attempts CAMPAIGN_SEND_EXCLUSIONS This metric is available only for outbound campaigns. Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE Unit: Count Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp UI name: Campaign send exclusions CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created CONTACTS_CREATED Unit: Count Valid metric filter key: "INITIATION_METHOD" Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts created Note: Feature is a valid filter but not a valid grouping.CONTACTS_HANDLED Unit: Count Valid metric filter key: "INITIATION_METHOD", "DISCONNECT_REASON" Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect UI name: API contacts handled Note: Feature is a valid filter but not a valid grouping.CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key: "INITIATION_METHOD" Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts handled (connected to agent timestamp) CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts hold disconnect CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts hold agent disconnect CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts hold customer disconnect CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts put on hold CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts transferred out external CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contacts transferred out internal CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts queued CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued (enqueue timestamp) CONTACTS_REMOVED_FROM_QUEUE_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you can use "LT" (for "Less than") or "LTE" (for "Less than equal"). UI name: Contacts removed from queue in X seconds CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you can use "LT" (for "Less than") or "LTE" (for "Less than equal"). UI name: Contacts resolved in X CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out Note: Feature is a valid filter but not a valid grouping.CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out by agent CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contacts transferred out queue CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases CONVERSATIONS_ABANDONED Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect UI name: Conversations abandoned DELIVERY_ATTEMPTS This metric is available only for outbound campaigns. Unit: Count Valid metric filter key: "ANSWERING_MACHINE_DETECTION_STATUS", "CAMPAIGN_DELIVERY_EVENT_TYPE", "DISCONNECT_REASON" Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile UI name: Delivery attempts Note: Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.DELIVERY_ATTEMPT_DISPOSITION_RATE This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. Unit: Percent Valid metric filter key: "ANSWERING_MACHINE_DETECTION_STATUS", "CAMPAIGN_DELIVERY_EVENT_TYPE", "DISCONNECT_REASON" Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile UI name: Delivery attempt disposition rate Note: Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.EVALUATIONS_PERFORMED Unit: Count Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile UI name: Evaluations performed FLOWS_OUTCOME Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows outcome FLOWS_STARTED Unit: Count Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows started HUMAN_ANSWERED_CALLS This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. Unit: Count Valid groupings and filters: Agent, Campaign UI name: Human answered MAX_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Maximum flow time MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Maximum queued time MIN_FLOW_TIME Unit: Seconds Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Minimum flow time PERCENT_AUTOMATIC_FAILS Unit: Percent Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile UI name: Automatic fails percent PERCENT_BOT_CONVERSATIONS_OUTCOME Unit: Percent Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID UI name: Percent bot conversations outcome PERCENT_BOT_INTENTS_OUTCOME Unit: Percent Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID UI name: Percent bot intents outcome PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved on first contact PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI. PERCENT_CONTACTS_STEP_JOINED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI. PERCENT_FLOWS_OUTCOME Unit: Percent Valid metric filter key: "FLOWS_OUTCOME_TYPE" Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp UI name: Flows outcome percentage. Note: The "FLOWS_OUTCOME_TYPE" is not a valid grouping.PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Non-talk time percent PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Talk time percent PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Agent talk time percent PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Customer talk time percent RECIPIENTS_ATTEMPTED This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns. Unit: Count Valid groupings and filters: Campaign, Campaign Execution Timestamp UI name: Recipients attempted RECIPIENTS_INTERACTED This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns. Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE Unit: Count Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp UI name: Recipients interacted RECIPIENTS_TARGETED This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns. Unit: Count Valid groupings and filters: Campaign, Campaign Execution Timestamp UI name: Recipients targeted REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you can use "LT" (for "Less than") or "LTE" (for "Less than equal"). UI name: Service level X STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, RoutingStepExpression UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI. SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: After contact work time SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: "INITIATION_METHOD". This metric only supports the following filter keys as "INITIATION_METHOD": "INBOUND" | "OUTBOUND" | "CALLBACK" | "API" Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent API connecting time Note: The "Negate" key in metric-level filters is not applicable for this metric.CONTACTS_ABANDONED Unit: Count Metric filter: * Valid values: "API``| ``Incoming" | "Outbound" | "Transfer" | "Callback" | "Queue_Transfer``| ``Disconnect" Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect UI name: Contact abandoned SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you can use "LT" (for "Less than") or "LTE" (for "Less than equal"). UI name: Contacts abandoned in X seconds SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect Threshold: For "ThresholdValue", enter any whole number from 1 to 604800 (inclusive), in seconds. For "Comparison", you can use "LT" (for "Less than") or "LTE" (for "Less than equal"). UI name: Contacts answered in X seconds SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contact flow time SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time SUM_CONTACTS_DISCONNECTED Valid metric filter key: "DISCONNECT_REASON" Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Contact disconnected SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Error status time SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Contact handle time SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Customer hold time SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent idle time SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect UI name: Agent interaction and hold time SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent non-productive time SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Online time SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect UI name: Callback attempts * *(dict) --* Contains information about the metric. * **Name** *(string) --* The name of the metric. Warning: This parameter is required. The following Required = No is incorrect. * **Threshold** *(list) --* Contains information about the threshold for service level metrics. * *(dict) --* Contains information about the threshold for service level metrics. * **Comparison** *(string) --* The type of comparison. Currently, "less than" (LT), "less than equal" (LTE), and "greater than" (GT) comparisons are supported. * **ThresholdValue** *(float) --* The threshold value to compare. * **MetricFilters** *(list) --* Contains the filters to be used when returning data. * *(dict) --* Contains information about the filter used when retrieving metrics. "MetricFiltersV2" can be used on the following metrics: "AVG_AGENT_CONNECTING_TIME", "CONTACTS_CREATED", "CONTACTS_HANDLED", "SUM_CONTACTS_DISCONNECTED". * **MetricFilterKey** *(string) --* The key to use for filtering data. Valid metric filter keys: * ANSWERING_MACHINE_DETECTION_STATUS * CASE_STATUS * DISCONNECT_REASON * FLOWS_ACTION_IDENTIFIER * FLOWS_NEXT_ACTION_IDENTIFIER * FLOWS_OUTCOME_TYPE * FLOWS_RESOURCE_TYPE * INITIATION_METHOD * **MetricFilterValues** *(list) --* The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case. For valid values of metric-level filters "INITIATION_METHOD", "DISCONNECT_REASON", and "ANSWERING_MACHINE_DETECTION_STATUS", see ContactTraceRecord in the *Amazon Connect Administrator Guide*. For valid values of the metric-level filter "FLOWS_OUTCOME_TYPE", see the description for the Flow outcome metric in the *Amazon Connect Administrator Guide*. For valid values of the metric-level filter "BOT_CONVERSATION_OUTCOME_TYPE", see the description for the Bot conversations completed in the *Amazon Connect Administrator Guide*. For valid values of the metric-level filter "BOT_INTENT_OUTCOME_TYPE", see the description for the Bot intents completed metric in the *Amazon Connect Administrator Guide*. * *(string) --* * **Negate** *(boolean) --* If set to "true", the API response contains results that filter out the results matched by the metric- level filters condition. By default, "Negate" is set to "false". * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'MetricResults': [ { 'Dimensions': { 'string': 'string' }, 'MetricInterval': { 'Interval': 'FIFTEEN_MIN'|'THIRTY_MIN'|'HOUR'|'DAY'|'WEEK'|'TOTAL', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, 'Collections': [ { 'Metric': { 'Name': 'string', 'Threshold': [ { 'Comparison': 'string', 'ThresholdValue': 123.0 }, ], 'MetricFilters': [ { 'MetricFilterKey': 'string', 'MetricFilterValues': [ 'string', ], 'Negate': True|False }, ] }, 'Value': 123.0 }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **MetricResults** *(list) --* Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned. * *(dict) --* Contains information about the metric results. * **Dimensions** *(dict) --* The dimension for the metrics. * *(string) --* * *(string) --* * **MetricInterval** *(dict) --* The interval period with the start and end time for the metrics. * **Interval** *(string) --* The interval period provided in the API request. * **StartTime** *(datetime) --* The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected. * **EndTime** *(datetime) --* The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If "IntervalPeriod" is selected "THIRTY_MIN", "StartTime" and "EndTime" in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each "StartTime" and "EndTime" differing by 30 minutes. * **Collections** *(list) --* The set of metrics. * *(dict) --* Contains the name, thresholds, and metric filters. * **Metric** *(dict) --* The metric name, thresholds, and metric filters of the returned metric. * **Name** *(string) --* The name of the metric. Warning: This parameter is required. The following Required = No is incorrect. * **Threshold** *(list) --* Contains information about the threshold for service level metrics. * *(dict) --* Contains information about the threshold for service level metrics. * **Comparison** *(string) --* The type of comparison. Currently, "less than" (LT), "less than equal" (LTE), and "greater than" (GT) comparisons are supported. * **ThresholdValue** *(float) --* The threshold value to compare. * **MetricFilters** *(list) --* Contains the filters to be used when returning data. * *(dict) --* Contains information about the filter used when retrieving metrics. "MetricFiltersV2" can be used on the following metrics: "AVG_AGENT_CONNECTING_TIME", "CONTACTS_CREATED", "CONTACTS_HANDLED", "SUM_CONTACTS_DISCONNECTED". * **MetricFilterKey** *(string) --* The key to use for filtering data. Valid metric filter keys: * ANSWERING_MACHINE_DETECTION_STATUS * CASE_STATUS * DISCONNECT_REASON * FLOWS_ACTION_IDENTIFIER * FLOWS_NEXT_ACTION_IDENTIFIER * FLOWS_OUTCOME_TYPE * FLOWS_RESOURCE_TYPE * INITIATION_METHOD * **MetricFilterValues** *(list) --* The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case. For valid values of metric-level filters "INITIATION_METHOD", "DISCONNECT_REASON", and "ANSWERING_MACHINE_DETECTION_STATUS", see ContactTraceRecord in the *Amazon Connect Administrator Guide*. For valid values of the metric-level filter "FLOWS_OUTCOME_TYPE", see the description for the Flow outcome metric in the *Amazon Connect Administrator Guide*. For valid values of the metric-level filter "BOT_CONVERSATION_OUTCOME_TYPE", see the description for the Bot conversations completed in the *Amazon Connect Administrator Guide*. For valid values of the metric-level filter "BOT_INTENT_OUTCOME_TYPE", see the description for the Bot intents completed metric in the *Amazon Connect Administrator Guide*. * *(string) --* * **Negate** *(boolean) --* If set to "true", the API response contains results that filter out the results matched by the metric-level filters condition. By default, "Negate" is set to "false". * **Value** *(float) --* The corresponding value of the metric returned in the response. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / update_evaluation_form update_evaluation_form ********************** Connect.Client.update_evaluation_form(**kwargs) Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content. See also: AWS API Documentation **Request Syntax** response = client.update_evaluation_form( InstanceId='string', EvaluationFormId='string', EvaluationFormVersion=123, CreateNewVersion=True|False, Title='string', Description='string', Items=[ { 'Section': { 'Title': 'string', 'RefId': 'string', 'Instructions': 'string', 'Items': {'... recursive ...'}, 'Weight': 123.0 }, 'Question': { 'Title': 'string', 'Instructions': 'string', 'RefId': 'string', 'NotApplicableEnabled': True|False, 'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC', 'QuestionTypeProperties': { 'Numeric': { 'MinValue': 123, 'MaxValue': 123, 'Options': [ { 'MinValue': 123, 'MaxValue': 123, 'Score': 123, 'AutomaticFail': True|False }, ], 'Automation': { 'PropertyValue': { 'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME' } } }, 'SingleSelect': { 'Options': [ { 'RefId': 'string', 'Text': 'string', 'Score': 123, 'AutomaticFail': True|False }, ], 'DisplayAs': 'DROPDOWN'|'RADIO', 'Automation': { 'Options': [ { 'RuleCategory': { 'Category': 'string', 'Condition': 'PRESENT'|'NOT_PRESENT', 'OptionRefId': 'string' } }, ], 'DefaultOptionRefId': 'string' } } }, 'Weight': 123.0 } }, ], ScoringStrategy={ 'Mode': 'QUESTION_ONLY'|'SECTION_ONLY', 'Status': 'ENABLED'|'DISABLED' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **EvaluationFormVersion** (*integer*) -- **[REQUIRED]** A version of the evaluation form to update. * **CreateNewVersion** (*boolean*) -- A flag indicating whether the operation must create a new version. * **Title** (*string*) -- **[REQUIRED]** A title of the evaluation form. * **Description** (*string*) -- The description of the evaluation form. * **Items** (*list*) -- **[REQUIRED]** Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. * *(dict) --* Information about an item from an evaluation form. The item must be either a section or a question. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Section", "Question". * **Section** *(dict) --* The information of the section. * **Title** *(string) --* **[REQUIRED]** The title of the section. * **RefId** *(string) --* **[REQUIRED]** The identifier of the section. An identifier must be unique within the evaluation form. * **Instructions** *(string) --* The instructions of the section. * **Items** *(list) --* The items of the section. * **Weight** *(float) --* The scoring weight of the section. * **Question** *(dict) --* The information of the question. * **Title** *(string) --* **[REQUIRED]** The title of the question. * **Instructions** *(string) --* The instructions of the section. * **RefId** *(string) --* **[REQUIRED]** The identifier of the question. An identifier must be unique within the evaluation form. * **NotApplicableEnabled** *(boolean) --* The flag to enable not applicable answers to the question. * **QuestionType** *(string) --* **[REQUIRED]** The type of the question. * **QuestionTypeProperties** *(dict) --* The properties of the type of question. Text questions do not have to define question type properties. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Numeric", "SingleSelect". * **Numeric** *(dict) --* The properties of the numeric question. * **MinValue** *(integer) --* **[REQUIRED]** The minimum answer value. * **MaxValue** *(integer) --* **[REQUIRED]** The maximum answer value. * **Options** *(list) --* The scoring options of the numeric question. * *(dict) --* Information about the option range used for scoring in numeric questions. * **MinValue** *(integer) --* **[REQUIRED]** The minimum answer value of the range option. * **MaxValue** *(integer) --* **[REQUIRED]** The maximum answer value of the range option. * **Score** *(integer) --* The score assigned to answer values within the range option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **Automation** *(dict) --* The automation properties of the numeric question. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "PropertyValue". * **PropertyValue** *(dict) --* The property value of the automation. * **Label** *(string) --* **[REQUIRED]** The property label of the automation. * **SingleSelect** *(dict) --* The properties of the numeric question. * **Options** *(list) --* **[REQUIRED]** The answer options of the single select question. * *(dict) --* Information about the automation configuration in single select questions. * **RefId** *(string) --* **[REQUIRED]** The identifier of the answer option. An identifier must be unique within the question. * **Text** *(string) --* **[REQUIRED]** The title of the answer option. * **Score** *(integer) --* The score assigned to the answer option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **DisplayAs** *(string) --* The display mode of the single select question. * **Automation** *(dict) --* The display mode of the single select question. * **Options** *(list) --* **[REQUIRED]** The automation options of the single select question. * *(dict) --* Information about the automation option of a single select question. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "RuleCategory". * **RuleCategory** *(dict) --* The automation option based on a rule category for the single select question. * **Category** *(string) --* **[REQUIRED]** The category name, as defined in Rules. * **Condition** *(string) --* **[REQUIRED]** The condition to apply for the automation option. If the condition is "PRESENT", then the option is applied when the contact data includes the category. Similarly, if the condition is "NOT_PRESENT", then the option is applied when the contact data does not include the category. * **OptionRefId** *(string) --* **[REQUIRED]** The identifier of the answer option. * **DefaultOptionRefId** *(string) --* The identifier of the default answer option, when none of the automation options match the criteria. * **Weight** *(float) --* The scoring weight of the section. * **ScoringStrategy** (*dict*) -- A scoring strategy of the evaluation form. * **Mode** *(string) --* **[REQUIRED]** The scoring mode of the evaluation form. * **Status** *(string) --* **[REQUIRED]** The scoring status of the evaluation form. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string', 'EvaluationFormVersion': 123 } **Response Structure** * *(dict) --* * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. * **EvaluationFormVersion** *(integer) --* The version of the updated evaluation form resource. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / delete_contact_flow_module delete_contact_flow_module ************************** Connect.Client.delete_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowModuleId** (*string*) -- **[REQUIRED]** The identifier of the flow module. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_tags_for_resource list_tags_for_resource ********************** Connect.Client.list_tags_for_resource(**kwargs) Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity- Based Policy Examples in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* Information about the tags. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / disassociate_user_proficiencies disassociate_user_proficiencies ******************************* Connect.Client.disassociate_user_proficiencies(**kwargs) Disassociates a set of proficiencies from a user. See also: AWS API Documentation **Request Syntax** response = client.disassociate_user_proficiencies( InstanceId='string', UserId='string', UserProficiencies=[ { 'AttributeName': 'string', 'AttributeValue': 'string' }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **UserProficiencies** (*list*) -- **[REQUIRED]** The proficiencies to disassociate from the user. * *(dict) --* Information about proficiency to be disassociated from the user. * **AttributeName** *(string) --* **[REQUIRED]** The name of user's proficiency. * **AttributeValue** *(string) --* **[REQUIRED]** The value of user's proficiency. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_view describe_view ************* Connect.Client.describe_view(**kwargs) Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN. "$SAVED" needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, ":$SAVED", which is either an actual version number or an Amazon Connect managed qualifier "$SAVED | $LATEST". If it is not supplied, then "$LATEST" is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views. See also: AWS API Documentation **Request Syntax** response = client.describe_view( InstanceId='string', ViewId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The ViewId of the view. This must be an ARN for Amazon Web Services managed views. Return type: dict Returns: **Response Syntax** { 'View': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Status': 'PUBLISHED'|'SAVED', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Description': 'string', 'Version': 123, 'VersionDescription': 'string', 'Content': { 'InputSchema': 'string', 'Template': 'string', 'Actions': [ 'string', ] }, 'Tags': { 'string': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ViewContentSha256': 'string' } } **Response Structure** * *(dict) --* * **View** *(dict) --* All view data is contained within the View object. * **Id** *(string) --* The identifier of the view. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view. * **Name** *(string) --* The name of the view. * **Status** *(string) --* Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Type** *(string) --* The type of the view - "CUSTOMER_MANAGED". * **Description** *(string) --* The description of the view. * **Version** *(integer) --* Current version of the view. * **VersionDescription** *(string) --* The description of the version. * **Content** *(dict) --* View content containing all content necessary to render a view except for runtime input data. * **InputSchema** *(string) --* The data schema matching data that the view template must be provided to render. * **Template** *(string) --* The view template representing the structure of the view. * **Actions** *(list) --* A list of possible actions from the view. * *(string) --* * **Tags** *(dict) --* The tags associated with the view resource (not specific to view version). * *(string) --* * *(string) --* * **CreatedTime** *(datetime) --* The timestamp of when the view was created. * **LastModifiedTime** *(datetime) --* Latest timestamp of the "UpdateViewContent" or "CreateViewVersion" operations. * **ViewContentSha256** *(string) --* Indicates the checksum value of the latest published view content. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" Connect / Client / create_instance create_instance *************** Connect.Client.create_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. For more information, see Create an Amazon Connect instance in the *Amazon Connect Administrator Guide*. 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, Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*string*) -- The idempotency token. This field is autopopulated if not provided. * **IdentityManagementType** (*string*) -- **[REQUIRED]** The type of identity management for your Amazon Connect users. * **InstanceAlias** (*string*) -- The name for your instance. * **DirectoryId** (*string*) -- The identifier for the directory. * **InboundCallsEnabled** (*boolean*) -- **[REQUIRED]** Your contact center handles incoming contacts. * **OutboundCallsEnabled** (*boolean*) -- **[REQUIRED]** Your contact center allows outbound calls. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, "{ "tags": {"key1":"value1", "key2":"value2"} }". * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_agent_statuses list_agent_statuses ******************* Connect.Client.list_agent_statuses(**kwargs) 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', ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **AgentStatusTypes** (*list*) -- Available agent status types. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'AgentStatusSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ] } **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_user_hierarchy update_user_hierarchy ********************* Connect.Client.update_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' ) Parameters: * **HierarchyGroupId** (*string*) -- The identifier of the hierarchy group. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_traffic_distribution_groups list_traffic_distribution_groups ******************************** Connect.Client.list_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' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **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', 'IsDefault': True|False }, ] } **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. * **IsDefault** *(boolean) --* Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the "DeleteTrafficDistributionGroup" API. The default traffic distribution group is deleted as part of the process for deleting a replica. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_vocabulary delete_vocabulary ***************** Connect.Client.delete_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **VocabularyId** (*string*) -- **[REQUIRED]** The identifier of the custom vocabulary. Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / describe_security_profile describe_security_profile ************************* Connect.Client.describe_security_profile(**kwargs) Gets basic information about the security profile. For information about security profiles, see Security Profiles in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_security_profile( SecurityProfileId='string', InstanceId='string' ) Parameters: * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** { 'SecurityProfile': { 'Id': 'string', 'OrganizationResourceId': 'string', 'Arn': 'string', 'SecurityProfileName': 'string', 'Description': 'string', 'Tags': { 'string': 'string' }, 'AllowedAccessControlTags': { 'string': 'string' }, 'TagRestrictedResources': [ 'string', ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string', 'HierarchyRestrictedResources': [ 'string', ], 'AllowedAccessControlHierarchyGroupId': '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 security 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"} }. * *(string) --* * *(string) --* * **AllowedAccessControlTags** *(dict) --* The list of tags that a security profile uses to restrict access to resources in Amazon Connect. * *(string) --* * *(string) --* * **TagRestrictedResources** *(list) --* The list of resources that a security profile applies tag restrictions to in Amazon Connect. * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **HierarchyRestrictedResources** *(list) --* The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: "User". * *(string) --* * **AllowedAccessControlHierarchyGroupId** *(string) --* The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_routing_profile_queues list_routing_profile_queues *************************** Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'RoutingProfileQueueConfigSummaryList': [ { 'QueueId': 'string', 'QueueArn': 'string', 'QueueName': 'string', 'Priority': 123, 'Delay': 123, 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL' }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / send_chat_integration_event send_chat_integration_event *************************** Connect.Client.send_chat_integration_event(**kwargs) Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes: * SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat * ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration. See also: AWS API Documentation **Request Syntax** response = client.send_chat_integration_event( SourceId='string', DestinationId='string', Subtype='string', Event={ 'Type': 'DISCONNECT'|'MESSAGE'|'EVENT', 'ContentType': 'string', 'Content': 'string' }, NewSessionDetails={ 'SupportedMessagingContentTypes': [ 'string', ], 'ParticipantDetails': { 'DisplayName': 'string' }, 'Attributes': { 'string': 'string' }, 'StreamingConfiguration': { 'StreamingEndpointArn': 'string' } } ) Parameters: * **SourceId** (*string*) -- **[REQUIRED]** External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant. * **DestinationId** (*string*) -- **[REQUIRED]** Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN. * **Subtype** (*string*) -- Classification of a channel. This is used in part to uniquely identify chat. Valid value: "["connect:sms", connect:"WhatsApp"]" * **Event** (*dict*) -- **[REQUIRED]** Chat integration event payload * **Type** *(string) --* **[REQUIRED]** Type of chat integration event. * **ContentType** *(string) --* Type of content. This is required when "Type" is "MESSAGE" or "EVENT". * For allowed message content types, see the "ContentType" parameter in the SendMessage topic in the *Amazon Connect Participant Service API Reference*. * For allowed event content types, see the "ContentType" parameter in the SendEvent topic in the *Amazon Connect Participant Service API Reference*. * **Content** *(string) --* Content of the message or event. This is required when "Type" is "MESSAGE" and for certain "ContentTypes" when "Type" is "EVENT". * For allowed message content, see the "Content" parameter in the SendMessage topic in the *Amazon Connect Participant Service API Reference*. * For allowed event content, see the "Content" parameter in the SendEvent topic in the *Amazon Connect Participant Service API Reference*. * **NewSessionDetails** (*dict*) -- Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored. * **SupportedMessagingContentTypes** *(list) --* The supported chat message content types. Supported types are "text/plain", "text/markdown", "application/json", "application/vnd.amazonaws.connect.message.interactive", and "application/vnd.amazonaws.connect.message.interactive.resp onse". Content types must always contain "text/plain". You can then put any other supported type in the list. For example, all the following lists are valid because they contain "text/plain": "[text/plain, text/markdown, application/json]", "[text/markdown, text/plain]", "[text/plain, application/json, application/vnd.amazonaws.c onnect.message.interactive.response]". * *(string) --* * **ParticipantDetails** *(dict) --* The customer's details. * **DisplayName** *(string) --* **[REQUIRED]** Display name of the participant. * **Attributes** *(dict) --* 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. * *(string) --* * *(string) --* * **StreamingConfiguration** *(dict) --* The streaming configuration, such as the Amazon SNS streaming endpoint. * **StreamingEndpointArn** *(string) --* **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'InitialContactId': 'string', 'NewChatCreated': True|False } **Response Structure** * *(dict) --* * **InitialContactId** *(string) --* Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact. * **NewChatCreated** *(boolean) --* Whether handling the integration event resulted in creating a new chat or acting on existing chat. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / describe_quick_connect describe_quick_connect ********************** Connect.Client.describe_quick_connect(**kwargs) Describes the quick connect. See also: AWS API Documentation **Request Syntax** response = client.describe_quick_connect( InstanceId='string', QuickConnectId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QuickConnectId** (*string*) -- **[REQUIRED]** The identifier for the quick connect. Return type: dict Returns: **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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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 admin website, 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / untag_resource untag_resource ************** Connect.Client.untag_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', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys. * *(string) --* Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / disassociate_queue_quick_connects disassociate_queue_quick_connects ********************************* Connect.Client.disassociate_queue_quick_connects(**kwargs) 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', ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **QuickConnectIds** (*list*) -- **[REQUIRED]** The quick connects to disassociate from the queue. * *(string) --* Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_task_template update_task_template ******************** Connect.Client.update_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', SelfAssignFlowId='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'|'SELF_ASSIGN'|'EXPIRY_DURATION', 'SingleSelectOptions': [ 'string', ] }, ] ) Parameters: * **TaskTemplateId** (*string*) -- **[REQUIRED]** A unique identifier for the task template. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **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. * **SelfAssignFlowId** (*string*) -- The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task. * **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. * **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. * **Fields** (*list*) -- Fields that are part of the template. * *(dict) --* Describes a single task template field. * **Id** *(dict) --* **[REQUIRED]** 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. * *(string) --* Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Description': 'string', 'ContactFlowId': 'string', 'SelfAssignFlowId': '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'|'SELF_ASSIGN'|'EXPIRY_DURATION', '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 instance ID in the Amazon Resource Name (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. * **SelfAssignFlowId** *(string) --* The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task. * **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. * *(string) --* * **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.PropertyValidationException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_email_address delete_email_address ******************** Connect.Client.delete_email_address(**kwargs) Deletes email address from the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.delete_email_address( InstanceId='string', EmailAddressId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EmailAddressId** (*string*) -- **[REQUIRED]** The identifier of the email address. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / list_realtime_contact_analysis_segments_v2 list_realtime_contact_analysis_segments_v2 ****************************************** Connect.Client.list_realtime_contact_analysis_segments_v2(**kwargs) Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. Warning: This API does not support VOICE. If you attempt to use it for VOICE, an "InvalidRequestException" occurs. See also: AWS API Documentation **Request Syntax** response = client.list_realtime_contact_analysis_segments_v2( InstanceId='string', ContactId='string', MaxResults=123, NextToken='string', OutputType='Raw'|'Redacted', SegmentTypes=[ 'Transcript'|'Categories'|'Issues'|'Event'|'Attachments'|'PostContactSummary', ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **OutputType** (*string*) -- **[REQUIRED]** The Contact Lens output type to be returned. * **SegmentTypes** (*list*) -- **[REQUIRED]** Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Channel': 'VOICE'|'CHAT', 'Status': 'IN_PROGRESS'|'FAILED'|'COMPLETED', 'Segments': [ { 'Transcript': { 'Id': 'string', 'ParticipantId': 'string', 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'DisplayName': 'string', 'Content': 'string', 'ContentType': 'string', 'Time': { 'AbsoluteTime': datetime(2015, 1, 1) }, 'Redaction': { 'CharacterOffsets': [ { 'BeginOffsetChar': 123, 'EndOffsetChar': 123 }, ] }, 'Sentiment': 'POSITIVE'|'NEGATIVE'|'NEUTRAL' }, 'Categories': { 'MatchedDetails': { 'string': { 'PointsOfInterest': [ { 'TranscriptItems': [ { 'Id': 'string', 'CharacterOffsets': { 'BeginOffsetChar': 123, 'EndOffsetChar': 123 } }, ] }, ] } } }, 'Issues': { 'IssuesDetected': [ { 'TranscriptItems': [ { 'Content': 'string', 'Id': 'string', 'CharacterOffsets': { 'BeginOffsetChar': 123, 'EndOffsetChar': 123 } }, ] }, ] }, 'Event': { 'Id': 'string', 'ParticipantId': 'string', 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'DisplayName': 'string', 'EventType': 'string', 'Time': { 'AbsoluteTime': datetime(2015, 1, 1) } }, 'Attachments': { 'Id': 'string', 'ParticipantId': 'string', 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'DisplayName': 'string', 'Attachments': [ { 'AttachmentName': 'string', 'ContentType': 'string', 'AttachmentId': 'string', 'Status': 'APPROVED'|'REJECTED'|'IN_PROGRESS' }, ], 'Time': { 'AbsoluteTime': datetime(2015, 1, 1) } }, 'PostContactSummary': { 'Content': 'string', 'Status': 'FAILED'|'COMPLETED', 'FailureCode': 'QUOTA_EXCEEDED'|'INSUFFICIENT_CONVERSATION_CONTENT'|'FAILED_SAFETY_GUIDELINES'|'INVALID_ANALYSIS_CONFIGURATION'|'INTERNAL_ERROR' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Channel** *(string) --* The channel of the contact. Warning: Only "CHAT" is supported. This API does not support "VOICE". If you attempt to use it for the VOICE channel, an "InvalidRequestException" error occurs. * **Status** *(string) --* Status of real-time contact analysis. * **Segments** *(list) --* An analyzed transcript or category. * *(dict) --* An analyzed segment for a real-time analysis session. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Transcript", "Categories", "Issues", "Event", "Attachments", "PostContactSummary". 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'} * **Transcript** *(dict) --* The analyzed transcript segment. * **Id** *(string) --* The identifier of the transcript. * **ParticipantId** *(string) --* The identifier of the participant. * **ParticipantRole** *(string) --* The role of the participant. For example, is it a customer, agent, or system. * **DisplayName** *(string) --* The display name of the participant. * **Content** *(string) --* The content of the transcript. Can be redacted. * **ContentType** *(string) --* The type of content of the item. For example, "text/plain". * **Time** *(dict) --* Field describing the time of the event. It can have different representations of time. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "AbsoluteTime". 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'} * **AbsoluteTime** *(datetime) --* Time represented in ISO 8601 format: yyyy-MM- ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. * **Redaction** *(dict) --* Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted. * **CharacterOffsets** *(list) --* List of character intervals each describing a part of the text that was redacted. For "OutputType.Raw", part of the original text that contains data that can be redacted. For "OutputType.Redacted", part of the string with redaction tag. * *(dict) --* Begin and end offsets for a part of text. * **BeginOffsetChar** *(integer) --* The beginning of the character interval. * **EndOffsetChar** *(integer) --* The end of the character interval. * **Sentiment** *(string) --* The sentiment detected for this piece of transcript. * **Categories** *(dict) --* The matched category rules. * **MatchedDetails** *(dict) --* Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails. * *(string) --* * *(dict) --* Provides information about the category rule that was matched. * **PointsOfInterest** *(list) --* List of PointOfInterest - objects describing a single match of a rule. * *(dict) --* The section of the contact transcript segment that category rule was detected. * **TranscriptItems** *(list) --* List of the transcript items (segments) that are associated with a given point of interest. * *(dict) --* Transcript representation containing Id and list of character intervals that are associated with analysis data. For example, this object within a "RealTimeContactAnalysisPointOfInterest" in "Category.MatchedDetails" would have character interval describing part of the text that matched category. * **Id** *(string) --* Transcript identifier. Matches the identifier from one of the TranscriptSegments. * **CharacterOffsets** *(dict) --* List of character intervals within transcript content/text. * **BeginOffsetChar** *(integer) --* The beginning of the character interval. * **EndOffsetChar** *(integer) --* The end of the character interval. * **Issues** *(dict) --* Segment type containing a list of detected issues. * **IssuesDetected** *(list) --* List of the issues detected. * *(dict) --* Potential issues that are detected based on an artificial intelligence analysis of each turn in the conversation. * **TranscriptItems** *(list) --* List of the transcript items (segments) that are associated with a given issue. * *(dict) --* Transcript representation containing Id, Content and list of character intervals that are associated with analysis data. For example, this object within an issue detected would describe both content that contains identified issue and intervals where that content is taken from. * **Content** *(string) --* Part of the transcript content that contains identified issue. Can be redacted * **Id** *(string) --* Transcript identifier. Matches the identifier from one of the TranscriptSegments. * **CharacterOffsets** *(dict) --* Begin and end offsets for a part of text. * **BeginOffsetChar** *(integer) --* The beginning of the character interval. * **EndOffsetChar** *(integer) --* The end of the character interval. * **Event** *(dict) --* Segment type describing a contact event. * **Id** *(string) --* The identifier of the contact event. * **ParticipantId** *(string) --* The identifier of the participant. * **ParticipantRole** *(string) --* The role of the participant. For example, is it a customer, agent, or system. * **DisplayName** *(string) --* The display name of the participant. Can be redacted. * **EventType** *(string) --* Type of the event. For example, "application/vnd.amaz onaws.connect.event.participant.left". * **Time** *(dict) --* Field describing the time of the event. It can have different representations of time. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "AbsoluteTime". 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'} * **AbsoluteTime** *(datetime) --* Time represented in ISO 8601 format: yyyy-MM- ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. * **Attachments** *(dict) --* The analyzed attachments. * **Id** *(string) --* The identifier of the segment. * **ParticipantId** *(string) --* The identifier of the participant. * **ParticipantRole** *(string) --* The role of the participant. For example, is it a customer, agent, or system. * **DisplayName** *(string) --* The display name of the participant. Can be redacted. * **Attachments** *(list) --* List of objects describing an individual attachment. * *(dict) --* Object that describes attached file. * **AttachmentName** *(string) --* A case-sensitive name of the attachment being uploaded. Can be redacted. * **ContentType** *(string) --* Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the *Amazon Connect Administrator Guide*. * **AttachmentId** *(string) --* A unique identifier for the attachment. * **Status** *(string) --* Status of the attachment. * **Time** *(dict) --* Field describing the time of the event. It can have different representations of time. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "AbsoluteTime". 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'} * **AbsoluteTime** *(datetime) --* Time represented in ISO 8601 format: yyyy-MM- ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. * **PostContactSummary** *(dict) --* Information about the post-contact summary. * **Content** *(string) --* The content of the summary. * **Status** *(string) --* Whether the summary was successfully COMPLETED or FAILED to be generated. * **FailureCode** *(string) --* If the summary failed to be generated, one of the following failure codes occurs: * "QUOTA_EXCEEDED": The number of concurrent analytics jobs reached your service quota. * "INSUFFICIENT_CONVERSATION_CONTENT": The conversation needs to have at least one turn from both the participants in order to generate the summary. * "FAILED_SAFETY_GUIDELINES": The generated summary cannot be provided because it failed to meet system safety guidelines. * "INVALID_ANALYSIS_CONFIGURATION": This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post- contact summaries. * "INTERNAL_ERROR": Internal system error. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.OutputTypeNotFoundException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / start_contact_recording start_contact_recording *********************** Connect.Client.start_contact_recording(**kwargs) Starts recording the contact: * If the API is called *before* the agent joins the call, recording starts when the agent joins the call. * If the API is called *after* the agent joins the call, recording starts at the time of the API call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time. 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', 'IvrRecordingTrack': 'ALL' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **InitialContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. * **VoiceRecordingConfiguration** (*dict*) -- **[REQUIRED]** The person being recorded. * **VoiceRecordingTrack** *(string) --* Identifies which track is being recorded. * **IvrRecordingTrack** *(string) --* Identifies which IVR track is being recorded. One and only one of the track configurations should be presented in the request. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_contact create_contact ************** Connect.Client.create_contact(**kwargs) Warning: Only the VOICE, EMAIL, and TASK channels are supported. * For VOICE: The supported initiation method is "TRANSFER". The contacts created with this initiation method have a subtype "connect:ExternalAudio". * For EMAIL: The supported initiation methods are "OUTBOUND", "AGENT_REPLY", and "FLOW". * For TASK: The supported initiation method is "API". Contacts created with this API have a sub-type of "connect:ExternalTask". Creates a new VOICE, EMAIL, or TASK contact. After a contact is created, you can move it to the desired state by using the "InitiateAs" parameter. While you can use API to create task contacts that are in the "COMPLETED" state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough. See also: AWS API Documentation **Request Syntax** response = client.create_contact( InstanceId='string', ClientToken='string', RelatedContactId='string', Attributes={ 'string': 'string' }, References={ 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } }, Channel='VOICE'|'CHAT'|'TASK'|'EMAIL', InitiationMethod='INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', ExpiryDurationInMinutes=123, UserInfo={ 'UserId': 'string' }, InitiateAs='CONNECTED_TO_USER'|'COMPLETED', Name='string', Description='string', SegmentAttributes={ 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } }, PreviousContactId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **RelatedContactId** (*string*) -- The identifier of the contact in this instance of Amazon Connect. * **Attributes** (*dict*) -- 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. * *(string) --* * *(string) --* * **References** (*dict*) -- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: "URL" | "NUMBER" | "STRING" | "DATE" | "EMAIL" | "ATTACHMENT". * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **Channel** (*string*) -- **[REQUIRED]** The channel for the contact. Warning: The CHAT channel is not supported. The following information is incorrect. We're working to correct it. * **InitiationMethod** (*string*) -- **[REQUIRED]** Indicates how the contact was initiated. Warning: CreateContact only supports the following initiation methods. Valid values by channel are: * For VOICE: "TRANSFER" and the subtype "connect:ExternalAudio" * For EMAIL: "OUTBOUND" | "AGENT_REPLY" | "FLOW" * For TASK: "API" The other channels listed below are incorrect. We're working to correct this information. * **ExpiryDurationInMinutes** (*integer*) -- Number of minutes the contact will be active for before expiring * **UserInfo** (*dict*) -- User details for the contact Warning: UserInfo is required when creating an EMAIL contact with "OUTBOUND" and "AGENT_REPLY" contact initiation methods. * **UserId** *(string) --* The user identifier for the contact. * **InitiateAs** (*string*) -- Initial state of the contact when it's created. Only TASK channel contacts can be initiated with "COMPLETED" state. * **Name** (*string*) -- The name of a the contact. * **Description** (*string*) -- A description of the contact. * **SegmentAttributes** (*dict*) -- A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows. Attribute keys can include only alphanumeric, -, and _. This field can be used to set Segment Contact Expiry as a duration in minutes. Note: To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with "SegmentAttributes" like { ""connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}". * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. * **PreviousContactId** (*string*) -- The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the *Amazon Connect Administrator Guide*. Return type: dict Returns: **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 created contact. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.ConflictException" * "Connect.Client.exceptions.ServiceQuotaExceededException" Connect / Client / create_routing_profile create_routing_profile ********************** Connect.Client.create_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'|'EMAIL' }, 'Priority': 123, 'Delay': 123 }, ], MediaConcurrencies=[ { 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'Concurrency': 123, 'CrossChannelBehavior': { 'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL' } }, ], Tags={ 'string': 'string' }, AgentAvailabilityTimer='TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the routing profile. Must not be more than 127 characters. * **Description** (*string*) -- **[REQUIRED]** Description of the routing profile. Must not be more than 250 characters. * **DefaultOutboundQueueId** (*string*) -- **[REQUIRED]** The default outbound queue for the routing profile. * **QueueConfigs** (*list*) -- The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls. The limit of 10 array members applies to the maximum number of "RoutingProfileQueueConfig" objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas. * *(dict) --* Contains information about the queue and channel for which priority and delay can be set. * **QueueReference** *(dict) --* **[REQUIRED]** Contains information about a queue resource. * **QueueId** *(string) --* **[REQUIRED]** The identifier for the queue. * **Channel** *(string) --* **[REQUIRED]** The channels agents can handle in the Contact Control Panel (CCP) for this routing profile. * **Priority** *(integer) --* **[REQUIRED]** The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay. * **Delay** *(integer) --* **[REQUIRED]** 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*. * **MediaConcurrencies** (*list*) -- **[REQUIRED]** The channels that 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) --* **[REQUIRED]** The channels that agents can handle in the Contact Control Panel (CCP). * **Concurrency** *(integer) --* **[REQUIRED]** 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. * **CrossChannelBehavior** *(dict) --* Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel. * **BehaviorType** *(string) --* **[REQUIRED]** Specifies the other channels that can be routed to an agent handling their current channel. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **AgentAvailabilityTimer** (*string*) -- Whether agents with this routing profile will have their routing order calculated based on *longest idle time* or *time since their last inbound contact*. Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_vocabularies search_vocabularies ******************* Connect.Client.search_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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **State** (*string*) -- The current state of the custom vocabulary. * **NameStartsWith** (*string*) -- The starting pattern of the name of the 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? Return type: dict Returns: **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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', '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.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / disassociate_routing_profile_queues disassociate_routing_profile_queues *********************************** Connect.Client.disassociate_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'|'EMAIL' }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **QueueReferences** (*list*) -- **[REQUIRED]** The queues to disassociate from this routing profile. * *(dict) --* Contains the channel and queue identifier for a routing profile. * **QueueId** *(string) --* **[REQUIRED]** The identifier for the queue. * **Channel** *(string) --* **[REQUIRED]** The channels agents can handle in the Contact Control Panel (CCP) for this routing profile. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_queues search_queues ************* Connect.Client.search_queues(**kwargs) 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return queues. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return queues. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return queues. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **QueueTypeCondition** *(string) --* The type of queue. Return type: dict Returns: **Response Syntax** { 'Queues': [ { 'Name': 'string', 'QueueArn': 'string', 'QueueId': 'string', 'Description': 'string', 'OutboundCallerConfig': { 'OutboundCallerIdName': 'string', 'OutboundCallerIdNumberId': 'string', 'OutboundFlowId': 'string' }, 'OutboundEmailConfig': { 'OutboundEmailAddressId': 'string' }, 'HoursOfOperationId': 'string', 'MaxContacts': 123, 'Status': 'ENABLED'|'DISABLED', 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **OutboundEmailConfig** *(dict) --* The outbound email address ID for a specified queue. * **OutboundEmailAddressId** *(string) --* The identifier of the email address. * **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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_security_keys list_security_keys ****************** Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / get_waiter get_waiter ********** Connect.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Connect / Client / update_routing_profile_concurrency update_routing_profile_concurrency ********************************** Connect.Client.update_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'|'EMAIL', 'Concurrency': 123, 'CrossChannelBehavior': { 'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL' } }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **MediaConcurrencies** (*list*) -- **[REQUIRED]** The channels that agents can handle in the Contact Control Panel (CCP). * *(dict) --* Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously. * **Channel** *(string) --* **[REQUIRED]** The channels that agents can handle in the Contact Control Panel (CCP). * **Concurrency** *(integer) --* **[REQUIRED]** 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. * **CrossChannelBehavior** *(dict) --* Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel. * **BehaviorType** *(string) --* **[REQUIRED]** Specifies the other channels that can be routed to an agent handling their current channel. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / dismiss_user_contact dismiss_user_contact ******************** Connect.Client.dismiss_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' ) Parameters: * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_instance_attribute update_instance_attribute ************************* Connect.Client.update_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'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE', Value='string', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AttributeType** (*string*) -- **[REQUIRED]** The type of attribute. Note: Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web ServicesSupport for allowlisting. * **Value** (*string*) -- **[REQUIRED]** The value for the attribute. Maximum character limit is 100. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / delete_security_profile delete_security_profile *********************** Connect.Client.delete_security_profile(**kwargs) Deletes a security profile. See also: AWS API Documentation **Request Syntax** response = client.delete_security_profile( InstanceId='string', SecurityProfileId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / search_hours_of_operations search_hours_of_operations ************************** Connect.Client.search_hours_of_operations(**kwargs) Searches the hours of operation in an Amazon Connect instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_hours_of_operations( 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' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return hours of operations. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return hours of operations. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return hours of operations. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "name", "description", "timezone", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. Return type: dict Returns: **Response Syntax** { 'HoursOfOperations': [ { '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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **HoursOfOperations** *(list) --* Information about the hours of operations. * *(dict) --* Information about of 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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of hours of operations which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_rule update_rule *********** Connect.Client.update_rule(**kwargs) Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule. See also: AWS API Documentation **Request Syntax** response = client.update_rule( RuleId='string', InstanceId='string', Name='string', Function='string', Actions=[ { 'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION', 'TaskAction': { 'Name': 'string', 'Description': 'string', 'ContactFlowId': 'string', 'References': { 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } } }, 'EventBridgeAction': { 'Name': 'string' }, 'AssignContactCategoryAction': {} , 'SendNotificationAction': { 'DeliveryMethod': 'EMAIL', 'Subject': 'string', 'Content': 'string', 'ContentType': 'PLAIN_TEXT', 'Recipient': { 'UserTags': { 'string': 'string' }, 'UserIds': [ 'string', ] } }, 'CreateCaseAction': { 'Fields': [ { 'Id': 'string', 'Value': { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {} , 'StringValue': 'string' } }, ], 'TemplateId': 'string' }, 'UpdateCaseAction': { 'Fields': [ { 'Id': 'string', 'Value': { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {} , 'StringValue': 'string' } }, ] }, 'AssignSlaAction': { 'SlaAssignmentType': 'CASES', 'CaseSlaConfiguration': { 'Name': 'string', 'Type': 'CaseField', 'FieldId': 'string', 'TargetFieldValues': [ { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {} , 'StringValue': 'string' }, ], 'TargetSlaMinutes': 123 } }, 'EndAssociatedTasksAction': {} , 'SubmitAutoEvaluationAction': { 'EvaluationFormId': 'string' } }, ], PublishStatus='DRAFT'|'PUBLISHED' ) Parameters: * **RuleId** (*string*) -- **[REQUIRED]** A unique identifier for the rule. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the rule. You can change the name only if "TriggerEventSource" is one of the following values: "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **Function** (*string*) -- **[REQUIRED]** The conditions of the rule. * **Actions** (*list*) -- **[REQUIRED]** A list of actions to be run when the rule is triggered. * *(dict) --* Information about the action to be performed when a rule is triggered. * **ActionType** *(string) --* **[REQUIRED]** The type of action that creates a rule. * **TaskAction** *(dict) --* Information about the task action. This field is required if "TriggerEventSource" is one of the following values: "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **Name** *(string) --* **[REQUIRED]** The name. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **Description** *(string) --* The description. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **ContactFlowId** *(string) --* **[REQUIRED]** The identifier of the flow. * **References** *(dict) --* Information about the reference when the "referenceType" is "URL". Otherwise, null. (Supports variable injection in the "Value" field.) * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **EventBridgeAction** *(dict) --* Information about the EventBridge action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnContactEvaluationSubmit" | "OnMetricDataUpdate" * **Name** *(string) --* **[REQUIRED]** The name. * **AssignContactCategoryAction** *(dict) --* Information about the contact category action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **SendNotificationAction** *(dict) --* Information about the send notification action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnContactEvaluationSubmit" | "OnMetricDataUpdate" * **DeliveryMethod** *(string) --* **[REQUIRED]** Notification delivery method. * **Subject** *(string) --* The subject of the email if the delivery method is "EMAIL". Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **Content** *(string) --* **[REQUIRED]** Notification content. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **ContentType** *(string) --* **[REQUIRED]** Content type format. * **Recipient** *(dict) --* **[REQUIRED]** Notification recipient. * **UserTags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified. * *(string) --* * *(string) --* * **UserIds** *(list) --* A list of user IDs. Supports variable injection of "$.ContactLens.ContactEvaluation.Agent.AgentId" for "OnContactEvaluationSubmit" event source. * *(string) --* * **CreateCaseAction** *(dict) --* Information about the create case action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnPostChatAnalysisAvailable". * **Fields** *(list) --* **[REQUIRED]** An array of objects with "Field ID" and "Value" data. * *(dict) --* Object for case field values. * **Id** *(string) --* **[REQUIRED]** Unique identifier of a field. * **Value** *(dict) --* **[REQUIRED]** Union of potential field value types. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **TemplateId** *(string) --* **[REQUIRED]** A unique identifier of a template. * **UpdateCaseAction** *(dict) --* Information about the update case action. Supported only for "TriggerEventSource" values: "OnCaseCreate" | "OnCaseUpdate". * **Fields** *(list) --* **[REQUIRED]** An array of objects with "Field ID" and Value data. * *(dict) --* Object for case field values. * **Id** *(string) --* **[REQUIRED]** Unique identifier of a field. * **Value** *(dict) --* **[REQUIRED]** Union of potential field value types. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **AssignSlaAction** *(dict) --* Information about the assign SLA action. * **SlaAssignmentType** *(string) --* **[REQUIRED]** Type of SLA assignment. * **CaseSlaConfiguration** *(dict) --* The SLA configuration for Case SLA Assignment. * **Name** *(string) --* **[REQUIRED]** Name of an SLA. * **Type** *(string) --* **[REQUIRED]** Type of SLA for Case SlaAssignmentType. * **FieldId** *(string) --* Unique identifier of a Case field. * **TargetFieldValues** *(list) --* Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value. * *(dict) --* Object to store union of Field values. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **TargetSlaMinutes** *(integer) --* **[REQUIRED]** Target duration in minutes within which an SLA should be completed. * **EndAssociatedTasksAction** *(dict) --* Information about the end associated tasks action. Supported only for "TriggerEventSource" values: "OnCaseUpdate". * **SubmitAutoEvaluationAction** *(dict) --* Information about the submit automated evaluation action. * **EvaluationFormId** *(string) --* **[REQUIRED]** The identifier of the auto-evaluation enabled form. * **PublishStatus** (*string*) -- **[REQUIRED]** The publish status of the rule. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / update_contact_flow_metadata update_contact_flow_metadata **************************** Connect.Client.update_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **Name** (*string*) -- The name of the flow. * **Description** (*string*) -- The description of the flow. * **ContactFlowState** (*string*) -- The state of flow. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_analytics_data_set disassociate_analytics_data_set ******************************* Connect.Client.disassociate_analytics_data_set(**kwargs) Removes the dataset ID associated with a given Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.disassociate_analytics_data_set( InstanceId='string', DataSetId='string', TargetAccountId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **DataSetId** (*string*) -- **[REQUIRED]** The identifier of the dataset to remove. * **TargetAccountId** (*string*) -- The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_email_addresses search_email_addresses ********************** Connect.Client.search_email_addresses(**kwargs) Searches email address in an instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_email_addresses( InstanceId='string', MaxResults=123, NextToken='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' } } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **SearchCriteria** (*dict*) -- The search criteria to be used to return email addresses. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return email addresses. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return email addresses. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'EmailAddresses': [ { 'EmailAddressId': 'string', 'EmailAddressArn': 'string', 'EmailAddress': 'string', 'Description': 'string', 'DisplayName': 'string' }, ], 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **EmailAddresses** *(list) --* List of email addresses matching SearchFilter and SearchCriteria * *(dict) --* Contains information about an email address for a contact center. * **EmailAddressId** *(string) --* The identifier of the email address. * **EmailAddressArn** *(string) --* The Amazon Resource Name (ARN) of the email address. * **EmailAddress** *(string) --* The email address, including the domain. * **Description** *(string) --* The description of the email address. * **DisplayName** *(string) --* The display name of email address. * **ApproximateTotalCount** *(integer) --* The total number of email addresses which matched your search query. **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_contact_streaming start_contact_streaming *********************** Connect.Client.start_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*. For more information about chat, see the following topics in the *Amazon Connect Administrator Guide*: * Concepts: Web and mobile messaging capabilities in Amazon Connect * Amazon Connect Chat security best practices See also: AWS API Documentation **Request Syntax** response = client.start_contact_streaming( InstanceId='string', ContactId='string', ChatStreamingConfiguration={ 'StreamingEndpointArn': 'string' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. * **ChatStreamingConfiguration** (*dict*) -- **[REQUIRED]** The streaming configuration, such as the Amazon SNS streaming endpoint. * **StreamingEndpointArn** *(string) --* **[REQUIRED]** 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. * **ClientToken** (*string*) -- **[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. Return type: dict Returns: **Response Syntax** { 'StreamingId': 'string' } **Response Structure** * *(dict) --* * **StreamingId** *(string) --* The identifier of the streaming configuration enabled. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.LimitExceededException" Connect / Client / update_queue_status update_queue_status ******************* Connect.Client.update_queue_status(**kwargs) 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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **Status** (*string*) -- **[REQUIRED]** The status of the queue. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_instance_storage_configs list_instance_storage_configs ***************************** Connect.Client.list_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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **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.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **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.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / get_contact_attributes get_contact_attributes ********************** Connect.Client.get_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **InitialContactId** (*string*) -- **[REQUIRED]** The identifier of the initial contact. Return type: dict Returns: **Response Syntax** { 'Attributes': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Attributes** *(dict) --* Information about the attributes. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_instance_storage_config associate_instance_storage_config ********************************* Connect.Client.associate_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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES', 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' } }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. To enable streaming for real-time analysis of contacts, use the following types: * For chat contacts, use "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS". * For voice contacts, use "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS". Note: "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS" for voice contacts moving forward.If you have previously associated a stream with "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS", no action is needed to update the stream to "REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS". * **StorageConfig** (*dict*) -- **[REQUIRED]** 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) --* **[REQUIRED]** A valid storage type. * **S3Config** *(dict) --* The S3 bucket configuration. * **BucketName** *(string) --* **[REQUIRED]** The S3 bucket name. * **BucketPrefix** *(string) --* **[REQUIRED]** The S3 bucket prefix. * **EncryptionConfig** *(dict) --* The Amazon S3 encryption configuration. * **EncryptionType** *(string) --* **[REQUIRED]** The type of encryption. * **KeyId** *(string) --* **[REQUIRED]** The full ARN of the encryption key. Note: Be sure to provide the full ARN of the encryption key, not just the ID.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **KinesisVideoStreamConfig** *(dict) --* The configuration of the Kinesis video stream. * **Prefix** *(string) --* **[REQUIRED]** The prefix of the video stream. * **RetentionPeriodHours** *(integer) --* **[REQUIRED]** 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) --* **[REQUIRED]** The encryption configuration. * **EncryptionType** *(string) --* **[REQUIRED]** The type of encryption. * **KeyId** *(string) --* **[REQUIRED]** The full ARN of the encryption key. Note: Be sure to provide the full ARN of the encryption key, not just the ID.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **KinesisStreamConfig** *(dict) --* The configuration of the Kinesis data stream. * **StreamArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the data stream. * **KinesisFirehoseConfig** *(dict) --* The configuration of the Kinesis Firehose delivery stream. * **FirehoseArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the delivery stream. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / associate_security_key associate_security_key ********************** Connect.Client.associate_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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Key** (*string*) -- **[REQUIRED]** A valid security key in PEM format as a String. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_queue_hours_of_operation update_queue_hours_of_operation ******************************* Connect.Client.update_queue_hours_of_operation(**kwargs) 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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_hours_of_operations list_hours_of_operations ************************ Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'HoursOfOperationSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_quick_connects list_quick_connects ******************* Connect.Client.list_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', ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. * **QuickConnectTypes** (*list*) -- The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * *(string) --* Return type: dict Returns: **Response Syntax** { 'QuickConnectSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], '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 admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_instance describe_instance ***************** Connect.Client.describe_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' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** { '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, 'InstanceAccessUrl': 'string', 'Tags': { 'string': 'string' } }, 'ReplicationConfiguration': { 'ReplicationStatusSummaryList': [ { 'Region': 'string', 'ReplicationStatus': 'INSTANCE_REPLICATION_COMPLETE'|'INSTANCE_REPLICATION_IN_PROGRESS'|'INSTANCE_REPLICATION_FAILED'|'INSTANCE_REPLICA_DELETING'|'INSTANCE_REPLICATION_DELETION_FAILED'|'RESOURCE_REPLICATION_NOT_STARTED', 'ReplicationStatusReason': 'string' }, ], 'SourceRegion': 'string', 'GlobalSignInEndpoint': 'string' } } **Response Structure** * *(dict) --* * **Instance** *(dict) --* The name of the instance. * **Id** *(string) --* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance. * **IdentityManagementType** *(string) --* The identity management type. * **InstanceAlias** *(string) --* The alias of instance. * **CreatedTime** *(datetime) --* When the instance was created. * **ServiceRole** *(string) --* The service role of the instance. * **InstanceStatus** *(string) --* The state of the instance. * **StatusReason** *(dict) --* Relevant details why the instance was not successfully created. * **Message** *(string) --* The message. * **InboundCallsEnabled** *(boolean) --* Whether inbound calls are enabled. * **OutboundCallsEnabled** *(boolean) --* Whether outbound calls are enabled. * **InstanceAccessUrl** *(string) --* This URL allows contact center users to access the Amazon Connect admin website. * **Tags** *(dict) --* The tags of an instance. * *(string) --* * *(string) --* * **ReplicationConfiguration** *(dict) --* Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance in the *Amazon Connect Administrator Guide*. * **ReplicationStatusSummaryList** *(list) --* A list of replication status summaries. The summaries contain details about the replication of configuration information for Amazon Connect resources, for each Amazon Web Services Region. * *(dict) --* Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see Set up Amazon Connect Global Resiliency in the *Amazon Connect Administrator Guide*. * **Region** *(string) --* The Amazon Web Services Region. This can be either the source or the replica Region, depending where it appears in the summary list. * **ReplicationStatus** *(string) --* The state of the replication. * **ReplicationStatusReason** *(string) --* A description of the replication status. Use this information to resolve any issues that are preventing the successful replication of your Amazon Connect instance to another Region. * **SourceRegion** *(string) --* The Amazon Web Services Region where the source Amazon Connect instance was created. This is the Region where the ReplicateInstance API was called to start the replication process. * **GlobalSignInEndpoint** *(string) --* The URL that is used to sign-in to your Amazon Connect instance according to your traffic distribution group configuration. For more information about sign-in and traffic distribution groups, see Important things to know in the *Create traffic distribution groups* topic in the *Amazon Connect Administrator Guide*. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_email_address_metadata update_email_address_metadata ***************************** Connect.Client.update_email_address_metadata(**kwargs) Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide. See also: AWS API Documentation **Request Syntax** response = client.update_email_address_metadata( InstanceId='string', EmailAddressId='string', Description='string', DisplayName='string', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EmailAddressId** (*string*) -- **[REQUIRED]** The identifier of the email address. * **Description** (*string*) -- The description of the email address. * **DisplayName** (*string*) -- The display name of email address. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. Return type: dict Returns: **Response Syntax** { 'EmailAddressId': 'string', 'EmailAddressArn': 'string' } **Response Structure** * *(dict) --* * **EmailAddressId** *(string) --* The identifier of the email address. * **EmailAddressArn** *(string) --* The Amazon Resource Name (ARN) of the email address. **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" Connect / Client / update_routing_profile_default_outbound_queue update_routing_profile_default_outbound_queue ********************************************* Connect.Client.update_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **DefaultOutboundQueueId** (*string*) -- **[REQUIRED]** The identifier for the default outbound queue. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_agent_status create_agent_status ******************* Connect.Client.create_agent_status(**kwargs) 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the status. * **Description** (*string*) -- The description of the status. * **State** (*string*) -- **[REQUIRED]** The state of the status. * **DisplayOrder** (*integer*) -- The display order of the status. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_users list_users ********** Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'UserSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Username': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_hours_of_operation_override delete_hours_of_operation_override ********************************** Connect.Client.delete_hours_of_operation_override(**kwargs) Deletes an hours of operation override in an Amazon Connect hours of operation resource. See also: AWS API Documentation **Request Syntax** response = client.delete_hours_of_operation_override( InstanceId='string', HoursOfOperationId='string', HoursOfOperationOverrideId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. * **HoursOfOperationOverrideId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation override. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_approved_origins list_approved_origins ********************* Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'Origins': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Origins** *(list) --* The approved origins. * *(string) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_analytics_data_associations list_analytics_data_associations ******************************** Connect.Client.list_analytics_data_associations(**kwargs) Lists the association status of requested dataset ID for a given Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_analytics_data_associations( InstanceId='string', DataSetId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **DataSetId** (*string*) -- The identifier of the dataset to get the association status. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'Results': [ { 'DataSetId': 'string', 'TargetAccountId': 'string', 'ResourceShareId': 'string', 'ResourceShareArn': 'string', 'ResourceShareStatus': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Results** *(list) --* An array of successful results: "DataSetId", "TargetAccountId", "ResourceShareId", "ResourceShareArn". This is a paginated API, so "nextToken" is given if there are more results to be returned. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. Information about associations that are successfully created: "DataSetId", "TargetAccountId", "ResourceShareId", "ResourceShareArn". * **DataSetId** *(string) --* The identifier of the dataset. * **TargetAccountId** *(string) --* The identifier of the target account. * **ResourceShareId** *(string) --* The Resource Access Manager share ID. * **ResourceShareArn** *(string) --* The Amazon Resource Name (ARN) of the Resource Access Manager share. * **ResourceShareStatus** *(string) --* The Amazon Web Services Resource Access Manager status of association. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_outbound_chat_contact start_outbound_chat_contact *************************** Connect.Client.start_outbound_chat_contact(**kwargs) Initiates a new outbound SMS contact to a customer. Response of this API provides the "ContactId" of the outbound SMS contact created. **SourceEndpoint** only supports Endpoints with "CONNECT_PHONENUMBER_ARN" as Type and **DestinationEndpoint** only supports Endpoints with "TELEPHONE_NUMBER" as Type. **ContactFlowId** initiates the flow to manage the new SMS contact created. This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action. For more information about using SMS in Amazon Connect, see the following topics in the *Amazon Connect Administrator Guide*: * Set up SMS messaging * Request an SMS-enabled phone number through AWS End User Messaging SMS See also: AWS API Documentation **Request Syntax** response = client.start_outbound_chat_contact( SourceEndpoint={ 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string' }, DestinationEndpoint={ 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string' }, InstanceId='string', SegmentAttributes={ 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } }, Attributes={ 'string': 'string' }, ContactFlowId='string', ChatDurationInMinutes=123, ParticipantDetails={ 'DisplayName': 'string' }, InitialSystemMessage={ 'ContentType': 'string', 'Content': 'string' }, RelatedContactId='string', SupportedMessagingContentTypes=[ 'string', ], ClientToken='string' ) Parameters: * **SourceEndpoint** (*dict*) -- **[REQUIRED]** Information about the endpoint. * **Type** *(string) --* Type of the endpoint. * **Address** *(string) --* Address of the endpoint. * **DestinationEndpoint** (*dict*) -- **[REQUIRED]** Information about the endpoint. * **Type** *(string) --* Type of the endpoint. * **Address** *(string) --* Address of the endpoint. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SegmentAttributes** (*dict*) -- **[REQUIRED]** A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows. * Attribute keys can include only alphanumeric, "-", and "_". * This field can be used to show channel subtype, such as "connect:Guide" and "connect:SMS". * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. * **Attributes** (*dict*) -- 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. * *(string) --* * *(string) --* * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow for the 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/**123ec456-a007-89c0-1234-xxxxxxxxxxxx** * **ChatDurationInMinutes** (*integer*) -- The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days). * **ParticipantDetails** (*dict*) -- The customer's details. * **DisplayName** *(string) --* **[REQUIRED]** Display name of the participant. * **InitialSystemMessage** (*dict*) -- A chat message. * **ContentType** *(string) --* **[REQUIRED]** The type of the content. Supported types are "text/plain", "text/markdown", "application/json", and "application/vnd.a mazonaws.connect.message.interactive.response". * **Content** *(string) --* **[REQUIRED]** The content of the chat message. * For "text/plain" and "text/markdown", the Length Constraints are Minimum of 1, Maximum of 1024. * For "application/json", the Length Constraints are Minimum of 1, Maximum of 12000. * For "application/vnd.amazonaws.connect.message.interactiv e.response", the Length Constraints are Minimum of 1, Maximum of 12288. * **RelatedContactId** (*string*) -- The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting. * **SupportedMessagingContentTypes** (*list*) -- The supported chat message content types. Supported types are: * "text/plain" * "text/markdown" * "application/json, application/vnd.amazonaws.connect.message.interactive" * "application/vnd.amazonaws.connect.message.interactive.resp onse" Content types must always contain "text/plain". You can then put any other supported type in the list. For example, all the following lists are valid because they contain "text/plain": * "[text/plain, text/markdown, application/json]" * "[text/markdown, text/plain]" * "[text/plain, application/json, application/vnd.amazonaws.c onnect.message.interactive.response]" * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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. Return type: dict Returns: **Response Syntax** { 'ContactId': 'string' } **Response Structure** * *(dict) --* * **ContactId** *(string) --* The identifier of this contact within the Amazon Connect instance. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / get_current_metric_data get_current_metric_data *********************** Connect.Client.get_current_metric_data(**kwargs) Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Metrics definitions in the *Amazon Connect Administrator Guide*. Note: When you make a successful API request, you can expect the following metric values in the response: * **Metric value is null**: The calculation cannot be performed due to divide by zero or insufficient data * **Metric value is a number (including 0) of defined type**: The number provided is the calculation result * **MetricResult list is empty**: The request cannot find any data in the system The following guidelines can help you work with the API: * Each dimension in the metric response must contain a value * Each item in MetricResult must include all requested metrics * If the response is slow due to large result sets, try these approaches: * Narrow the time range of your request * Add filters to reduce the amount of data returned See also: AWS API Documentation **Request Syntax** response = client.get_current_metric_data( InstanceId='string', Filters={ 'Queues': [ 'string', ], 'Channels': [ 'VOICE'|'CHAT'|'TASK'|'EMAIL', ], 'RoutingProfiles': [ 'string', ], 'RoutingStepExpressions': [ 'string', ] }, Groupings=[ 'QUEUE'|'CHANNEL'|'ROUTING_PROFILE'|'ROUTING_STEP_EXPRESSION', ], 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, SortCriteria=[ { 'SortByMetric': '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', 'SortOrder': 'ASCENDING'|'DESCENDING' }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Filters** (*dict*) -- **[REQUIRED]** The filters to apply to returned metrics. You can filter up to the following limits: * Queues: 100 * Routing profiles: 100 * Channels: 3 (VOICE, CHAT, and TASK channels are supported.) * RoutingStepExpressions: 50 Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request. When using the "RoutingStepExpression" filter, you need to pass exactly one "QueueId". The filter is also case sensitive so when using the "RoutingStepExpression" filter, grouping by "ROUTING_STEP_EXPRESSION" is required. Currently tagging is only supported on the resources that are passed in the filter. * **Queues** *(list) --* 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. * *(string) --* * **Channels** *(list) --* The channel to use to filter the metrics. * *(string) --* * **RoutingProfiles** *(list) --* A list of up to 100 routing profile IDs or ARNs. * *(string) --* * **RoutingStepExpressions** *(list) --* A list of expressions as a filter, in which an expression is an object of a step in a routing criteria. * *(string) --* * **Groupings** (*list*) -- The grouping applied to the metrics returned. For example, when grouped by "QUEUE", the metrics returned apply to each queue rather than aggregated for all queues. * If you group by "CHANNEL", you should include a Channels filter. VOICE, CHAT, and TASK channels are supported. * If you group by "ROUTING_PROFILE", you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics "CONTACTS_SCHEDULED", "CONTACTS_IN_QUEUE", and "OLDEST_CONTACT_AGE". * If no "Grouping" is included in the request, a summary of metrics is returned. * When using the "RoutingStepExpression" filter, group by "ROUTING_STEP_EXPRESSION" is required. * *(string) --* * **CurrentMetrics** (*list*) -- **[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 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. When the filter "RoutingStepExpression" is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under "" for 10 seconds has expired and "" becomes active, then "OLDEST_CONTACT_AGE" for this queue will be counted starting from 10, not 0. 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 * *(dict) --* Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the *Amazon Connect Administrator Guide*. * **Name** *(string) --* The name of the metric. * **Unit** *(string) --* The unit for the metric. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. 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. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SortCriteria** (*list*) -- The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on "AGENTS_ONLINE", "DESCENDING". The metric collection is sorted based on the input metrics. Note the following: * Sorting on "SLOTS_ACTIVE" and "SLOTS_AVAILABLE" is not supported. * *(dict) --* The way to sort the resulting response based on metrics. By default resources are sorted based on "AGENTS_ONLINE", "DESCENDING". The metric collection is sorted based on the input metrics. * **SortByMetric** *(string) --* The current metric names. * **SortOrder** *(string) --* The way to sort. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'MetricResults': [ { 'Dimensions': { 'Queue': { 'Id': 'string', 'Arn': 'string' }, 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'RoutingProfile': { 'Id': 'string', 'Arn': 'string' }, 'RoutingStepExpression': 'string' }, '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), 'ApproximateTotalCount': 123 } **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. * **RoutingProfile** *(dict) --* Information about the routing profile assigned to the user. * **Id** *(string) --* The identifier of the routing profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the routing profile. * **RoutingStepExpression** *(string) --* The expression of a step in a routing criteria. * **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. * **ApproximateTotalCount** *(integer) --* The total count of the result, regardless of the current page size. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / create_view_version create_view_version ******************* Connect.Client.create_view_version(**kwargs) Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the "$LATEST" alias. See also: AWS API Documentation **Request Syntax** response = client.create_view_version( InstanceId='string', ViewId='string', VersionDescription='string', ViewContentSha256='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. * **VersionDescription** (*string*) -- The description for the version being published. * **ViewContentSha256** (*string*) -- Indicates the checksum value of the latest published view content. Return type: dict Returns: **Response Syntax** { 'View': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Status': 'PUBLISHED'|'SAVED', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Description': 'string', 'Version': 123, 'VersionDescription': 'string', 'Content': { 'InputSchema': 'string', 'Template': 'string', 'Actions': [ 'string', ] }, 'Tags': { 'string': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ViewContentSha256': 'string' } } **Response Structure** * *(dict) --* * **View** *(dict) --* All view data is contained within the View object. * **Id** *(string) --* The identifier of the view. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view. * **Name** *(string) --* The name of the view. * **Status** *(string) --* Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Type** *(string) --* The type of the view - "CUSTOMER_MANAGED". * **Description** *(string) --* The description of the view. * **Version** *(integer) --* Current version of the view. * **VersionDescription** *(string) --* The description of the version. * **Content** *(dict) --* View content containing all content necessary to render a view except for runtime input data. * **InputSchema** *(string) --* The data schema matching data that the view template must be provided to render. * **Template** *(string) --* The view template representing the structure of the view. * **Actions** *(list) --* A list of possible actions from the view. * *(string) --* * **Tags** *(dict) --* The tags associated with the view resource (not specific to view version). * *(string) --* * *(string) --* * **CreatedTime** *(datetime) --* The timestamp of when the view was created. * **LastModifiedTime** *(datetime) --* Latest timestamp of the "UpdateViewContent" or "CreateViewVersion" operations. * **ViewContentSha256** *(string) --* Indicates the checksum value of the latest published view content. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / delete_prompt delete_prompt ************* Connect.Client.delete_prompt(**kwargs) Deletes a prompt. See also: AWS API Documentation **Request Syntax** response = client.delete_prompt( InstanceId='string', PromptId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PromptId** (*string*) -- **[REQUIRED]** A unique identifier for the prompt. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_contact_flow_modules list_contact_flow_modules ************************* Connect.Client.list_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **ContactFlowModuleState** (*string*) -- The state of the flow module. Return type: dict Returns: **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.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_user delete_user *********** Connect.Client.delete_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*. Warning: After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you: * Avoid dangling resources that impact your service quotas. * Remove deleted users so they don't appear to agents as transfer options. * Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency. See also: AWS API Documentation **Request Syntax** response = client.delete_user( InstanceId='string', UserId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_screen_sharing start_screen_sharing ******************** Connect.Client.start_screen_sharing(**kwargs) Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.start_screen_sharing( ClientToken='string', InstanceId='string', ContactId='string' ) Parameters: * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / describe_contact_flow_module describe_contact_flow_module **************************** Connect.Client.describe_contact_flow_module(**kwargs) Describes the specified flow module. Use the "$SAVED" alias in the request to describe the "SAVED" content of a Flow. For example, "arn:aws:.../contact- flow/{id}:$SAVED". After a flow is published, "$SAVED" needs to be supplied to view saved content that has not been published. See also: AWS API Documentation **Request Syntax** response = client.describe_contact_flow_module( InstanceId='string', ContactFlowModuleId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowModuleId** (*string*) -- **[REQUIRED]** The identifier of the flow module. Return type: dict Returns: **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 JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. * **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"} }. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_prompt create_prompt ************* Connect.Client.create_prompt(**kwargs) Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_prompt( InstanceId='string', Name='string', Description='string', S3Uri='string', Tags={ 'string': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the prompt. * **Description** (*string*) -- The description of the prompt. * **S3Uri** (*string*) -- **[REQUIRED]** The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'PromptARN': 'string', 'PromptId': 'string' } **Response Structure** * *(dict) --* * **PromptARN** *(string) --* The Amazon Resource Name (ARN) of the prompt. * **PromptId** *(string) --* A unique identifier for the prompt. **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_user_phone_config update_user_phone_config ************************ Connect.Client.update_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' ) Parameters: * **PhoneConfig** (*dict*) -- **[REQUIRED]** Information about phone configuration settings for the user. * **PhoneType** *(string) --* **[REQUIRED]** The phone type. * **AutoAccept** *(boolean) --* The Auto accept setting. * **AfterContactWorkTimeLimit** *(integer) --* The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. Note: When returned by a "SearchUsers" call, "AfterContactWorkTimeLimit" is returned in milliseconds. * **DeskPhoneNumber** *(string) --* The phone number for the user's desk phone. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / tag_contact tag_contact *********** Connect.Client.tag_contact(**kwargs) Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage. See also: AWS API Documentation **Request Syntax** response = client.tag_contact( ContactId='string', InstanceId='string', Tags={ 'string': 'string' } ) Parameters: * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Tags** (*dict*) -- **[REQUIRED]** The tags to be assigned to the contact resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Note: Authorization is not supported by this tag. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_contact describe_contact **************** Connect.Client.describe_contact(**kwargs) This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Warning: * "SystemEndpoint" is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK * Contact information remains available in Amazon Connect for 24 months from the "InitiationTimestamp", and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API. See also: AWS API Documentation **Request Syntax** response = client.describe_contact( InstanceId='string', ContactId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. Return type: dict Returns: **Response Syntax** { 'Contact': { 'Arn': 'string', 'Id': 'string', 'InitialContactId': 'string', 'PreviousContactId': 'string', 'ContactAssociationId': 'string', 'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', 'Name': 'string', 'Description': 'string', 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'QueueInfo': { 'Id': 'string', 'EnqueueTimestamp': datetime(2015, 1, 1) }, 'AgentInfo': { 'Id': 'string', 'ConnectedToAgentTimestamp': datetime(2015, 1, 1), 'AgentPauseDurationInSeconds': 123, 'HierarchyGroups': { 'Level1': { 'Arn': 'string' }, 'Level2': { 'Arn': 'string' }, 'Level3': { 'Arn': 'string' }, 'Level4': { 'Arn': 'string' }, 'Level5': { 'Arn': 'string' } }, 'DeviceInfo': { 'PlatformName': 'string', 'PlatformVersion': 'string', 'OperatingSystem': 'string' }, 'Capabilities': { 'Video': 'SEND', 'ScreenShare': 'SEND' }, 'AfterContactWorkDuration': 123, 'AfterContactWorkStartTimestamp': datetime(2015, 1, 1), 'AfterContactWorkEndTimestamp': datetime(2015, 1, 1), 'AgentInitiatedHoldDuration': 123, 'StateTransitions': [ { 'State': 'INITIAL'|'CONNECTED'|'DISCONNECTED'|'MISSED', 'StateStartTimestamp': datetime(2015, 1, 1), 'StateEndTimestamp': datetime(2015, 1, 1) }, ] }, 'InitiationTimestamp': datetime(2015, 1, 1), 'DisconnectTimestamp': datetime(2015, 1, 1), 'LastUpdateTimestamp': datetime(2015, 1, 1), 'LastPausedTimestamp': datetime(2015, 1, 1), 'LastResumedTimestamp': datetime(2015, 1, 1), 'TotalPauseCount': 123, 'TotalPauseDurationInSeconds': 123, 'ScheduledTimestamp': datetime(2015, 1, 1), 'RelatedContactId': 'string', 'WisdomInfo': { 'SessionArn': 'string' }, 'CustomerId': 'string', 'CustomerEndpoint': { 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string', 'DisplayName': 'string' }, 'SystemEndpoint': { 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string', 'DisplayName': 'string' }, 'QueueTimeAdjustmentSeconds': 123, 'QueuePriority': 123, 'Tags': { 'string': 'string' }, 'ConnectedToSystemTimestamp': datetime(2015, 1, 1), 'RoutingCriteria': { 'Steps': [ { 'Expiry': { 'DurationInSeconds': 123, 'ExpiryTimestamp': datetime(2015, 1, 1) }, 'Expression': { 'AttributeCondition': { 'Name': 'string', 'Value': 'string', 'ProficiencyLevel': ..., 'Range': { 'MinProficiencyLevel': ..., 'MaxProficiencyLevel': ... }, 'MatchCriteria': { 'AgentsCriteria': { 'AgentIds': [ 'string', ] } }, 'ComparisonOperator': 'string' }, 'AndExpression': [ {'... recursive ...'}, ], 'OrExpression': [ {'... recursive ...'}, ], 'NotAttributeCondition': { 'Name': 'string', 'Value': 'string', 'ProficiencyLevel': ..., 'Range': { 'MinProficiencyLevel': ..., 'MaxProficiencyLevel': ... }, 'MatchCriteria': { 'AgentsCriteria': { 'AgentIds': [ 'string', ] } }, 'ComparisonOperator': 'string' } }, 'Status': 'ACTIVE'|'INACTIVE'|'JOINED'|'EXPIRED' }, ], 'ActivationTimestamp': datetime(2015, 1, 1), 'Index': 123 }, 'Customer': { 'DeviceInfo': { 'PlatformName': 'string', 'PlatformVersion': 'string', 'OperatingSystem': 'string' }, 'Capabilities': { 'Video': 'SEND', 'ScreenShare': 'SEND' } }, 'Campaign': { 'CampaignId': 'string' }, 'AnsweringMachineDetectionStatus': 'ANSWERED'|'UNDETECTED'|'ERROR'|'HUMAN_ANSWERED'|'SIT_TONE_DETECTED'|'SIT_TONE_BUSY'|'SIT_TONE_INVALID_NUMBER'|'FAX_MACHINE_DETECTED'|'VOICEMAIL_BEEP'|'VOICEMAIL_NO_BEEP'|'AMD_UNRESOLVED'|'AMD_UNANSWERED'|'AMD_ERROR'|'AMD_NOT_APPLICABLE', 'CustomerVoiceActivity': { 'GreetingStartTimestamp': datetime(2015, 1, 1), 'GreetingEndTimestamp': datetime(2015, 1, 1) }, 'QualityMetrics': { 'Agent': { 'Audio': { 'QualityScore': ..., 'PotentialQualityIssues': [ 'string', ] } }, 'Customer': { 'Audio': { 'QualityScore': ..., 'PotentialQualityIssues': [ 'string', ] } } }, 'ChatMetrics': { 'ChatContactMetrics': { 'MultiParty': True|False, 'TotalMessages': 123, 'TotalBotMessages': 123, 'TotalBotMessageLengthInChars': 123, 'ConversationCloseTimeInMillis': 123, 'ConversationTurnCount': 123, 'AgentFirstResponseTimestamp': datetime(2015, 1, 1), 'AgentFirstResponseTimeInMillis': 123 }, 'AgentMetrics': { 'ParticipantId': 'string', 'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY', 'ConversationAbandon': True|False, 'MessagesSent': 123, 'NumResponses': 123, 'MessageLengthInChars': 123, 'TotalResponseTimeInMillis': 123, 'MaxResponseTimeInMillis': 123, 'LastMessageTimestamp': datetime(2015, 1, 1) }, 'CustomerMetrics': { 'ParticipantId': 'string', 'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY', 'ConversationAbandon': True|False, 'MessagesSent': 123, 'NumResponses': 123, 'MessageLengthInChars': 123, 'TotalResponseTimeInMillis': 123, 'MaxResponseTimeInMillis': 123, 'LastMessageTimestamp': datetime(2015, 1, 1) } }, 'DisconnectDetails': { 'PotentialDisconnectIssue': 'string' }, 'AdditionalEmailRecipients': { 'ToList': [ { 'Address': 'string', 'DisplayName': 'string' }, ], 'CcList': [ { 'Address': 'string', 'DisplayName': 'string' }, ] }, 'SegmentAttributes': { 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } }, 'Recordings': [ { 'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE', 'Location': 'string', 'MediaStreamType': 'AUDIO'|'VIDEO', 'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY', 'FragmentStartNumber': 'string', 'FragmentStopNumber': 'string', 'StartTimestamp': datetime(2015, 1, 1), 'StopTimestamp': datetime(2015, 1, 1), 'Status': 'AVAILABLE'|'DELETED', 'DeletionReason': 'string' }, ], 'DisconnectReason': 'string', 'ContactEvaluations': { 'string': { 'FormId': 'string', 'EvaluationArn': 'string', 'Status': 'COMPLETE'|'IN_PROGRESS'|'DELETED', 'StartTimestamp': datetime(2015, 1, 1), 'EndTimestamp': datetime(2015, 1, 1), 'DeleteTimestamp': datetime(2015, 1, 1), 'ExportLocation': 'string' } }, 'ContactDetails': { 'Name': 'string', 'Description': 'string' }, 'Attributes': { 'string': 'string' } } } **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. * **ContactAssociationId** *(string) --* This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree. * **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. * **AgentPauseDurationInSeconds** *(integer) --* Agent pause duration for a contact in seconds. * **HierarchyGroups** *(dict) --* The agent hierarchy groups for the agent. * **Level1** *(dict) --* The group at level one of the agent hierarchy. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the group. * **Level2** *(dict) --* The group at level two of the agent hierarchy. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the group. * **Level3** *(dict) --* The group at level three of the agent hierarchy. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the group. * **Level4** *(dict) --* The group at level four of the agent hierarchy. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the group. * **Level5** *(dict) --* The group at level five of the agent hierarchy. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the group. * **DeviceInfo** *(dict) --* Information regarding Agent’s device. * **PlatformName** *(string) --* Name of the platform that the participant used for the call. * **PlatformVersion** *(string) --* Version of the platform that the participant used for the call. * **OperatingSystem** *(string) --* Operating system that the participant used for the call. * **Capabilities** *(dict) --* The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the *Amazon Connect Administrator Guide*. * **Video** *(string) --* The configuration having the video and screen sharing capabilities for participants over the call. * **ScreenShare** *(string) --* The screen sharing capability that is enabled for the participant. "SEND" indicates the participant can share their screen. * **AfterContactWorkDuration** *(integer) --* The difference in time, in whole seconds, between "AfterContactWorkStartTimestamp" and "AfterContactWorkEndTimestamp". * **AfterContactWorkStartTimestamp** *(datetime) --* The date and time when the agent started doing After Contact Work for the contact, in UTC time. * **AfterContactWorkEndTimestamp** *(datetime) --* The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing "AfterContactWork" for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for "AfterContactWorkEndTimestamp". * **AgentInitiatedHoldDuration** *(integer) --* The total hold duration in seconds initiated by the agent. * **StateTransitions** *(list) --* List of "StateTransition" for a supervisor. * *(dict) --* Information about the state transition of a supervisor. * **State** *(string) --* The state of the transition. * **StateStartTimestamp** *(datetime) --* The date and time when the state started in UTC time. * **StateEndTimestamp** *(datetime) --* The date and time when the state ended in UTC time. * **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. For "EXTERNAL_OUTBOUND", this is when the agent started dialing the external participant. For "MONITOR", this is when the supervisor started listening to a contact. * **DisconnectTimestamp** *(datetime) --* The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended. * **LastUpdateTimestamp** *(datetime) --* The timestamp when contact was last updated. * **LastPausedTimestamp** *(datetime) --* The timestamp when the contact was last paused. * **LastResumedTimestamp** *(datetime) --* The timestamp when the contact was last resumed. * **TotalPauseCount** *(integer) --* Total pause count for a contact. * **TotalPauseDurationInSeconds** *(integer) --* Total pause duration for a contact in seconds. * **ScheduledTimestamp** *(datetime) --* The timestamp, in Unix epoch time format, at which to start running the inbound flow. * **RelatedContactId** *(string) --* The contactId that is related to this contact. * **WisdomInfo** *(dict) --* Information about Amazon Connect Wisdom. * **SessionArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom session. * **CustomerId** *(string) --* The customer's identification number. For example, the "CustomerId" may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the "CustomerSpeakerId" of the caller. * **CustomerEndpoint** *(dict) --* The customer or external third party participant endpoint. * **Type** *(string) --* Type of endpoint. * **Address** *(string) --* Address of the endpoint. * **DisplayName** *(string) --* Display name of the endpoint. * **SystemEndpoint** *(dict) --* The system endpoint. For "INBOUND", this is the phone number or email address that the customer dialed. For "OUTBOUND" and "EXTERNAL_OUTBOUND", this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone. * **Type** *(string) --* Type of endpoint. * **Address** *(string) --* Address of the endpoint. * **DisplayName** *(string) --* Display name of the endpoint. * **QueueTimeAdjustmentSeconds** *(integer) --* An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value. * **QueuePriority** *(integer) --* An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5. * **Tags** *(dict) --* Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags. * *(string) --* * *(string) --* * **ConnectedToSystemTimestamp** *(datetime) --* The timestamp when customer endpoint connected to Amazon Connect. * **RoutingCriteria** *(dict) --* Latest routing criteria on the contact. * **Steps** *(list) --* List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue. * *(dict) --* Step signifies the criteria to be used for routing to an agent * **Expiry** *(dict) --* An object to specify the expiration of a routing step. * **DurationInSeconds** *(integer) --* The number of seconds to wait before expiring the routing step. * **ExpiryTimestamp** *(datetime) --* The timestamp indicating when the routing step expires. * **Expression** *(dict) --* A tagged union to specify expression for a routing step. * **AttributeCondition** *(dict) --* An object to specify the predefined attribute condition. * **Name** *(string) --* The name of predefined attribute. * **Value** *(string) --* The value of predefined attribute. * **ProficiencyLevel** *(float) --* The proficiency level of the condition. * **Range** *(dict) --* An Object to define the minimum and maximum proficiency levels. * **MinProficiencyLevel** *(float) --* The minimum proficiency level of the range. * **MaxProficiencyLevel** *(float) --* The maximum proficiency level of the range. * **MatchCriteria** *(dict) --* An object to define "AgentsCriteria". * **AgentsCriteria** *(dict) --* An object to define agentIds. * **AgentIds** *(list) --* An object to specify a list of agents, by user ID. * *(string) --* * **ComparisonOperator** *(string) --* The operator of the condition. * **AndExpression** *(list) --* List of routing expressions which will be AND-ed together. * *(dict) --* A tagged union to specify expression for a routing step. * **OrExpression** *(list) --* List of routing expressions which will be OR-ed together. * *(dict) --* A tagged union to specify expression for a routing step. * **NotAttributeCondition** *(dict) --* An object to specify the predefined attribute condition. * **Name** *(string) --* The name of predefined attribute. * **Value** *(string) --* The value of predefined attribute. * **ProficiencyLevel** *(float) --* The proficiency level of the condition. * **Range** *(dict) --* An Object to define the minimum and maximum proficiency levels. * **MinProficiencyLevel** *(float) --* The minimum proficiency level of the range. * **MaxProficiencyLevel** *(float) --* The maximum proficiency level of the range. * **MatchCriteria** *(dict) --* An object to define "AgentsCriteria". * **AgentsCriteria** *(dict) --* An object to define agentIds. * **AgentIds** *(list) --* An object to specify a list of agents, by user ID. * *(string) --* * **ComparisonOperator** *(string) --* The operator of the condition. * **Status** *(string) --* Represents status of the Routing step. * **ActivationTimestamp** *(datetime) --* The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue. * **Index** *(integer) --* Information about the index of the routing criteria. * **Customer** *(dict) --* Information about the Customer on the contact. * **DeviceInfo** *(dict) --* Information regarding Customer’s device. * **PlatformName** *(string) --* Name of the platform that the participant used for the call. * **PlatformVersion** *(string) --* Version of the platform that the participant used for the call. * **OperatingSystem** *(string) --* Operating system that the participant used for the call. * **Capabilities** *(dict) --* The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the *Amazon Connect Administrator Guide*. * **Video** *(string) --* The configuration having the video and screen sharing capabilities for participants over the call. * **ScreenShare** *(string) --* The screen sharing capability that is enabled for the participant. "SEND" indicates the participant can share their screen. * **Campaign** *(dict) --* Information associated with a campaign. * **CampaignId** *(string) --* A unique identifier for a campaign. * **AnsweringMachineDetectionStatus** *(string) --* Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect. * **CustomerVoiceActivity** *(dict) --* Information about customer’s voice activity. * **GreetingStartTimestamp** *(datetime) --* Timestamp that measures the beginning of the customer greeting from an outbound voice call. * **GreetingEndTimestamp** *(datetime) --* Timestamp that measures the end of the customer greeting from an outbound voice call. * **QualityMetrics** *(dict) --* Information about the quality of the participant's media connection. * **Agent** *(dict) --* Information about the quality of Agent media connection. * **Audio** *(dict) --* Information about the audio quality of the Agent * **QualityScore** *(float) --* Number measuring the estimated quality of the media connection. * **PotentialQualityIssues** *(list) --* List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty. Valid values: "HighPacketLoss" | "HighRoundTripTime" | "HighJitterBuffer" * *(string) --* * **Customer** *(dict) --* Information about the quality of Customer media connection. * **Audio** *(dict) --* Information about the audio quality of the Customer * **QualityScore** *(float) --* Number measuring the estimated quality of the media connection. * **PotentialQualityIssues** *(list) --* List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty. Valid values: "HighPacketLoss" | "HighRoundTripTime" | "HighJitterBuffer" * *(string) --* * **ChatMetrics** *(dict) --* Information about how agent, bot, and customer interact in a chat contact. * **ChatContactMetrics** *(dict) --* Information about the overall participant interactions at the contact level. * **MultiParty** *(boolean) --* A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact. * **TotalMessages** *(integer) --* The number of chat messages on the contact. * **TotalBotMessages** *(integer) --* The total number of bot and automated messages on a chat contact. * **TotalBotMessageLengthInChars** *(integer) --* The total number of characters from bot and automated messages on a chat contact. * **ConversationCloseTimeInMillis** *(integer) --* The time it took for a contact to end after the last customer message. * **ConversationTurnCount** *(integer) --* The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants. * **AgentFirstResponseTimestamp** *(datetime) --* The agent first response timestamp for a chat contact. * **AgentFirstResponseTimeInMillis** *(integer) --* The time for an agent to respond after obtaining a chat contact. * **AgentMetrics** *(dict) --* Information about agent interactions in a contact. * **ParticipantId** *(string) --* The Participant's ID. * **ParticipantType** *(string) --* Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor]. * **ConversationAbandon** *(boolean) --* A boolean flag indicating whether the chat conversation was abandoned by a Participant. * **MessagesSent** *(integer) --* Number of chat messages sent by Participant. * **NumResponses** *(integer) --* Number of chat messages sent by Participant. * **MessageLengthInChars** *(integer) --* Number of chat characters sent by Participant. * **TotalResponseTimeInMillis** *(integer) --* Total chat response time by Participant. * **MaxResponseTimeInMillis** *(integer) --* Maximum chat response time by Participant. * **LastMessageTimestamp** *(datetime) --* Timestamp of last chat message by Participant. * **CustomerMetrics** *(dict) --* Information about customer interactions in a contact. * **ParticipantId** *(string) --* The Participant's ID. * **ParticipantType** *(string) --* Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor]. * **ConversationAbandon** *(boolean) --* A boolean flag indicating whether the chat conversation was abandoned by a Participant. * **MessagesSent** *(integer) --* Number of chat messages sent by Participant. * **NumResponses** *(integer) --* Number of chat messages sent by Participant. * **MessageLengthInChars** *(integer) --* Number of chat characters sent by Participant. * **TotalResponseTimeInMillis** *(integer) --* Total chat response time by Participant. * **MaxResponseTimeInMillis** *(integer) --* Maximum chat response time by Participant. * **LastMessageTimestamp** *(datetime) --* Timestamp of last chat message by Participant. * **DisconnectDetails** *(dict) --* Information about the call disconnect experience. * **PotentialDisconnectIssue** *(string) --* Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues. * **AdditionalEmailRecipients** *(dict) --* List of additional email addresses for an email contact. * **ToList** *(list) --* List of additional TO email recipients for an email contact. * *(dict) --* Information about the email recipient * **Address** *(string) --* Address of the email recipient. * **DisplayName** *(string) --* Display name of the email recipient. * **CcList** *(list) --* List of additional CC email recipients for an email contact. * *(dict) --* Information about the email recipient * **Address** *(string) --* Address of the email recipient. * **DisplayName** *(string) --* Display name of the email recipient. * **SegmentAttributes** *(dict) --* A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, "connect:Guide" or "connect:SMS". * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. * **Recordings** *(list) --* If recording was enabled, this is information about the recordings. * *(dict) --* Information about a voice recording, chat transcript, or screen recording. * **StorageType** *(string) --* Where the recording/transcript is stored. * **Location** *(string) --* The location, in Amazon S3, for the recording/transcript. * **MediaStreamType** *(string) --* Information about the media stream used during the conversation. * **ParticipantType** *(string) --* Information about the conversation participant, whether they are an agent or contact. The participant types are as follows: * All * Manager * Agent * Customer * Thirdparty * Supervisor * **FragmentStartNumber** *(string) --* The number that identifies the Kinesis Video Streams fragment where the customer audio stream started. * **FragmentStopNumber** *(string) --* The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped. * **StartTimestamp** *(datetime) --* When the conversation of the last leg of the recording started in UTC time. * **StopTimestamp** *(datetime) --* When the conversation of the last leg of recording stopped in UTC time. * **Status** *(string) --* The status of the recording/transcript. * **DeletionReason** *(string) --* If the recording/transcript was deleted, this is the reason entered for the deletion. * **DisconnectReason** *(string) --* The disconnect reason for the contact. * **ContactEvaluations** *(dict) --* Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form. * *(string) --* * *(dict) --* Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form. * **FormId** *(string) --* The "FormId" of the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name for the evaluation form. It is always present. * **Status** *(string) --* The status of the evaluation. * **StartTimestamp** *(datetime) --* The date and time when the evaluation was started, in UTC time. * **EndTimestamp** *(datetime) --* The date and time when the evaluation was submitted, in UTC time. * **DeleteTimestamp** *(datetime) --* The date and time when the evaluation was deleted, in UTC time. * **ExportLocation** *(string) --* The path where evaluation was exported. * **ContactDetails** *(dict) --* A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts. * **Name** *(string) --* The name of the contact details. * **Description** *(string) --* Teh description of the contact details. * **Attributes** *(dict) --* The attributes of the contact. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / delete_traffic_distribution_group delete_traffic_distribution_group ********************************* Connect.Client.delete_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' ) Parameters: **TrafficDistributionGroupId** (*string*) -- **[REQUIRED]** The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_task_templates list_task_templates ******************* Connect.Client.list_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Warning: It is not expected that you set this because the value returned in the previous response is always null. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Warning: It is not expected that you set this. * **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. * **Name** (*string*) -- The name of the task template. Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_quick_connect_config update_quick_connect_config *************************** Connect.Client.update_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' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QuickConnectId** (*string*) -- **[REQUIRED]** The identifier for the quick connect. * **QuickConnectConfig** (*dict*) -- **[REQUIRED]** Information about the configuration settings for the quick connect. * **QuickConnectType** *(string) --* **[REQUIRED]** The type of quick connect. In the Amazon Connect admin website, 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) --* **[REQUIRED]** The identifier of the user. * **ContactFlowId** *(string) --* **[REQUIRED]** The identifier of the flow. * **QueueConfig** *(dict) --* The queue configuration. This is required only if QuickConnectType is QUEUE. * **QueueId** *(string) --* **[REQUIRED]** The identifier for the queue. * **ContactFlowId** *(string) --* **[REQUIRED]** The identifier of the flow. * **PhoneConfig** *(dict) --* The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER. * **PhoneNumber** *(string) --* **[REQUIRED]** The phone number in E.164 format. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_view create_view *********** Connect.Client.create_view(**kwargs) Creates a new view with the possible status of "SAVED" or "PUBLISHED". The views will have a unique name for each connect instance. It performs basic content validation if the status is "SAVED" or full content validation if the status is set to "PUBLISHED". An error is returned if validation fails. It associates either the "$SAVED" qualifier or both of the "$SAVED" and "$LATEST" qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided. See also: AWS API Documentation **Request Syntax** response = client.create_view( InstanceId='string', ClientToken='string', Status='PUBLISHED'|'SAVED', Content={ 'Template': 'string', 'Actions': [ 'string', ] }, Description='string', Name='string', Tags={ 'string': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ClientToken** (*string*) -- A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided. * **Status** (*string*) -- **[REQUIRED]** Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Content** (*dict*) -- **[REQUIRED]** View content containing all content necessary to render a view except for runtime input data. The total uncompressed content has a maximum file size of 400kB. * **Template** *(string) --* The view template representing the structure of the view. * **Actions** *(list) --* A list of possible actions from the view. * *(string) --* * **Description** (*string*) -- The description of the view. * **Name** (*string*) -- **[REQUIRED]** The name of the view. * **Tags** (*dict*) -- The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'View': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Status': 'PUBLISHED'|'SAVED', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Description': 'string', 'Version': 123, 'VersionDescription': 'string', 'Content': { 'InputSchema': 'string', 'Template': 'string', 'Actions': [ 'string', ] }, 'Tags': { 'string': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ViewContentSha256': 'string' } } **Response Structure** * *(dict) --* * **View** *(dict) --* A view resource object. Contains metadata and content necessary to render the view. * **Id** *(string) --* The identifier of the view. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view. * **Name** *(string) --* The name of the view. * **Status** *(string) --* Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Type** *(string) --* The type of the view - "CUSTOMER_MANAGED". * **Description** *(string) --* The description of the view. * **Version** *(integer) --* Current version of the view. * **VersionDescription** *(string) --* The description of the version. * **Content** *(dict) --* View content containing all content necessary to render a view except for runtime input data. * **InputSchema** *(string) --* The data schema matching data that the view template must be provided to render. * **Template** *(string) --* The view template representing the structure of the view. * **Actions** *(list) --* A list of possible actions from the view. * *(string) --* * **Tags** *(dict) --* The tags associated with the view resource (not specific to view version). * *(string) --* * *(string) --* * **CreatedTime** *(datetime) --* The timestamp of when the view was created. * **LastModifiedTime** *(datetime) --* Latest timestamp of the "UpdateViewContent" or "CreateViewVersion" operations. * **ViewContentSha256** *(string) --* Indicates the checksum value of the latest published view content. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.TooManyRequestsException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / describe_contact_evaluation describe_contact_evaluation *************************** Connect.Client.describe_contact_evaluation(**kwargs) Describes a contact evaluation in the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.describe_contact_evaluation( InstanceId='string', EvaluationId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationId** (*string*) -- **[REQUIRED]** A unique identifier for the contact evaluation. Return type: dict Returns: **Response Syntax** { 'Evaluation': { 'EvaluationId': 'string', 'EvaluationArn': 'string', 'Metadata': { 'ContactId': 'string', 'EvaluatorArn': 'string', 'ContactAgentId': 'string', 'Score': { 'Percentage': 123.0, 'NotApplicable': True|False, 'AutomaticFail': True|False } }, 'Answers': { 'string': { 'Value': { 'StringValue': 'string', 'NumericValue': 123.0, 'NotApplicable': True|False }, 'SystemSuggestedValue': { 'StringValue': 'string', 'NumericValue': 123.0, 'NotApplicable': True|False } } }, 'Notes': { 'string': { 'Value': 'string' } }, 'Status': 'DRAFT'|'SUBMITTED', 'Scores': { 'string': { 'Percentage': 123.0, 'NotApplicable': True|False, 'AutomaticFail': True|False } }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } }, 'EvaluationForm': { 'EvaluationFormVersion': 123, 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string', 'Title': 'string', 'Description': 'string', 'Items': [ { 'Section': { 'Title': 'string', 'RefId': 'string', 'Instructions': 'string', 'Items': {'... recursive ...'}, 'Weight': 123.0 }, 'Question': { 'Title': 'string', 'Instructions': 'string', 'RefId': 'string', 'NotApplicableEnabled': True|False, 'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC', 'QuestionTypeProperties': { 'Numeric': { 'MinValue': 123, 'MaxValue': 123, 'Options': [ { 'MinValue': 123, 'MaxValue': 123, 'Score': 123, 'AutomaticFail': True|False }, ], 'Automation': { 'PropertyValue': { 'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME' } } }, 'SingleSelect': { 'Options': [ { 'RefId': 'string', 'Text': 'string', 'Score': 123, 'AutomaticFail': True|False }, ], 'DisplayAs': 'DROPDOWN'|'RADIO', 'Automation': { 'Options': [ { 'RuleCategory': { 'Category': 'string', 'Condition': 'PRESENT'|'NOT_PRESENT', 'OptionRefId': 'string' } }, ], 'DefaultOptionRefId': 'string' } } }, 'Weight': 123.0 } }, ], 'ScoringStrategy': { 'Mode': 'QUESTION_ONLY'|'SECTION_ONLY', 'Status': 'ENABLED'|'DISABLED' } } } **Response Structure** * *(dict) --* * **Evaluation** *(dict) --* Information about the evaluation form completed for a specific contact. * **EvaluationId** *(string) --* A unique identifier for the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. * **Metadata** *(dict) --* Metadata about the contact evaluation. * **ContactId** *(string) --* The identifier of the contact in this instance of Amazon Connect. * **EvaluatorArn** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation. * **ContactAgentId** *(string) --* The identifier of the agent who performed the contact. * **Score** *(dict) --* The overall score of the contact evaluation. * **Percentage** *(float) --* The score percentage for an item in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the item as not applicable for scoring. * **AutomaticFail** *(boolean) --* The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true. * **Answers** *(dict) --* A map of question identifiers to answer value. * *(string) --* * *(dict) --* Information about output answers for a contact evaluation. * **Value** *(dict) --* The value for an answer in a contact evaluation. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringValue", "NumericValue", "NotApplicable". 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'} * **StringValue** *(string) --* The string value for an answer in a contact evaluation. * **NumericValue** *(float) --* The numeric value for an answer in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the question as not applicable. * **SystemSuggestedValue** *(dict) --* The system suggested value for an answer in a contact evaluation. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringValue", "NumericValue", "NotApplicable". 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'} * **StringValue** *(string) --* The string value for an answer in a contact evaluation. * **NumericValue** *(float) --* The numeric value for an answer in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the question as not applicable. * **Notes** *(dict) --* A map of question identifiers to note value. * *(string) --* * *(dict) --* Information about notes for a contact evaluation. * **Value** *(string) --* The note for an item (section or question) in a contact evaluation. Note: Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024. * **Status** *(string) --* The status of the contact evaluation. * **Scores** *(dict) --* A map of item (section or question) identifiers to score value. * *(string) --* * *(dict) --* Information about scores of a contact evaluation item (section or question). * **Percentage** *(float) --* The score percentage for an item in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the item as not applicable for scoring. * **AutomaticFail** *(boolean) --* The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation was created. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation was last updated. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **EvaluationForm** *(dict) --* Information about the evaluation form. * **EvaluationFormVersion** *(integer) --* A version of the evaluation form. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **Title** *(string) --* A title of the evaluation form. * **Description** *(string) --* The description of the evaluation form. * **Items** *(list) --* Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. * *(dict) --* Information about an item from an evaluation form. The item must be either a section or a question. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Section", "Question". 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'} * **Section** *(dict) --* The information of the section. * **Title** *(string) --* The title of the section. * **RefId** *(string) --* The identifier of the section. An identifier must be unique within the evaluation form. * **Instructions** *(string) --* The instructions of the section. * **Items** *(list) --* The items of the section. * **Weight** *(float) --* The scoring weight of the section. * **Question** *(dict) --* The information of the question. * **Title** *(string) --* The title of the question. * **Instructions** *(string) --* The instructions of the section. * **RefId** *(string) --* The identifier of the question. An identifier must be unique within the evaluation form. * **NotApplicableEnabled** *(boolean) --* The flag to enable not applicable answers to the question. * **QuestionType** *(string) --* The type of the question. * **QuestionTypeProperties** *(dict) --* The properties of the type of question. Text questions do not have to define question type properties. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Numeric", "SingleSelect". 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'} * **Numeric** *(dict) --* The properties of the numeric question. * **MinValue** *(integer) --* The minimum answer value. * **MaxValue** *(integer) --* The maximum answer value. * **Options** *(list) --* The scoring options of the numeric question. * *(dict) --* Information about the option range used for scoring in numeric questions. * **MinValue** *(integer) --* The minimum answer value of the range option. * **MaxValue** *(integer) --* The maximum answer value of the range option. * **Score** *(integer) --* The score assigned to answer values within the range option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **Automation** *(dict) --* The automation properties of the numeric question. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PropertyValue". 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'} * **PropertyValue** *(dict) --* The property value of the automation. * **Label** *(string) --* The property label of the automation. * **SingleSelect** *(dict) --* The properties of the numeric question. * **Options** *(list) --* The answer options of the single select question. * *(dict) --* Information about the automation configuration in single select questions. * **RefId** *(string) --* The identifier of the answer option. An identifier must be unique within the question. * **Text** *(string) --* The title of the answer option. * **Score** *(integer) --* The score assigned to the answer option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **DisplayAs** *(string) --* The display mode of the single select question. * **Automation** *(dict) --* The display mode of the single select question. * **Options** *(list) --* The automation options of the single select question. * *(dict) --* Information about the automation option of a single select question. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "RuleCategory". 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'} * **RuleCategory** *(dict) --* The automation option based on a rule category for the single select question. * **Category** *(string) --* The category name, as defined in Rules. * **Condition** *(string) --* The condition to apply for the automation option. If the condition is "PRESENT", then the option is applied when the contact data includes the category. Similarly, if the condition is "NOT_PRESENT", then the option is applied when the contact data does not include the category. * **OptionRefId** *(string) --* The identifier of the answer option. * **DefaultOptionRefId** *(string) --* The identifier of the default answer option, when none of the automation options match the criteria. * **Weight** *(float) --* The scoring weight of the section. * **ScoringStrategy** *(dict) --* A scoring strategy of the evaluation form. * **Mode** *(string) --* The scoring mode of the evaluation form. * **Status** *(string) --* The scoring status of the evaluation form. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_email_address describe_email_address ********************** Connect.Client.describe_email_address(**kwargs) Describe email address form the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.describe_email_address( InstanceId='string', EmailAddressId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EmailAddressId** (*string*) -- **[REQUIRED]** The identifier of the email address. Return type: dict Returns: **Response Syntax** { 'EmailAddressId': 'string', 'EmailAddressArn': 'string', 'EmailAddress': 'string', 'DisplayName': 'string', 'Description': 'string', 'CreateTimestamp': 'string', 'ModifiedTimestamp': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **EmailAddressId** *(string) --* The identifier of the email address. * **EmailAddressArn** *(string) --* The Amazon Resource Name (ARN) of the email address. * **EmailAddress** *(string) --* The email address, including the domain. * **DisplayName** *(string) --* The display name of email address * **Description** *(string) --* The description of the email address. * **CreateTimestamp** *(string) --* The email address creation timestamp in ISO 8601 Datetime. * **ModifiedTimestamp** *(string) --* The email address last modification timestamp in ISO 8601 Datetime. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_evaluation_forms list_evaluation_forms ********************* Connect.Client.list_evaluation_forms(**kwargs) Lists evaluation forms in the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_evaluation_forms( InstanceId='string', MaxResults=123, NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'EvaluationFormSummaryList': [ { 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string', 'Title': 'string', 'CreatedTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': 'string', 'LastActivatedTime': datetime(2015, 1, 1), 'LastActivatedBy': 'string', 'LatestVersion': 123, 'ActiveVersion': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EvaluationFormSummaryList** *(list) --* Provides details about a list of evaluation forms belonging to an instance. * *(dict) --* Summary information about an evaluation form. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **Title** *(string) --* A title of the evaluation form. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation form was created. * **CreatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who created the evaluation form. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation form was last updated. * **LastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation form. * **LastActivatedTime** *(datetime) --* The timestamp for when the evaluation form was last activated. * **LastActivatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last activated the evaluation form. * **LatestVersion** *(integer) --* The version number of the latest evaluation form version. * **ActiveVersion** *(integer) --* The version of the active evaluation form version. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_routing_profiles list_routing_profiles ********************* Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'RoutingProfileSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_contact_schedule update_contact_schedule *********************** Connect.Client.update_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) ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **ScheduledTime** (*datetime*) -- **[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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / deactivate_evaluation_form deactivate_evaluation_form ************************** Connect.Client.deactivate_evaluation_form(**kwargs) Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. See also: AWS API Documentation **Request Syntax** response = client.deactivate_evaluation_form( InstanceId='string', EvaluationFormId='string', EvaluationFormVersion=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **EvaluationFormVersion** (*integer*) -- **[REQUIRED]** A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated. Return type: dict Returns: **Response Syntax** { 'EvaluationFormId': 'string', 'EvaluationFormArn': 'string', 'EvaluationFormVersion': 123 } **Response Structure** * *(dict) --* * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **EvaluationFormVersion** *(integer) --* The version of the deactivated evaluation form resource. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / disassociate_instance_storage_config disassociate_instance_storage_config ************************************ Connect.Client.disassociate_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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AssociationId** (*string*) -- **[REQUIRED]** The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / get_prompt_file get_prompt_file *************** Connect.Client.get_prompt_file(**kwargs) Gets the prompt file. See also: AWS API Documentation **Request Syntax** response = client.get_prompt_file( InstanceId='string', PromptId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PromptId** (*string*) -- **[REQUIRED]** A unique identifier for the prompt. Return type: dict Returns: **Response Syntax** { 'PromptPresignedUrl': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **Response Structure** * *(dict) --* * **PromptPresignedUrl** *(string) --* A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_flow_associations list_flow_associations ********************** Connect.Client.list_flow_associations(**kwargs) List the flow association based on the filters. See also: AWS API Documentation **Request Syntax** response = client.list_flow_associations( InstanceId='string', ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceType** (*string*) -- A valid resource type. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'FlowAssociationSummaryList': [ { 'ResourceId': 'string', 'FlowId': 'string', 'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **FlowAssociationSummaryList** *(list) --* Summary of flow associations. * *(dict) --* Information about flow associations. * **ResourceId** *(string) --* The identifier of the resource. * **FlowId** *(string) --* The identifier of the flow. * **ResourceType** *(string) --* The type of resource association. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / search_contact_flow_modules search_contact_flow_modules *************************** Connect.Client.search_contact_flow_modules(**kwargs) Searches the flow modules in an Amazon Connect instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_contact_flow_modules( 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' }, 'StateCondition': 'ACTIVE'|'ARCHIVED', 'StatusCondition': 'PUBLISHED'|'SAVED' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return flow modules. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return flow modules. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return flow modules. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **StateCondition** *(string) --* The state of the flow. * **StatusCondition** *(string) --* The status of the flow. Return type: dict Returns: **Response Syntax** { 'ContactFlowModules': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Content': 'string', 'Description': 'string', 'State': 'ACTIVE'|'ARCHIVED', 'Status': 'PUBLISHED'|'SAVED', 'Tags': { 'string': 'string' } }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **ContactFlowModules** *(list) --* The search criteria to be used to return flow modules. * *(dict) --* Contains information about a 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 JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. * **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"} }. * *(string) --* * *(string) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of flows which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_security_profiles search_security_profiles ************************ Connect.Client.search_security_profiles(**kwargs) Searches security profiles in an Amazon Connect instance, with optional filtering. For information about security profiles, see Security Profiles in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. 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' } } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchCriteria** (*dict*) -- The search criteria to be used to return security profiles. Note: The "name" field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. Note: The currently supported value for "FieldName": "name" * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return security profiles. Note: The "name" field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return security profiles. Note: The "name" field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. Return type: dict Returns: **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"} }. * *(string) --* * *(string) --* * **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / submit_contact_evaluation submit_contact_evaluation ************************* Connect.Client.submit_contact_evaluation(**kwargs) Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ( "{}") to the question identifier. If a contact evaluation is already in submitted state, this operation will trigger a resubmission. See also: AWS API Documentation **Request Syntax** response = client.submit_contact_evaluation( InstanceId='string', EvaluationId='string', Answers={ 'string': { 'Value': { 'StringValue': 'string', 'NumericValue': 123.0, 'NotApplicable': True|False } } }, Notes={ 'string': { 'Value': 'string' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationId** (*string*) -- **[REQUIRED]** A unique identifier for the contact evaluation. * **Answers** (*dict*) -- A map of question identifiers to answer value. * *(string) --* * *(dict) --* Information about input answers for a contact evaluation. * **Value** *(dict) --* The value for an answer in a contact evaluation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringValue", "NumericValue", "NotApplicable". * **StringValue** *(string) --* The string value for an answer in a contact evaluation. * **NumericValue** *(float) --* The numeric value for an answer in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the question as not applicable. * **Notes** (*dict*) -- A map of question identifiers to note value. * *(string) --* * *(dict) --* Information about notes for a contact evaluation. * **Value** *(string) --* The note for an item (section or question) in a contact evaluation. Note: Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024. Return type: dict Returns: **Response Syntax** { 'EvaluationId': 'string', 'EvaluationArn': 'string' } **Response Structure** * *(dict) --* * **EvaluationId** *(string) --* A unique identifier for the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / update_hours_of_operation update_hours_of_operation ************************* Connect.Client.update_hours_of_operation(**kwargs) 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 } }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier of the hours of operation. * **Name** (*string*) -- The name of the hours of operation. * **Description** (*string*) -- The description of the hours of operation. * **TimeZone** (*string*) -- The time zone of the hours of operation. * **Config** (*list*) -- Configuration information of the hours of operation. * *(dict) --* Contains information about the hours of operation. * **Day** *(string) --* **[REQUIRED]** The day that the hours of operation applies to. * **StartTime** *(dict) --* **[REQUIRED]** The start time that your contact center opens. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **EndTime** *(dict) --* **[REQUIRED]** The end time that your contact center closes. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. Returns: None **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_routing_profile_name update_routing_profile_name *************************** Connect.Client.update_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **Name** (*string*) -- The name of the routing profile. Must not be more than 127 characters. * **Description** (*string*) -- The description of the routing profile. Must not be more than 250 characters. Returns: None **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / untag_contact untag_contact ************* Connect.Client.untag_contact(**kwargs) Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage. See also: AWS API Documentation **Request Syntax** response = client.untag_contact( ContactId='string', InstanceId='string', TagKeys=[ 'string', ] ) Parameters: * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **TagKeys** (*list*) -- **[REQUIRED]** A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / transfer_contact transfer_contact **************** Connect.Client.transfer_contact(**kwargs) Transfers "TASK" or "EMAIL" contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. Note the following requirements: * Transfer is only supported for "TASK" and "EMAIL" contacts. * Do not use both "QueueId" and "UserId" in the same call. * The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. * The "TransferContact" API can be called only on active contacts. * A contact cannot be transferred more than 11 times. See also: AWS API Documentation **Request Syntax** response = client.transfer_contact( InstanceId='string', ContactId='string', QueueId='string', UserId='string', ContactFlowId='string', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **QueueId** (*string*) -- The identifier for the queue. * **UserId** (*string*) -- The identifier for the user. This can be the ID or the ARN of the user. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_predefined_attributes search_predefined_attributes **************************** Connect.Client.search_predefined_attributes(**kwargs) Searches predefined attributes that meet certain criteria. *Predefined attributes* are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. See also: AWS API Documentation **Request Syntax** response = client.search_predefined_attributes( InstanceId='string', NextToken='string', MaxResults=123, SearchCriteria={ 'OrConditions': [ {'... recursive ...'}, ], 'AndConditions': [ {'... recursive ...'}, ], 'StringCondition': { 'FieldName': 'string', 'Value': 'string', 'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchCriteria** (*dict*) -- The search criteria to be used to return predefined attributes. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return predefined attributes. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return predefined attributes. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. Return type: dict Returns: **Response Syntax** { 'PredefinedAttributes': [ { 'Name': 'string', 'Values': { 'StringList': [ 'string', ] }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **PredefinedAttributes** *(list) --* Predefined attributes matched by the search criteria. * *(dict) --* Information about a predefined attribute. * **Name** *(string) --* The name of the predefined attribute. * **Values** *(dict) --* The values of the predefined attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "StringList". 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'} * **StringList** *(list) --* Predefined attribute values of type string list. * *(string) --* * **LastModifiedTime** *(datetime) --* Last modified time. * **LastModifiedRegion** *(string) --* Last modified region. * **NextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **ApproximateTotalCount** *(integer) --* The approximate number of predefined attributes which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_contact_flow_versions list_contact_flow_versions ************************** Connect.Client.list_contact_flow_versions(**kwargs) Returns all the available versions for the specified Amazon Connect instance and flow identifier. See also: AWS API Documentation **Request Syntax** response = client.list_contact_flow_versions( InstanceId='string', ContactFlowId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'ContactFlowVersionSummaryList': [ { 'Arn': 'string', 'VersionDescription': 'string', 'Version': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ContactFlowVersionSummaryList** *(list) --* A list of flow version summaries. * *(dict) --* A summary of a flow version's metadata. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view version. * **VersionDescription** *(string) --* The description of the flow version. * **Version** *(integer) --* The identifier of the flow version. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / resume_contact resume_contact ************** Connect.Client.resume_contact(**kwargs) Allows resuming a task contact in a paused state. See also: AWS API Documentation **Request Syntax** response = client.resume_contact( ContactId='string', InstanceId='string', ContactFlowId='string' ) Parameters: * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the "instanceId" in the ARN of the instance. * **ContactFlowId** (*string*) -- The identifier of the flow. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ConflictException" Connect / Client / list_user_hierarchy_groups list_user_hierarchy_groups ************************** Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'UserHierarchyGroupSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_instances list_instances ************** Connect.Client.list_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 ) Parameters: * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **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, 'InstanceAccessUrl': 'string' }, ], '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. * **InstanceAccessUrl** *(string) --* This URL allows contact center users to access the Amazon Connect admin website. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_routing_profile describe_routing_profile ************************ Connect.Client.describe_routing_profile(**kwargs) Describes the specified routing profile. Note: "DescribeRoutingProfile" does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds. See also: AWS API Documentation **Request Syntax** response = client.describe_routing_profile( InstanceId='string', RoutingProfileId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. Return type: dict Returns: **Response Syntax** { 'RoutingProfile': { 'InstanceId': 'string', 'Name': 'string', 'RoutingProfileArn': 'string', 'RoutingProfileId': 'string', 'Description': 'string', 'MediaConcurrencies': [ { 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'Concurrency': 123, 'CrossChannelBehavior': { 'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL' } }, ], 'DefaultOutboundQueueId': 'string', 'Tags': { 'string': 'string' }, 'NumberOfAssociatedQueues': 123, 'NumberOfAssociatedUsers': 123, 'AgentAvailabilityTimer': 'TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string', 'IsDefault': True|False, 'AssociatedQueueIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **RoutingProfile** *(dict) --* The routing profile. * **InstanceId** *(string) --* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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. * **CrossChannelBehavior** *(dict) --* Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel. * **BehaviorType** *(string) --* Specifies the other channels that can be routed to an agent handling their current channel. * **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"} }. * *(string) --* * *(string) --* * **NumberOfAssociatedQueues** *(integer) --* The number of associated queues in routing profile. * **NumberOfAssociatedUsers** *(integer) --* The number of associated users in routing profile. * **AgentAvailabilityTimer** *(string) --* Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **IsDefault** *(boolean) --* Whether this a default routing profile. * **AssociatedQueueIds** *(list) --* The IDs of the associated queue. * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_queue_outbound_email_config update_queue_outbound_email_config ********************************** Connect.Client.update_queue_outbound_email_config(**kwargs) Updates the outbound email address Id for a specified queue. See also: AWS API Documentation **Request Syntax** response = client.update_queue_outbound_email_config( InstanceId='string', QueueId='string', OutboundEmailConfig={ 'OutboundEmailAddressId': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **OutboundEmailConfig** (*dict*) -- **[REQUIRED]** The outbound email address ID for a specified queue. * **OutboundEmailAddressId** *(string) --* The identifier of the email address. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ConditionalOperationFailedException" Connect / Client / describe_user describe_user ************* Connect.Client.describe_user(**kwargs) Describes the specified user. You can find the instance ID in the Amazon Connect 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' ) Parameters: * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. * **LastName** *(string) --* The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. * **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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW. 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. * *(string) --* * **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. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_vocabulary create_vocabulary ***************** Connect.Client.create_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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', Content='string', Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. 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. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **VocabularyName** (*string*) -- **[REQUIRED]** A unique name of the custom vocabulary. * **LanguageCode** (*string*) -- **[REQUIRED]** The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe? * **Content** (*string*) -- **[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. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.ServiceQuotaExceededException" Connect / Client / batch_get_flow_association batch_get_flow_association ************************** Connect.Client.batch_get_flow_association(**kwargs) Retrieve the flow associations for the given resources. See also: AWS API Documentation **Request Syntax** response = client.batch_get_flow_association( InstanceId='string', ResourceIds=[ 'string', ], ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceIds** (*list*) -- **[REQUIRED]** A list of resource identifiers to retrieve flow associations. * Amazon Web Services End User Messaging SMS phone number ARN when using "SMS_PHONE_NUMBER" * Amazon Web Services End User Messaging Social phone number ARN when using "WHATSAPP_MESSAGING_PHONE_NUMBER" * *(string) --* * **ResourceType** (*string*) -- The type of resource association. Return type: dict Returns: **Response Syntax** { 'FlowAssociationSummaryList': [ { 'ResourceId': 'string', 'FlowId': 'string', 'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR' }, ] } **Response Structure** * *(dict) --* * **FlowAssociationSummaryList** *(list) --* Information about flow associations. * *(dict) --* Information about flow associations. * **ResourceId** *(string) --* The identifier of the resource. * **FlowId** *(string) --* The identifier of the flow. * **ResourceType** *(string) --* The type of resource association. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / disassociate_bot disassociate_bot **************** Connect.Client.disassociate_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' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **LexBot** (*dict*) -- Configuration information of an Amazon Lex bot. * **Name** *(string) --* **[REQUIRED]** The name of the Amazon Lex bot. * **LexRegion** *(string) --* **[REQUIRED]** The Amazon Web Services Region where the Amazon Lex bot was created. * **LexV2Bot** (*dict*) -- The Amazon Lex V2 bot to disassociate from the instance. * **AliasArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Lex V2 bot. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_phone_number update_phone_number ******************* Connect.Client.update_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: After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.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', InstanceId='string', ClientToken='string' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** A unique identifier for the phone number. * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter "InstanceId" or "TargetArn". * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter "InstanceId" or "TargetArn". * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / get_metric_data get_metric_data *************** Connect.Client.get_metric_data(**kwargs) Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Metrics definitions in the *Amazon Connect Administrator Guide*. Note: We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than "GetMetricData". Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week. 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'|'EMAIL', ], 'RoutingProfiles': [ 'string', ], 'RoutingStepExpressions': [ 'string', ] }, Groupings=[ 'QUEUE'|'CHANNEL'|'ROUTING_PROFILE'|'ROUTING_STEP_EXPRESSION', ], 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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **StartTime** (*datetime*) -- **[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. * **EndTime** (*datetime*) -- **[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. * **Filters** (*dict*) -- **[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. RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to- date features. Note: To filter by "Queues", enter the queue ID/ARN, not the name of the queue. * **Queues** *(list) --* 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. * *(string) --* * **Channels** *(list) --* The channel to use to filter the metrics. * *(string) --* * **RoutingProfiles** *(list) --* A list of up to 100 routing profile IDs or ARNs. * *(string) --* * **RoutingStepExpressions** *(list) --* A list of expressions as a filter, in which an expression is an object of a step in a routing criteria. * *(string) --* * **Groupings** (*list*) -- 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. RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to- date features. * *(string) --* * **HistoricalMetrics** (*list*) -- **[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 Metrics definition 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 UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time 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"). UI name: Average queue abandon time * *(dict) --* Contains information about a historical metric. * **Name** *(string) --* The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the *Amazon Connect Administrator Guide*. ABANDON_TIME Unit: SECONDS Statistic: AVG UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time 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"). UI name: Service level X * **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. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'MetricResults': [ { 'Dimensions': { 'Queue': { 'Id': 'string', 'Arn': 'string' }, 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'RoutingProfile': { 'Id': 'string', 'Arn': 'string' }, 'RoutingStepExpression': 'string' }, '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. * **RoutingProfile** *(dict) --* Information about the routing profile assigned to the user. * **Id** *(string) --* The identifier of the routing profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the routing profile. * **RoutingStepExpression** *(string) --* The expression of a step in a routing criteria. * **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. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the *Amazon Connect Administrator Guide*. ABANDON_TIME Unit: SECONDS Statistic: AVG UI name: Average queue abandon time AFTER_CONTACT_WORK_TIME Unit: SECONDS Statistic: AVG UI name: After contact work time API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: API contacts handled AVG_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average customer hold time CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Callback contacts handled CONTACTS_ABANDONED Unit: COUNT Statistic: SUM UI name: Contacts abandoned CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM UI name: Contacts agent hung up first CONTACTS_CONSULTED Unit: COUNT Statistic: SUM UI name: Contacts consulted CONTACTS_HANDLED Unit: COUNT Statistic: SUM UI name: Contacts handled CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM UI name: Contacts handled incoming CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM UI name: Contacts handled outbound CONTACTS_HOLD_ABANDONS Unit: COUNT Statistic: SUM UI name: Contacts hold disconnect CONTACTS_MISSED Unit: COUNT Statistic: SUM UI name: AGENT_NON_RESPONSE CONTACTS_QUEUED Unit: COUNT Statistic: SUM UI name: Contacts queued CONTACTS_TRANSFERRED_IN Unit: COUNT Statistic: SUM UI name: Contacts transferred in CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM UI name: Contacts transferred out CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM UI name: Contacts transferred out queue HANDLE_TIME Unit: SECONDS Statistic: AVG UI name: Average handle time INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction and customer hold time INTERACTION_TIME Unit: SECONDS Statistic: AVG UI name: Average agent interaction time OCCUPANCY Unit: PERCENT Statistic: AVG UI name: Occupancy QUEUE_ANSWER_TIME Unit: SECONDS Statistic: AVG UI name: Average queue answer time QUEUED_TIME Unit: SECONDS Statistic: MAX UI name: Minimum flow time 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"). UI name: Service level X * **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / get_traffic_distribution get_traffic_distribution ************************ Connect.Client.get_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' ) Parameters: **Id** (*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. Return type: dict Returns: **Response Syntax** { 'TelephonyConfig': { 'Distributions': [ { 'Region': 'string', 'Percentage': 123 }, ] }, 'Id': 'string', 'Arn': 'string', 'SignInConfig': { 'Distributions': [ { 'Region': 'string', 'Enabled': True|False }, ] }, 'AgentConfig': { 'Distributions': [ { 'Region': 'string', 'Percentage': 123 }, ] } } **Response Structure** * *(dict) --* * **TelephonyConfig** *(dict) --* The distribution of traffic between the instance and its replicas. * **Distributions** *(list) --* Information about traffic distributions. * *(dict) --* Information about a traffic distribution. * **Region** *(string) --* The Amazon Web Services Region where the traffic is distributed. * **Percentage** *(integer) --* The percentage of the traffic that is distributed, in increments of 10. * **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. * **SignInConfig** *(dict) --* The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s). * **Distributions** *(list) --* Information about traffic distributions. * *(dict) --* The distribution of sign in traffic between the instance and its replica(s). * **Region** *(string) --* The Amazon Web Services Region of the sign in distribution. * **Enabled** *(boolean) --* Whether sign in distribution is enabled. * **AgentConfig** *(dict) --* The distribution of agents between the instance and its replica(s). * **Distributions** *(list) --* Information about traffic distributions. * *(dict) --* Information about a traffic distribution. * **Region** *(string) --* The Amazon Web Services Region where the traffic is distributed. * **Percentage** *(integer) --* The percentage of the traffic that is distributed, in increments of 10. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / describe_user_hierarchy_group describe_user_hierarchy_group ***************************** Connect.Client.describe_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' ) Parameters: * **HierarchyGroupId** (*string*) -- **[REQUIRED]** The identifier of the hierarchy group. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** { 'HierarchyGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LevelId': 'string', 'HierarchyPath': { 'LevelOne': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelTwo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelThree': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFour': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFive': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } }, 'Tags': { 'string': 'string' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_bots list_bots ********* Connect.Client.list_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 return 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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **LexVersion** (*string*) -- **[REQUIRED]** The version of Amazon Lex or Amazon Lex V2. Return type: dict Returns: **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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / import_phone_number import_phone_number ******************* Connect.Client.import_phone_number(**kwargs) Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Warning: Call the DescribePhoneNumber API to verify the status of a previous "ImportPhoneNumber" operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web ServicesSupport ticket. See also: AWS API Documentation **Request Syntax** response = client.import_phone_number( InstanceId='string', SourcePhoneNumberArn='string', PhoneNumberDescription='string', Tags={ 'string': 'string' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **SourcePhoneNumberArn** (*string*) -- **[REQUIRED]** The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import from Amazon Web Services End User Messaging. * **PhoneNumberDescription** (*string*) -- The description of the phone number. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / update_user_hierarchy_structure update_user_hierarchy_structure ******************************* Connect.Client.update_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' ) Parameters: * **HierarchyStructure** (*dict*) -- **[REQUIRED]** The hierarchy levels to update. * **LevelOne** *(dict) --* The update for level one. * **Name** *(string) --* **[REQUIRED]** The name of the user hierarchy level. Must not be more than 50 characters. * **LevelTwo** *(dict) --* The update for level two. * **Name** *(string) --* **[REQUIRED]** The name of the user hierarchy level. Must not be more than 50 characters. * **LevelThree** *(dict) --* The update for level three. * **Name** *(string) --* **[REQUIRED]** The name of the user hierarchy level. Must not be more than 50 characters. * **LevelFour** *(dict) --* The update for level four. * **Name** *(string) --* **[REQUIRED]** The name of the user hierarchy level. Must not be more than 50 characters. * **LevelFive** *(dict) --* The update for level five. * **Name** *(string) --* **[REQUIRED]** The name of the user hierarchy level. Must not be more than 50 characters. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_queue_quick_connects associate_queue_quick_connects ****************************** Connect.Client.associate_queue_quick_connects(**kwargs) 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', ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **QuickConnectIds** (*list*) -- **[REQUIRED]** The quick connects to associate with this queue. * *(string) --* Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_outbound_voice_contact start_outbound_voice_contact **************************** Connect.Client.start_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( Name='string', Description='string', References={ 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } }, RelatedContactId='string', 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' ) Parameters: * **Name** (*string*) -- The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP). * **Description** (*string*) -- A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see Download and review CCP logs in the *Amazon Connect Administrator Guide*. * **References** (*dict*) -- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: "URL" | "NUMBER" | "STRING" | "DATE" | "EMAIL". "ATTACHMENT" is not a supported reference type during voice contact creation. * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **RelatedContactId** (*string*) -- The "contactId" that is related to this contact. Linking voice, task, or chat by using "RelatedContactID" copies over contact attributes from the related contact to the new contact. All updates to user- defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using "RelatedContactId". * **DestinationPhoneNumber** (*string*) -- **[REQUIRED]** The phone number of the customer, in E.164 format. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, 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** * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. 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. * **SourcePhoneNumber** (*string*) -- The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue. * **QueueId** (*string*) -- The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number. * **Attributes** (*dict*) -- 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. * *(string) --* * *(string) --* * **AnswerMachineDetectionConfig** (*dict*) -- Configuration of the answering machine detection for this outbound call. * **EnableAnswerMachineDetection** *(boolean) --* 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". * **AwaitAnswerMachinePrompt** *(boolean) --* Wait for the answering machine prompt. * **CampaignId** (*string*) -- The campaign identifier of the outbound communication. * **TrafficType** (*string*) -- Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is "GENERAL". Use "CAMPAIGN" if "EnableAnswerMachineDetection" is set to "true". For all other cases, use "GENERAL". Return type: dict Returns: **Response Syntax** { 'ContactId': 'string' } **Response Structure** * *(dict) --* * **ContactId** *(string) --* The identifier of this contact within the Amazon Connect instance. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.DestinationNotAllowedException" * "Connect.Client.exceptions.OutboundContactNotPermittedException" Connect / Client / update_queue_max_contacts update_queue_max_contacts ************************* Connect.Client.update_queue_max_contacts(**kwargs) 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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **MaxContacts** (*integer*) -- The maximum number of contacts that can be in the queue before it is considered full. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_user_proficiencies list_user_proficiencies *********************** Connect.Client.list_user_proficiencies(**kwargs) Lists proficiencies associated with a user. See also: AWS API Documentation **Request Syntax** response = client.list_user_proficiencies( InstanceId='string', UserId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'UserProficiencyList': [ { 'AttributeName': 'string', 'AttributeValue': 'string', 'Level': ... }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **UserProficiencyList** *(list) --* Information about the user proficiencies. * *(dict) --* Information about proficiency of a user. * **AttributeName** *(string) --* The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance. * **AttributeValue** *(string) --* The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance. * **Level** *(float) --* The level of the proficiency. The valid values are 1, 2, 3, 4 and 5. * **LastModifiedTime** *(datetime) --* The last time that the user's proficiencies are were modified. * **LastModifiedRegion** *(string) --* The region in which a user's proficiencies were last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / send_outbound_email send_outbound_email ******************* Connect.Client.send_outbound_email(**kwargs) Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns. Note: Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. See also: AWS API Documentation **Request Syntax** response = client.send_outbound_email( InstanceId='string', FromEmailAddress={ 'EmailAddress': 'string', 'DisplayName': 'string' }, DestinationEmailAddress={ 'EmailAddress': 'string', 'DisplayName': 'string' }, AdditionalRecipients={ 'CcEmailAddresses': [ { 'EmailAddress': 'string', 'DisplayName': 'string' }, ] }, EmailMessage={ 'MessageSourceType': 'TEMPLATE'|'RAW', 'TemplatedMessageConfig': { 'KnowledgeBaseId': 'string', 'MessageTemplateId': 'string', 'TemplateAttributes': { 'CustomAttributes': { 'string': 'string' }, 'CustomerProfileAttributes': 'string' } }, 'RawMessage': { 'Subject': 'string', 'Body': 'string', 'ContentType': 'string' } }, TrafficType='GENERAL'|'CAMPAIGN', SourceCampaign={ 'CampaignId': 'string', 'OutboundRequestId': 'string' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **FromEmailAddress** (*dict*) -- **[REQUIRED]** The email address to be used for sending email. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **DestinationEmailAddress** (*dict*) -- **[REQUIRED]** The email address to send the email to. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **AdditionalRecipients** (*dict*) -- The additional recipients address of the email in CC. * **CcEmailAddresses** *(list) --* Information about the **additional** CC email address recipients. Email recipients are limited to 50 total addresses: 1 required recipient in the DestinationEmailAddress field and up to 49 recipients in the 'CcEmailAddresses' field. * *(dict) --* Contains information about a source or destination email address. * **EmailAddress** *(string) --* **[REQUIRED]** The email address, including the domain. * **DisplayName** *(string) --* The display name of email address. * **EmailMessage** (*dict*) -- **[REQUIRED]** The email message body to be sent to the newly created email. * **MessageSourceType** *(string) --* **[REQUIRED]** The message source type, that is, "RAW" or "TEMPLATE". * **TemplatedMessageConfig** *(dict) --* Information about template message configuration. * **KnowledgeBaseId** *(string) --* **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **MessageTemplateId** *(string) --* **[REQUIRED]** The identifier of the message template Id. * **TemplateAttributes** *(dict) --* **[REQUIRED]** Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes. * **CustomAttributes** *(dict) --* An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. * *(string) --* * *(string) --* * **CustomerProfileAttributes** *(string) --* An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. * **RawMessage** *(dict) --* The raw email body content. * **Subject** *(string) --* **[REQUIRED]** The email subject. * **Body** *(string) --* **[REQUIRED]** The email message body. * **ContentType** *(string) --* **[REQUIRED]** Type of content, that is, "text/plain" or "text/html". * **TrafficType** (*string*) -- **[REQUIRED]** Denotes the class of traffic. Note: Only the CAMPAIGN traffic type is supported. * **SourceCampaign** (*dict*) -- A Campaign object need for Campaign traffic type. * **CampaignId** *(string) --* A unique identifier for a campaign. * **OutboundRequestId** *(string) --* A unique identifier for a each request part of same campaign. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" Connect / Client / update_user_hierarchy_group_name update_user_hierarchy_group_name ******************************** Connect.Client.update_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' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the hierarchy group. Must not be more than 100 characters. * **HierarchyGroupId** (*string*) -- **[REQUIRED]** The identifier of the hierarchy group. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_view_version delete_view_version ******************* Connect.Client.delete_view_version(**kwargs) Deletes the particular version specified in "ViewVersion" identifier. See also: AWS API Documentation **Request Syntax** response = client.delete_view_version( InstanceId='string', ViewId='string', ViewVersion=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. * **ViewVersion** (*integer*) -- **[REQUIRED]** The version number of the view. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / delete_view delete_view *********** Connect.Client.delete_view(**kwargs) Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases). See also: AWS API Documentation **Request Syntax** response = client.delete_view( InstanceId='string', ViewId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / start_chat_contact start_chat_contact ****************** Connect.Client.start_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: * API rate limit is exceeded. API TPS throttling returns a "TooManyRequests" exception. * The quota for concurrent active chats is exceeded. Active chat throttling returns a "LimitExceededException". If you use the "ChatDurationInMinutes" parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web ServicesSupport. For more information about chat, see the following topics in the *Amazon Connect Administrator Guide*: * Concepts: Web and mobile messaging capabilities in Amazon Connect * Amazon Connect Chat security best practices 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', ], PersistentChat={ 'RehydrationType': 'ENTIRE_PAST_SESSION'|'FROM_SEGMENT', 'SourceContactId': 'string' }, RelatedContactId='string', SegmentAttributes={ 'string': { 'ValueString': 'string', 'ValueMap': { 'string': {'... recursive ...'} }, 'ValueInteger': 123 } }, CustomerId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **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** * **Attributes** (*dict*) -- 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. * *(string) --* * *(string) --* * **ParticipantDetails** (*dict*) -- **[REQUIRED]** Information identifying the participant. * **DisplayName** *(string) --* **[REQUIRED]** Display name of the participant. * **InitialMessage** (*dict*) -- The initial message to be sent to the newly created chat. * **ContentType** *(string) --* **[REQUIRED]** The type of the content. Supported types are "text/plain", "text/markdown", "application/json", and "application/vnd.a mazonaws.connect.message.interactive.response". * **Content** *(string) --* **[REQUIRED]** The content of the chat message. * For "text/plain" and "text/markdown", the Length Constraints are Minimum of 1, Maximum of 1024. * For "application/json", the Length Constraints are Minimum of 1, Maximum of 12000. * For "application/vnd.amazonaws.connect.message.interactiv e.response", the Length Constraints are Minimum of 1, Maximum of 12288. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **ChatDurationInMinutes** (*integer*) -- The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days). * **SupportedMessagingContentTypes** (*list*) -- The supported chat message content types. Supported types are "text/plain", "text/markdown", "application/json", "application/vnd.amazonaws.connect.message.interactive", and "application/vnd.amazonaws.connect.message.interactive.respon se". Content types must always contain "text/plain". You can then put any other supported type in the list. For example, all the following lists are valid because they contain "text/plain": "[text/plain, text/markdown, application/json]", "[text/markdown, text/plain]", "[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.respons e]". Note: The type "application/vnd.amazonaws.connect.message.interactive" is required to use the Show view flow block. * *(string) --* * **PersistentChat** (*dict*) -- Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat. * **RehydrationType** *(string) --* The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat. * "ENTIRE_PAST_SESSION": Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the "initialContactId" of the past ended chat session in the "sourceContactId" field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat. * "FROM_SEGMENT": Rehydrates a chat from the past chat contact that is specified in the "sourceContactId" field. The actual contactId used for rehydration is provided in the response of this API. * **SourceContactId** *(string) --* The contactId from which a persistent chat session must be started. * **RelatedContactId** (*string*) -- The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting. Note: You cannot provide data for both RelatedContactId and PersistentChat. * **SegmentAttributes** (*dict*) -- A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows. Attribute keys can include only alphanumeric, -, and _. This field can be used to show channel subtype, such as "connect:Guide". Note: The types "application/vnd.amazonaws.connect.message.interactive" and "application/vnd.amazonaws.connect.message.interactive.resp onse" must be present in the SupportedMessagingContentTypes field of this API in order to set "SegmentAttributes" as { `` "connect:Subtype": {"valueString" : "connect:Guide" }}``. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueString** *(string) --* The value of a segment attribute. * **ValueMap** *(dict) --* The value of a segment attribute. * *(string) --* * *(dict) --* A value for a segment attribute. This is structured as a map where the key is "valueString" and the value is a string. * **ValueInteger** *(integer) --* The value of a segment attribute. * **CustomerId** (*string*) -- The customer's identification number. For example, the "CustomerId" may be a customer number from your CRM. Return type: dict Returns: **Response Syntax** { 'ContactId': 'string', 'ParticipantId': 'string', 'ParticipantToken': 'string', 'ContinuedFromContactId': '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. * **ContinuedFromContactId** *(string) --* The contactId from which a persistent chat session is started. This field is populated only for persistent chats. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.LimitExceededException" Connect / Client / close close ***** Connect.Client.close() Closes underlying endpoint connections. Connect / Client / search_contact_flows search_contact_flows ******************** Connect.Client.search_contact_flows(**kwargs) Searches the flows in an Amazon Connect instance, with optional filtering. See also: AWS API Documentation **Request Syntax** response = client.search_contact_flows( 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' }, 'TypeCondition': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN', 'StateCondition': 'ACTIVE'|'ARCHIVED', 'StatusCondition': 'PUBLISHED'|'SAVED' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return flows. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* The search criteria to be used to return flows. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* The search criteria to be used to return flows. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. * **TypeCondition** *(string) --* The type of flow. * **StateCondition** *(string) --* The state of the flow. * **StatusCondition** *(string) --* The status of the flow. Return type: dict Returns: **Response Syntax** { 'ContactFlows': [ { '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'|'CAMPAIGN', 'State': 'ACTIVE'|'ARCHIVED', 'Status': 'PUBLISHED'|'SAVED', 'Description': 'string', 'Content': 'string', 'Tags': { 'string': 'string' }, 'FlowContentSha256': 'string', 'Version': 123, 'VersionDescription': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], 'NextToken': 'string', 'ApproximateTotalCount': 123 } **Response Structure** * *(dict) --* * **ContactFlows** *(list) --* Information about the flows. * *(dict) --* Contains information about a 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. * **Status** *(string) --* The status of the flow. * **Description** *(string) --* The description of the flow. * **Content** *(string) --* The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **FlowContentSha256** *(string) --* Indicates the checksum value of the flow content. * **Version** *(integer) --* The identifier of the flow version. * **VersionDescription** *(string) --* The description of the flow version. * **LastModifiedTime** *(datetime) --* The time at which the flow was last modified. * **LastModifiedRegion** *(string) --* The region in which the flow was last modified * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **ApproximateTotalCount** *(integer) --* The total number of flows which matched your search query. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_bot associate_bot ************* Connect.Client.associate_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' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **LexBot** (*dict*) -- Configuration information of an Amazon Lex bot. * **Name** *(string) --* **[REQUIRED]** The name of the Amazon Lex bot. * **LexRegion** *(string) --* **[REQUIRED]** The Amazon Web Services Region where the Amazon Lex bot was created. * **LexV2Bot** (*dict*) -- The Amazon Lex V2 bot to associate with the instance. * **AliasArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Lex V2 bot. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / delete_quick_connect delete_quick_connect ******************** Connect.Client.delete_quick_connect(**kwargs) Deletes a quick connect. Warning: After calling DeleteUser, it's important to call "DeleteQuickConnect" to delete any records related to the deleted users. This will help you: * Avoid dangling resources that impact your service quotas. * Remove deleted users so they don't appear to agents as transfer options. * Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency. See also: AWS API Documentation **Request Syntax** response = client.delete_quick_connect( InstanceId='string', QuickConnectId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QuickConnectId** (*string*) -- **[REQUIRED]** The identifier for the quick connect. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / release_phone_number release_phone_number ******************** Connect.Client.release_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 admin website.After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web ServicesSupport. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. See also: AWS API Documentation **Request Syntax** response = client.release_phone_number( PhoneNumberId='string', ClientToken='string' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** A unique identifier for the phone number. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / delete_hours_of_operation delete_hours_of_operation ************************* Connect.Client.delete_hours_of_operation(**kwargs) Deletes an hours of operation. See also: AWS API Documentation **Request Syntax** response = client.delete_hours_of_operation( InstanceId='string', HoursOfOperationId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_views list_views ********** Connect.Client.list_views(**kwargs) Returns views in the given instance. Results are sorted primarily by type, and secondarily by name. See also: AWS API Documentation **Request Syntax** response = client.list_views( InstanceId='string', Type='CUSTOMER_MANAGED'|'AWS_MANAGED', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **Type** (*string*) -- The type of the view. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'ViewsSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Status': 'PUBLISHED'|'SAVED', 'Description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ViewsSummaryList** *(list) --* A list of view summaries. * *(dict) --* A summary of a view's metadata. * **Id** *(string) --* The identifier of the view. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view. * **Name** *(string) --* The name of the view. * **Type** *(string) --* The type of the view. * **Status** *(string) --* Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Description** *(string) --* The description of the view. * **NextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" Connect / Client / associate_lex_bot associate_lex_bot ***************** Connect.Client.associate_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 V1 bot. This API only supports the association of Amazon Lex V1 bots. See also: AWS API Documentation **Request Syntax** response = client.associate_lex_bot( InstanceId='string', LexBot={ 'Name': 'string', 'LexRegion': 'string' }, ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **LexBot** (*dict*) -- **[REQUIRED]** The Amazon Lex bot to associate with the instance. * **Name** *(string) --* **[REQUIRED]** The name of the Amazon Lex bot. * **LexRegion** *(string) --* **[REQUIRED]** The Amazon Web Services Region where the Amazon Lex bot was created. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_hours_of_operation_override update_hours_of_operation_override ********************************** Connect.Client.update_hours_of_operation_override(**kwargs) Update the hours of operation override. See also: AWS API Documentation **Request Syntax** response = client.update_hours_of_operation_override( InstanceId='string', HoursOfOperationId='string', HoursOfOperationOverrideId='string', Name='string', Description='string', Config=[ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], EffectiveFrom='string', EffectiveTill='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. * **HoursOfOperationOverrideId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation override. * **Name** (*string*) -- The name of the hours of operation override. * **Description** (*string*) -- The description of the hours of operation override. * **Config** (*list*) -- Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **EffectiveFrom** (*string*) -- The date from when the hours of operation override would be effective. * **EffectiveTill** (*string*) -- The date till when the hours of operation override would be effective. Returns: None **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ConditionalOperationFailedException" Connect / Client / update_queue_name update_queue_name ***************** Connect.Client.update_queue_name(**kwargs) 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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueId** (*string*) -- **[REQUIRED]** The identifier for the queue. * **Name** (*string*) -- The name of the queue. * **Description** (*string*) -- The description of the queue. Returns: None **Exceptions** * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_contact_flow_module create_contact_flow_module ************************** Connect.Client.create_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the flow module. * **Description** (*string*) -- The description of the flow module. * **Content** (*string*) -- **[REQUIRED]** The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidContactFlowModuleException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_contact_flow_name update_contact_flow_name ************************ Connect.Client.update_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **Name** (*string*) -- The name of the flow. * **Description** (*string*) -- The description of the flow. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_authentication_profile describe_authentication_profile ******************************* Connect.Client.describe_authentication_profile(**kwargs) This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport. Describes the target authentication profile. See also: AWS API Documentation **Request Syntax** response = client.describe_authentication_profile( AuthenticationProfileId='string', InstanceId='string' ) Parameters: * **AuthenticationProfileId** (*string*) -- **[REQUIRED]** A unique identifier for the authentication profile. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** { 'AuthenticationProfile': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Description': 'string', 'AllowedIps': [ 'string', ], 'BlockedIps': [ 'string', ], 'IsDefault': True|False, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string', 'PeriodicSessionDuration': 123, 'MaxSessionDuration': 123 } } **Response Structure** * *(dict) --* * **AuthenticationProfile** *(dict) --* The authentication profile object being described. * **Id** *(string) --* A unique identifier for the authentication profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) for the authentication profile. * **Name** *(string) --* The name for the authentication profile. * **Description** *(string) --* The description for the authentication profile. * **AllowedIps** *(list) --* A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the *Amazon Connect Administrator Guide*. * *(string) --* * **BlockedIps** *(list) --* A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the *Amazon Connect Administrator Guide*. * *(string) --* * **IsDefault** *(boolean) --* Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile. * **CreatedTime** *(datetime) --* The timestamp when the authentication profile was created. * **LastModifiedTime** *(datetime) --* The timestamp when the authentication profile was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where the authentication profile was last modified. * **PeriodicSessionDuration** *(integer) --* The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the *Amazon Connect Administrator Guide*. * **MaxSessionDuration** *(integer) --* The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the *Amazon Connect Administrator Guide*. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_contact_flow_module_content update_contact_flow_module_content ********************************** Connect.Client.update_contact_flow_module_content(**kwargs) Updates specified flow module for the specified Amazon Connect instance. Use the "$SAVED" alias in the request to describe the "SAVED" content of a Flow. For example, "arn:aws:.../contact- flow/{id}:$SAVED". After a flow is published, "$SAVED" needs to be supplied to view saved content that has not been published. See also: AWS API Documentation **Request Syntax** response = client.update_contact_flow_module_content( InstanceId='string', ContactFlowModuleId='string', Content='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactFlowModuleId** (*string*) -- **[REQUIRED]** The identifier of the flow module. * **Content** (*string*) -- **[REQUIRED]** The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidContactFlowModuleException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_email_address create_email_address ******************** Connect.Client.create_email_address(**kwargs) Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide. See also: AWS API Documentation **Request Syntax** response = client.create_email_address( Description='string', InstanceId='string', EmailAddress='string', DisplayName='string', Tags={ 'string': 'string' }, ClientToken='string' ) Parameters: * **Description** (*string*) -- The description of the email address. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EmailAddress** (*string*) -- **[REQUIRED]** The email address, including the domain. * **DisplayName** (*string*) -- The display name of email address * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. Return type: dict Returns: **Response Syntax** { 'EmailAddressId': 'string', 'EmailAddressArn': 'string' } **Response Structure** * *(dict) --* * **EmailAddressId** *(string) --* The identifier of the email address. * **EmailAddressArn** *(string) --* The Amazon Resource Name (ARN) of the email address. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / describe_phone_number describe_phone_number ********************* Connect.Client.describe_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 receive a "ResourceNotFoundException". See also: AWS API Documentation **Request Syntax** response = client.describe_phone_number( PhoneNumberId='string' ) Parameters: **PhoneNumberId** (*string*) -- **[REQUIRED]** A unique identifier for the phone number. Return type: dict Returns: **Response Syntax** { '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'|'UIFN'|'SHARED'|'THIRD_PARTY_TF'|'THIRD_PARTY_DID'|'SHORT_CODE', 'PhoneNumberDescription': 'string', 'TargetArn': 'string', 'InstanceId': 'string', 'Tags': { 'string': 'string' }, 'PhoneNumberStatus': { 'Status': 'CLAIMED'|'IN_PROGRESS'|'FAILED', 'Message': 'string' }, 'SourcePhoneNumberArn': 'string' } } **Response Structure** * *(dict) --* * **ClaimedPhoneNumberSummary** *(dict) --* Information about a phone number that's 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. * **PhoneNumberDescription** *(string) --* The description of the phone number. * **TargetArn** *(string) --* The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. * **InstanceId** *(string) --* The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **PhoneNumberStatus** *(dict) --* The status of the phone number. * "CLAIMED" means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded. * "IN_PROGRESS" means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata 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 ClaimPhoneNumber 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. * **Status** *(string) --* The status. * **Message** *(string) --* The status message. * **SourcePhoneNumberArn** *(string) --* The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / list_lex_bots list_lex_bots ************* Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. If no value is specified, the default is 10. Return type: dict Returns: **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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / delete_user_hierarchy_group delete_user_hierarchy_group *************************** Connect.Client.delete_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' ) Parameters: * **HierarchyGroupId** (*string*) -- **[REQUIRED]** The identifier of the hierarchy group. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceInUseException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / batch_disassociate_analytics_data_set batch_disassociate_analytics_data_set ************************************* Connect.Client.batch_disassociate_analytics_data_set(**kwargs) Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call. See also: AWS API Documentation **Request Syntax** response = client.batch_disassociate_analytics_data_set( InstanceId='string', DataSetIds=[ 'string', ], TargetAccountId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **DataSetIds** (*list*) -- **[REQUIRED]** An array of associated dataset identifiers to remove. * *(string) --* * **TargetAccountId** (*string*) -- The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance. Return type: dict Returns: **Response Syntax** { 'Deleted': [ 'string', ], 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **Deleted** *(list) --* An array of successfully disassociated dataset identifiers. * *(string) --* * **Errors** *(list) --* A list of errors for any datasets not successfully removed. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. List of errors for dataset association failures. * **ErrorCode** *(string) --* The error code. * **ErrorMessage** *(string) --* The corresponding error message for the error code. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_web_rtc_contact start_web_rtc_contact ********************* Connect.Client.start_web_rtc_contact(**kwargs) Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId). See also: AWS API Documentation **Request Syntax** response = client.start_web_rtc_contact( Attributes={ 'string': 'string' }, ClientToken='string', ContactFlowId='string', InstanceId='string', AllowedCapabilities={ 'Customer': { 'Video': 'SEND', 'ScreenShare': 'SEND' }, 'Agent': { 'Video': 'SEND', 'ScreenShare': 'SEND' } }, ParticipantDetails={ 'DisplayName': 'string' }, RelatedContactId='string', References={ 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } }, Description='string' ) Parameters: * **Attributes** (*dict*) -- 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, -, and _ characters. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. 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. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **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** * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AllowedCapabilities** (*dict*) -- Information about the video sharing capabilities of the participants (customer, agent). * **Customer** *(dict) --* Information about the customer's video sharing capabilities. * **Video** *(string) --* The configuration having the video and screen sharing capabilities for participants over the call. * **ScreenShare** *(string) --* The screen sharing capability that is enabled for the participant. "SEND" indicates the participant can share their screen. * **Agent** *(dict) --* Information about the agent's video sharing capabilities. * **Video** *(string) --* The configuration having the video and screen sharing capabilities for participants over the call. * **ScreenShare** *(string) --* The screen sharing capability that is enabled for the participant. "SEND" indicates the participant can share their screen. * **ParticipantDetails** (*dict*) -- **[REQUIRED]** The customer's details. * **DisplayName** *(string) --* **[REQUIRED]** Display name of the participant. * **RelatedContactId** (*string*) -- The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting. * **References** (*dict*) -- A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: "URL" | "NUMBER" | "STRING" | "DATE" | "EMAIL". "ATTACHMENT" is not a supported reference type during task creation. * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* **[REQUIRED]** The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **Description** (*string*) -- A description of the task that is shown to an agent in the Contact Control Panel (CCP). Return type: dict Returns: **Response Syntax** { 'ConnectionData': { 'Attendee': { 'AttendeeId': 'string', 'JoinToken': 'string' }, 'Meeting': { 'MediaRegion': 'string', 'MediaPlacement': { 'AudioHostUrl': 'string', 'AudioFallbackUrl': 'string', 'SignalingUrl': 'string', 'TurnControlUrl': 'string', 'EventIngestionUrl': 'string' }, 'MeetingFeatures': { 'Audio': { 'EchoReduction': 'AVAILABLE'|'UNAVAILABLE' } }, 'MeetingId': 'string' } }, 'ContactId': 'string', 'ParticipantId': 'string', 'ParticipantToken': 'string' } **Response Structure** * *(dict) --* * **ConnectionData** *(dict) --* Information required for the client application (mobile application or website) to connect to the call. * **Attendee** *(dict) --* The attendee information, including attendee ID and join token. * **AttendeeId** *(string) --* The Amazon Chime SDK attendee ID. * **JoinToken** *(string) --* The join token used by the Amazon Chime SDK attendee. * **Meeting** *(dict) --* A meeting created using the Amazon Chime SDK. * **MediaRegion** *(string) --* The Amazon Web Services Region in which you create the meeting. * **MediaPlacement** *(dict) --* The media placement for the meeting. * **AudioHostUrl** *(string) --* The audio host URL. * **AudioFallbackUrl** *(string) --* The audio fallback URL. * **SignalingUrl** *(string) --* The signaling URL. * **TurnControlUrl** *(string) --* The turn control URL. * **EventIngestionUrl** *(string) --* The event ingestion URL to which you send client meeting events. * **MeetingFeatures** *(dict) --* The configuration settings of the features available to a meeting. * **Audio** *(dict) --* The configuration settings for the audio features available to a meeting. * **EchoReduction** *(string) --* Makes echo reduction available to clients who connect to the meeting. * **MeetingId** *(string) --* The Amazon Chime SDK meeting ID. * **ContactId** *(string) --* The identifier of the contact in this instance of Amazon Connect. * **ParticipantId** *(string) --* The identifier for a contact participant. The "ParticipantId" for a contact participant is the same throughout the contact lifecycle. * **ParticipantToken** *(string) --* The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant. **Exceptions** * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / describe_hours_of_operation describe_hours_of_operation *************************** Connect.Client.describe_hours_of_operation(**kwargs) Describes the hours of operation. See also: AWS API Documentation **Request Syntax** response = client.describe_hours_of_operation( InstanceId='string', HoursOfOperationId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. Return type: dict Returns: **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' }, 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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"} }. * *(string) --* * *(string) --* * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_push_notification_registration create_push_notification_registration ************************************* Connect.Client.create_push_notification_registration(**kwargs) Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_push_notification_registration( InstanceId='string', ClientToken='string', PinpointAppArn='string', DeviceToken='string', DeviceType='GCM'|'APNS'|'APNS_SANDBOX', ContactConfiguration={ 'ContactId': 'string', 'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR', 'IncludeRawMessage': True|False } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **PinpointAppArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Pinpoint application. * **DeviceToken** (*string*) -- **[REQUIRED]** The push notification token issued by the Apple or Google gateways. * **DeviceType** (*string*) -- **[REQUIRED]** The device type to use when sending the message. * **ContactConfiguration** (*dict*) -- **[REQUIRED]** The contact configuration for push notification registration. * **ContactId** *(string) --* **[REQUIRED]** The identifier of the contact within the Amazon Connect instance. * **ParticipantRole** *(string) --* The role of the participant in the chat conversation. Note: Only "CUSTOMER" is currently supported. Any other values other than "CUSTOMER" will result in an exception (4xx error). * **IncludeRawMessage** *(boolean) --* Whether to include raw connect message in the push notification payload. Default is "False". Return type: dict Returns: **Response Syntax** { 'RegistrationId': 'string' } **Response Structure** * *(dict) --* * **RegistrationId** *(string) --* The identifier for the registration. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ServiceQuotaExceededException" Connect / Client / describe_rule describe_rule ************* Connect.Client.describe_rule(**kwargs) Describes a rule for the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.describe_rule( InstanceId='string', RuleId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RuleId** (*string*) -- **[REQUIRED]** A unique identifier for the rule. Return type: dict Returns: **Response Syntax** { 'Rule': { 'Name': 'string', 'RuleId': 'string', 'RuleArn': 'string', 'TriggerEventSource': { 'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach', 'IntegrationAssociationId': 'string' }, 'Function': 'string', 'Actions': [ { 'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION', 'TaskAction': { 'Name': 'string', 'Description': 'string', 'ContactFlowId': 'string', 'References': { 'string': { 'Value': 'string', 'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE', 'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'Arn': 'string', 'StatusReason': 'string' } } }, 'EventBridgeAction': { 'Name': 'string' }, 'AssignContactCategoryAction': {}, 'SendNotificationAction': { 'DeliveryMethod': 'EMAIL', 'Subject': 'string', 'Content': 'string', 'ContentType': 'PLAIN_TEXT', 'Recipient': { 'UserTags': { 'string': 'string' }, 'UserIds': [ 'string', ] } }, 'CreateCaseAction': { 'Fields': [ { 'Id': 'string', 'Value': { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {}, 'StringValue': 'string' } }, ], 'TemplateId': 'string' }, 'UpdateCaseAction': { 'Fields': [ { 'Id': 'string', 'Value': { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {}, 'StringValue': 'string' } }, ] }, 'AssignSlaAction': { 'SlaAssignmentType': 'CASES', 'CaseSlaConfiguration': { 'Name': 'string', 'Type': 'CaseField', 'FieldId': 'string', 'TargetFieldValues': [ { 'BooleanValue': True|False, 'DoubleValue': 123.0, 'EmptyValue': {}, 'StringValue': 'string' }, ], 'TargetSlaMinutes': 123 } }, 'EndAssociatedTasksAction': {}, 'SubmitAutoEvaluationAction': { 'EvaluationFormId': 'string' } }, ], 'PublishStatus': 'DRAFT'|'PUBLISHED', 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1), 'LastUpdatedBy': 'string', 'Tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **Rule** *(dict) --* Information about the rule. * **Name** *(string) --* The name of the rule. * **RuleId** *(string) --* A unique identifier for the rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **TriggerEventSource** *(dict) --* The event source to trigger the rule. * **EventSourceName** *(string) --* The name of the event source. * **IntegrationAssociationId** *(string) --* The identifier for the integration association. * **Function** *(string) --* The conditions of the rule. * **Actions** *(list) --* A list of actions to be run when the rule is triggered. * *(dict) --* Information about the action to be performed when a rule is triggered. * **ActionType** *(string) --* The type of action that creates a rule. * **TaskAction** *(dict) --* Information about the task action. This field is required if "TriggerEventSource" is one of the following values: "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **Name** *(string) --* The name. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **Description** *(string) --* The description. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **ContactFlowId** *(string) --* The identifier of the flow. * **References** *(dict) --* Information about the reference when the "referenceType" is "URL". Otherwise, null. (Supports variable injection in the "Value" field.) * *(string) --* * *(dict) --* 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. * **Value** *(string) --* 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). * **Type** *(string) --* The type of the reference. "DATE" must be of type Epoch timestamp. * **Status** *(string) --* Status of the attachment reference type. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the reference * **StatusReason** *(string) --* Relevant details why the reference was not successfully created. * **EventBridgeAction** *(dict) --* Information about the EventBridge action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnContactEvaluationSubmit" | "OnMetricDataUpdate" * **Name** *(string) --* The name. * **AssignContactCategoryAction** *(dict) --* Information about the contact category action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnZendeskTicketCreate" | "OnZendeskTicketStatusUpdate" | "OnSalesforceCaseCreate" * **SendNotificationAction** *(dict) --* Information about the send notification action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnRealTimeCallAnalysisAvailable" | "OnRealTimeChatAnalysisAvailable" | "OnPostChatAnalysisAvailable" | "OnContactEvaluationSubmit" | "OnMetricDataUpdate" * **DeliveryMethod** *(string) --* Notification delivery method. * **Subject** *(string) --* The subject of the email if the delivery method is "EMAIL". Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **Content** *(string) --* Notification content. Supports variable injection. For more information, see JSONPath reference in the *Amazon Connect Administrators Guide*. * **ContentType** *(string) --* Content type format. * **Recipient** *(dict) --* Notification recipient. * **UserTags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified. * *(string) --* * *(string) --* * **UserIds** *(list) --* A list of user IDs. Supports variable injection of "$.ContactLens.ContactEvaluation.Agent.AgentId" for "OnContactEvaluationSubmit" event source. * *(string) --* * **CreateCaseAction** *(dict) --* Information about the create case action. Supported only for "TriggerEventSource" values: "OnPostCallAnalysisAvailable" | "OnPostChatAnalysisAvailable". * **Fields** *(list) --* An array of objects with "Field ID" and "Value" data. * *(dict) --* Object for case field values. * **Id** *(string) --* Unique identifier of a field. * **Value** *(dict) --* Union of potential field value types. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **TemplateId** *(string) --* A unique identifier of a template. * **UpdateCaseAction** *(dict) --* Information about the update case action. Supported only for "TriggerEventSource" values: "OnCaseCreate" | "OnCaseUpdate". * **Fields** *(list) --* An array of objects with "Field ID" and Value data. * *(dict) --* Object for case field values. * **Id** *(string) --* Unique identifier of a field. * **Value** *(dict) --* Union of potential field value types. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **AssignSlaAction** *(dict) --* Information about the assign SLA action. * **SlaAssignmentType** *(string) --* Type of SLA assignment. * **CaseSlaConfiguration** *(dict) --* The SLA configuration for Case SLA Assignment. * **Name** *(string) --* Name of an SLA. * **Type** *(string) --* Type of SLA for Case SlaAssignmentType. * **FieldId** *(string) --* Unique identifier of a Case field. * **TargetFieldValues** *(list) --* Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value. * *(dict) --* Object to store union of Field values. * **BooleanValue** *(boolean) --* A Boolean number value type. * **DoubleValue** *(float) --* A Double number value type. * **EmptyValue** *(dict) --* An empty value. * **StringValue** *(string) --* String value type. * **TargetSlaMinutes** *(integer) --* Target duration in minutes within which an SLA should be completed. * **EndAssociatedTasksAction** *(dict) --* Information about the end associated tasks action. Supported only for "TriggerEventSource" values: "OnCaseUpdate". * **SubmitAutoEvaluationAction** *(dict) --* Information about the submit automated evaluation action. * **EvaluationFormId** *(string) --* The identifier of the auto-evaluation enabled form. * **PublishStatus** *(string) --* The publish status of the rule. * **CreatedTime** *(datetime) --* The timestamp for when the rule was created. * **LastUpdatedTime** *(datetime) --* The timestamp for the when the rule was last updated. * **LastUpdatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the rule. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / search_resource_tags search_resource_tags ******************** Connect.Client.search_resource_tags(**kwargs) Searches tags used in an Amazon Connect instance using optional search criteria. See also: AWS API Documentation **Request Syntax** response = client.search_resource_tags( InstanceId='string', ResourceTypes=[ 'string', ], NextToken='string', MaxResults=123, SearchCriteria={ 'TagSearchCondition': { 'tagKey': 'string', 'tagValue': 'string', 'tagKeyComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT', 'tagValueComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance. * **ResourceTypes** (*list*) -- The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required. **Supported resource types** * agent * agent-state * routing-profile * standard-queue * security-profile * operating-hours * prompt * contact-flow * flow- module * transfer-destination (also known as quick connect) * *(string) --* * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchCriteria** (*dict*) -- The search criteria to be used to return tags. * **TagSearchCondition** *(dict) --* The search criteria to be used to return tags. * **tagKey** *(string) --* The tag key used in the tag search condition. * **tagValue** *(string) --* The tag value used in the tag search condition. * **tagKeyComparisonType** *(string) --* The type of comparison to be made when evaluating the tag key in tag search condition. * **tagValueComparisonType** *(string) --* The type of comparison to be made when evaluating the tag value in tag search condition. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'key': 'string', 'value': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Tags** *(list) --* A list of tags used in the Amazon Connect instance. * *(dict) --* A tag set contains tag key and tag value. * **key** *(string) --* The tag key in the TagSet. * **value** *(string) --* The tag value in the tagSet. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.MaximumResultReturnedException" Connect / Client / associate_analytics_data_set associate_analytics_data_set **************************** Connect.Client.associate_analytics_data_set(**kwargs) Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call. See also: AWS API Documentation **Request Syntax** response = client.associate_analytics_data_set( InstanceId='string', DataSetId='string', TargetAccountId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **DataSetId** (*string*) -- **[REQUIRED]** The identifier of the dataset to associate with the target account. * **TargetAccountId** (*string*) -- The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance. Return type: dict Returns: **Response Syntax** { 'DataSetId': 'string', 'TargetAccountId': 'string', 'ResourceShareId': 'string', 'ResourceShareArn': 'string' } **Response Structure** * *(dict) --* * **DataSetId** *(string) --* The identifier of the dataset that was associated. * **TargetAccountId** *(string) --* The identifier of the target account. * **ResourceShareId** *(string) --* The Resource Access Manager share ID that is generated. * **ResourceShareArn** *(string) --* The Amazon Resource Name (ARN) of the Resource Access Manager share. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_flow associate_flow ************** Connect.Client.associate_flow(**kwargs) Associates a connect resource to a flow. See also: AWS API Documentation **Request Syntax** response = client.associate_flow( InstanceId='string', ResourceId='string', FlowId='string', ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ResourceId** (*string*) -- **[REQUIRED]** The identifier of the resource. * Amazon Web Services End User Messaging SMS phone number ARN when using "SMS_PHONE_NUMBER" * Amazon Web Services End User Messaging Social phone number ARN when using "WHATSAPP_MESSAGING_PHONE_NUMBER" * **FlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_participant_authentication update_participant_authentication ********************************* Connect.Client.update_participant_authentication(**kwargs) Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents: * **If a code is provided**: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles. * **If an error is provided**: The error branch of the Authenticate Customer block is executed. Note: The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned. See also: AWS API Documentation **Request Syntax** response = client.update_participant_authentication( State='string', InstanceId='string', Code='string', Error='string', ErrorDescription='string' ) Parameters: * **State** (*string*) -- **[REQUIRED]** The "state" query parameter that was provided by Cognito in the "redirectUri". This will also match the "state" parameter provided in the "AuthenticationUrl" from the GetAuthenticationUrl response. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Code** (*string*) -- The "code" query parameter provided by Cognito in the "redirectUri". * **Error** (*string*) -- The "error" query parameter provided by Cognito in the "redirectUri". * **ErrorDescription** (*string*) -- The "error_description" parameter provided by Cognito in the "redirectUri". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / update_view_content update_view_content ******************* Connect.Client.update_view_content(**kwargs) Updates the view content of the given view identifier in the specified Amazon Connect instance. It performs content validation if "Status" is set to "SAVED" and performs full content validation if "Status" is "PUBLISHED". Note that the "$SAVED" alias' content will always be updated, but the "$LATEST" alias' content will only be updated if "Status" is "PUBLISHED". See also: AWS API Documentation **Request Syntax** response = client.update_view_content( InstanceId='string', ViewId='string', Status='PUBLISHED'|'SAVED', Content={ 'Template': 'string', 'Actions': [ 'string', ] } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. * **Status** (*string*) -- **[REQUIRED]** Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Content** (*dict*) -- **[REQUIRED]** View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation. The total uncompressed content has a maximum file size of 400kB. * **Template** *(string) --* The view template representing the structure of the view. * **Actions** *(list) --* A list of possible actions from the view. * *(string) --* Return type: dict Returns: **Response Syntax** { 'View': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Status': 'PUBLISHED'|'SAVED', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Description': 'string', 'Version': 123, 'VersionDescription': 'string', 'Content': { 'InputSchema': 'string', 'Template': 'string', 'Actions': [ 'string', ] }, 'Tags': { 'string': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ViewContentSha256': 'string' } } **Response Structure** * *(dict) --* * **View** *(dict) --* A view resource object. Contains metadata and content necessary to render the view. * **Id** *(string) --* The identifier of the view. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view. * **Name** *(string) --* The name of the view. * **Status** *(string) --* Indicates the view status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. * **Type** *(string) --* The type of the view - "CUSTOMER_MANAGED". * **Description** *(string) --* The description of the view. * **Version** *(integer) --* Current version of the view. * **VersionDescription** *(string) --* The description of the version. * **Content** *(dict) --* View content containing all content necessary to render a view except for runtime input data. * **InputSchema** *(string) --* The data schema matching data that the view template must be provided to render. * **Template** *(string) --* The view template representing the structure of the view. * **Actions** *(list) --* A list of possible actions from the view. * *(string) --* * **Tags** *(dict) --* The tags associated with the view resource (not specific to view version). * *(string) --* * *(string) --* * **CreatedTime** *(datetime) --* The timestamp of when the view was created. * **LastModifiedTime** *(datetime) --* Latest timestamp of the "UpdateViewContent" or "CreateViewVersion" operations. * **ViewContentSha256** *(string) --* Indicates the checksum value of the latest published view content. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / delete_instance delete_instance *************** Connect.Client.delete_instance(**kwargs) This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the *Amazon Connect Administrator Guide*. 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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" Connect / Client / start_contact_evaluation start_contact_evaluation ************************ Connect.Client.start_contact_evaluation(**kwargs) Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. Note: Evaluations created through the public API do not contain answer values suggested from automation. See also: AWS API Documentation **Request Syntax** response = client.start_contact_evaluation( InstanceId='string', ContactId='string', EvaluationFormId='string', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **EvaluationFormId** (*string*) -- **[REQUIRED]** The unique identifier for the evaluation form. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'EvaluationId': 'string', 'EvaluationArn': 'string' } **Response Structure** * *(dict) --* * **EvaluationId** *(string) --* A unique identifier for the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. **Exceptions** * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / describe_hours_of_operation_override describe_hours_of_operation_override ************************************ Connect.Client.describe_hours_of_operation_override(**kwargs) Describes the hours of operation override. See also: AWS API Documentation **Request Syntax** response = client.describe_hours_of_operation_override( InstanceId='string', HoursOfOperationId='string', HoursOfOperationOverrideId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. * **HoursOfOperationOverrideId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation override. Return type: dict Returns: **Response Syntax** { 'HoursOfOperationOverride': { 'HoursOfOperationOverrideId': 'string', 'HoursOfOperationId': 'string', 'HoursOfOperationArn': 'string', 'Name': 'string', 'Description': 'string', 'Config': [ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], 'EffectiveFrom': 'string', 'EffectiveTill': 'string' } } **Response Structure** * *(dict) --* * **HoursOfOperationOverride** *(dict) --* Information about the hours of operations override. * **HoursOfOperationOverrideId** *(string) --* The identifier for the hours of operation override. * **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 of the hours of operation override. * **Description** *(string) --* The description of the hours of operation override. * **Config** *(list) --* Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EffectiveFrom** *(string) --* The date from which the hours of operation override would be effective. * **EffectiveTill** *(string) --* The date till which the hours of operation override would be effective. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_participant_role_config update_participant_role_config ****************************** Connect.Client.update_participant_role_config(**kwargs) Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers: * Customer idle timeout * Customer auto-disconnect timeout * Agent idle timeout * Agent auto-disconnect timeout For more information about how chat timeouts work, see Set up chat timeouts for human participants. See also: AWS API Documentation **Request Syntax** response = client.update_participant_role_config( InstanceId='string', ContactId='string', ChannelConfiguration={ 'Chat': { 'ParticipantTimerConfigList': [ { 'ParticipantRole': 'CUSTOMER'|'AGENT', 'TimerType': 'IDLE'|'DISCONNECT_NONCUSTOMER', 'TimerValue': { 'ParticipantTimerAction': 'Unset', 'ParticipantTimerDurationInMinutes': 123 } }, ] } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **ChannelConfiguration** (*dict*) -- **[REQUIRED]** The Amazon Connect channel you want to configure. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "Chat". * **Chat** *(dict) --* Configuration information for the chat participant role. * **ParticipantTimerConfigList** *(list) --* **[REQUIRED]** A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400. * *(dict) --* Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts. For more information about how chat timeouts work, see Set up chat timeouts for human participants. * **ParticipantRole** *(string) --* **[REQUIRED]** The role of the participant in the chat conversation. * **TimerType** *(string) --* **[REQUIRED]** The type of timer. "IDLE" indicates the timer applies for considering a human chat participant as idle. "DISCONNECT_NONCUSTOMER" indicates the timer applies to automatically disconnecting a chat participant due to idleness. * **TimerValue** *(dict) --* **[REQUIRED]** The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ParticipantTimerAction", "ParticipantTimerDurationInMinutes". * **ParticipantTimerAction** *(string) --* The timer action. Currently only one value is allowed: "Unset". It deletes a timer. * **ParticipantTimerDurationInMinutes** *(integer) --* The duration of a timer, in minutes. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_traffic_distribution_group create_traffic_distribution_group ********************************* Connect.Client.create_traffic_distribution_group(**kwargs) Creates a traffic distribution group given an Amazon Connect instance that has been replicated. Note: The "SignInConfig" distribution is available only on a default "TrafficDistributionGroup" (see the "IsDefault" parameter in the TrafficDistributionGroup data type). If you call "UpdateTrafficDistribution" with a modified "SignInConfig" and a non-default "TrafficDistributionGroup", an "InvalidRequestException" is returned. 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' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name for the traffic distribution group. * **Description** (*string*) -- A description for the traffic distribution group. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance that has been replicated. You can find the "instanceId" in the ARN of the instance. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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 of the traffic distribution group. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the traffic distribution group. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.ResourceNotReadyException" Connect / Client / update_contact_routing_data update_contact_routing_data *************************** Connect.Client.update_contact_routing_data(**kwargs) Updates routing priority and age on the contact (**QueuePriority** and **QueueTimeAdjustmentInSeconds**). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block. Note: Either **QueuePriority** or **QueueTimeAdjustmentInSeconds** should be provided within the request body, but not both. See also: AWS API Documentation **Request Syntax** response = client.update_contact_routing_data( InstanceId='string', ContactId='string', QueueTimeAdjustmentSeconds=123, QueuePriority=123, RoutingCriteria={ 'Steps': [ { 'Expiry': { 'DurationInSeconds': 123 }, 'Expression': { 'AttributeCondition': { 'Name': 'string', 'Value': 'string', 'ProficiencyLevel': ..., 'Range': { 'MinProficiencyLevel': ..., 'MaxProficiencyLevel': ... }, 'MatchCriteria': { 'AgentsCriteria': { 'AgentIds': [ 'string', ] } }, 'ComparisonOperator': 'string' }, 'AndExpression': [ {'... recursive ...'}, ], 'OrExpression': [ {'... recursive ...'}, ], 'NotAttributeCondition': { 'Name': 'string', 'Value': 'string', 'ProficiencyLevel': ..., 'Range': { 'MinProficiencyLevel': ..., 'MaxProficiencyLevel': ... }, 'MatchCriteria': { 'AgentsCriteria': { 'AgentIds': [ 'string', ] } }, 'ComparisonOperator': 'string' } } }, ] } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **QueueTimeAdjustmentSeconds** (*integer*) -- The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue. * **QueuePriority** (*integer*) -- Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2. * **RoutingCriteria** (*dict*) -- Updates the routing criteria on the contact. These properties can be used to change how a contact is routed within the queue. * **Steps** *(list) --* When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue. * *(dict) --* Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value. * **Expiry** *(dict) --* An object to specify the expiration of a routing step. * **DurationInSeconds** *(integer) --* The number of seconds that the contact will be routed only to agents matching this routing step, if expiry was configured for this routing step. * **Expression** *(dict) --* A tagged union to specify expression for a routing step. * **AttributeCondition** *(dict) --* An object to specify the predefined attribute condition. * **Name** *(string) --* The name of predefined attribute. * **Value** *(string) --* The value of predefined attribute. * **ProficiencyLevel** *(float) --* The proficiency level of the condition. * **Range** *(dict) --* An Object to define the minimum and maximum proficiency levels. * **MinProficiencyLevel** *(float) --* The minimum proficiency level of the range. * **MaxProficiencyLevel** *(float) --* The maximum proficiency level of the range. * **MatchCriteria** *(dict) --* An object to define "AgentsCriteria". * **AgentsCriteria** *(dict) --* An object to define agentIds. * **AgentIds** *(list) --* An object to specify a list of agents, by user ID. * *(string) --* * **ComparisonOperator** *(string) --* The operator of the condition. * **AndExpression** *(list) --* List of routing expressions which will be AND-ed together. * *(dict) --* A tagged union to specify expression for a routing step. * **OrExpression** *(list) --* List of routing expressions which will be OR-ed together. * *(dict) --* A tagged union to specify expression for a routing step. * **NotAttributeCondition** *(dict) --* An object to specify the predefined attribute condition. * **Name** *(string) --* The name of predefined attribute. * **Value** *(string) --* The value of predefined attribute. * **ProficiencyLevel** *(float) --* The proficiency level of the condition. * **Range** *(dict) --* An Object to define the minimum and maximum proficiency levels. * **MinProficiencyLevel** *(float) --* The minimum proficiency level of the range. * **MaxProficiencyLevel** *(float) --* The maximum proficiency level of the range. * **MatchCriteria** *(dict) --* An object to define "AgentsCriteria". * **AgentsCriteria** *(dict) --* An object to define agentIds. * **AgentIds** *(list) --* An object to specify a list of agents, by user ID. * *(string) --* * **ComparisonOperator** *(string) --* The operator of the condition. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / list_associated_contacts list_associated_contacts ************************ Connect.Client.list_associated_contacts(**kwargs) Provides information about contact tree, a list of associated contacts with a unique identifier. See also: AWS API Documentation **Request Syntax** response = client.list_associated_contacts( InstanceId='string', ContactId='string', MaxResults=123, NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'ContactSummaryList': [ { 'ContactId': 'string', 'ContactArn': 'string', 'InitiationTimestamp': datetime(2015, 1, 1), 'DisconnectTimestamp': datetime(2015, 1, 1), 'InitialContactId': 'string', 'PreviousContactId': 'string', 'RelatedContactId': 'string', 'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW', 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ContactSummaryList** *(list) --* List of the contact summary for all the contacts in contact tree associated with unique identifier. * *(dict) --* Contact summary of a contact in contact tree associated with unique identifier. * **ContactId** *(string) --* The identifier of the contact in this instance of Amazon Connect. * **ContactArn** *(string) --* The Amazon Resource Name (ARN) of the contact * **InitiationTimestamp** *(datetime) --* The date and time this contact was initiated, in UTC time. * **DisconnectTimestamp** *(datetime) --* The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended. * **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. * **RelatedContactId** *(string) --* The contactId that is related to this contact. * **InitiationMethod** *(string) --* Indicates how the contact was initiated. * **Channel** *(string) --* How the contact reached your contact center. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_instance_attributes list_instance_attributes ************************ Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **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'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE', '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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_user_proficiencies update_user_proficiencies ************************* Connect.Client.update_user_proficiencies(**kwargs) Updates the properties associated with the proficiencies of a user. See also: AWS API Documentation **Request Syntax** response = client.update_user_proficiencies( InstanceId='string', UserId='string', UserProficiencies=[ { 'AttributeName': 'string', 'AttributeValue': 'string', 'Level': ... }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **UserProficiencies** (*list*) -- **[REQUIRED]** The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API. * *(dict) --* Information about proficiency of a user. * **AttributeName** *(string) --* **[REQUIRED]** The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance. * **AttributeValue** *(string) --* **[REQUIRED]** The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance. * **Level** *(float) --* **[REQUIRED]** The level of the proficiency. The valid values are 1, 2, 3, 4 and 5. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_use_cases list_use_cases ************** Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationAssociationId** (*string*) -- **[REQUIRED]** The identifier for the integration association. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / create_integration_association create_integration_association ****************************** Connect.Client.create_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'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL', IntegrationArn='string', SourceApplicationUrl='string', SourceApplicationName='string', SourceType='SALESFORCE'|'ZENDESK'|'CASES', Tags={ 'string': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationType** (*string*) -- **[REQUIRED]** The type of information to be ingested. * **IntegrationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the integration. Note: When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging instances must be in the same account. * **SourceApplicationUrl** (*string*) -- The URL for the external application. This field is only required for the EVENT integration type. * **SourceApplicationName** (*string*) -- The name of the external application. This field is only required for the EVENT integration type. * **SourceType** (*string*) -- The type of the data source. This field is only required for the EVENT integration type. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / create_use_case create_use_case *************** Connect.Client.create_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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationAssociationId** (*string*) -- **[REQUIRED]** The identifier for the integration association. * **UseCaseType** (*string*) -- **[REQUIRED]** The type of use case to associate to the integration association. Each integration association can have only one of each use case type. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_contact_evaluation update_contact_evaluation ************************* Connect.Client.update_contact_evaluation(**kwargs) Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ( "{}") to the question identifier. See also: AWS API Documentation **Request Syntax** response = client.update_contact_evaluation( InstanceId='string', EvaluationId='string', Answers={ 'string': { 'Value': { 'StringValue': 'string', 'NumericValue': 123.0, 'NotApplicable': True|False } } }, Notes={ 'string': { 'Value': 'string' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationId** (*string*) -- **[REQUIRED]** A unique identifier for the contact evaluation. * **Answers** (*dict*) -- A map of question identifiers to answer value. * *(string) --* * *(dict) --* Information about input answers for a contact evaluation. * **Value** *(dict) --* The value for an answer in a contact evaluation. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "StringValue", "NumericValue", "NotApplicable". * **StringValue** *(string) --* The string value for an answer in a contact evaluation. * **NumericValue** *(float) --* The numeric value for an answer in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the question as not applicable. * **Notes** (*dict*) -- A map of question identifiers to note value. * *(string) --* * *(dict) --* Information about notes for a contact evaluation. * **Value** *(string) --* The note for an item (section or question) in a contact evaluation. Note: Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024. Return type: dict Returns: **Response Syntax** { 'EvaluationId': 'string', 'EvaluationArn': 'string' } **Response Structure** * *(dict) --* * **EvaluationId** *(string) --* A unique identifier for the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / claim_phone_number claim_phone_number ****************** Connect.Client.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. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the *Amazon Connect Administrator Guide*. Warning: You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. See also: AWS API Documentation **Request Syntax** response = client.claim_phone_number( TargetArn='string', InstanceId='string', PhoneNumber='string', PhoneNumberDescription='string', Tags={ 'string': 'string' }, ClientToken='string' ) Parameters: * **TargetArn** (*string*) -- The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter "InstanceId" or "TargetArn". * **InstanceId** (*string*) -- The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter "InstanceId" or "TargetArn". * **PhoneNumber** (*string*) -- **[REQUIRED]** The phone number you want to claim. Phone numbers are formatted "[+] [country code] [subscriber number including area code]". * **PhoneNumberDescription** (*string*) -- The description of the phone number. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. Pattern: "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a -f0-9]{12}$" This field is autopopulated if not provided. Return type: dict Returns: **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.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / create_contact_flow create_contact_flow ******************* Connect.Client.create_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'|'CAMPAIGN', Description='string', Content='string', Status='PUBLISHED'|'SAVED', Tags={ 'string': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **Name** (*string*) -- **[REQUIRED]** The name of the flow. * **Type** (*string*) -- **[REQUIRED]** The type of the flow. For descriptions of the available types, see Choose a flow type in the *Amazon Connect Administrator Guide*. * **Description** (*string*) -- The description of the flow. * **Content** (*string*) -- **[REQUIRED]** The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000. * **Status** (*string*) -- Indicates the flow status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. the "SAVED" status does not initiate validation of the content. "SAVED" | "PUBLISHED". * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ContactFlowId': 'string', 'ContactFlowArn': 'string', 'FlowContentSha256': 'string' } **Response Structure** * *(dict) --* * **ContactFlowId** *(string) --* The identifier of the flow. * **ContactFlowArn** *(string) --* The Amazon Resource Name (ARN) of the flow. * **FlowContentSha256** *(string) --* Indicates the checksum value of the latest published flow content. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidContactFlowException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / delete_push_notification_registration delete_push_notification_registration ************************************* Connect.Client.delete_push_notification_registration(**kwargs) Deletes registration for a device token and a chat contact. See also: AWS API Documentation **Request Syntax** response = client.delete_push_notification_registration( InstanceId='string', RegistrationId='string', ContactId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RegistrationId** (*string*) -- **[REQUIRED]** The identifier for the registration. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact within the Amazon Connect instance. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / replicate_instance replicate_instance ****************** Connect.Client.replicate_instance(**kwargs) Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions. 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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the "InstanceId", or the entire ARN. * **ReplicaRegion** (*string*) -- **[REQUIRED]** The Amazon Web Services Region where to replicate the Amazon Connect instance. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **ReplicaAlias** (*string*) -- **[REQUIRED]** The alias for the replicated instance. The "ReplicaAlias" must be unique. Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotReadyException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / describe_user_hierarchy_structure describe_user_hierarchy_structure ********************************* Connect.Client.describe_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' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** { 'HierarchyStructure': { 'LevelOne': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelTwo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelThree': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFour': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, 'LevelFive': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } } } **Response Structure** * *(dict) --* * **HierarchyStructure** *(dict) --* Information about the hierarchy structure. * **LevelOne** *(dict) --* Information about level one. * **Id** *(string) --* The identifier of the hierarchy level. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the hierarchy level. * **Name** *(string) --* The name of the hierarchy level. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LevelTwo** *(dict) --* Information about level two. * **Id** *(string) --* The identifier of the hierarchy level. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the hierarchy level. * **Name** *(string) --* The name of the hierarchy level. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LevelThree** *(dict) --* Information about level three. * **Id** *(string) --* The identifier of the hierarchy level. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the hierarchy level. * **Name** *(string) --* The name of the hierarchy level. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LevelFour** *(dict) --* Information about level four. * **Id** *(string) --* The identifier of the hierarchy level. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the hierarchy level. * **Name** *(string) --* The name of the hierarchy level. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LevelFive** *(dict) --* Information about level five. * **Id** *(string) --* The identifier of the hierarchy level. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the hierarchy level. * **Name** *(string) --* The name of the hierarchy level. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_contact_attributes update_contact_attributes ************************* Connect.Client.update_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' } ) Parameters: * **InitialContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Attributes** (*dict*) -- **[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. In the Set contact attributes block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options: * Remove unnecessary attributes by setting their values to empty. * If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the *Amazon Connect Administrator Guide*. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / update_contact_flow_content update_contact_flow_content *************************** Connect.Client.update_contact_flow_content(**kwargs) Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the "$SAVED" alias in the request to describe the "SAVED" content of a Flow. For example, "arn:aws:.../contact- flow/{id}:$SAVED". After a flow is published, "$SAVED" needs to be supplied to view saved content that has not been published. See also: AWS API Documentation **Request Syntax** response = client.update_contact_flow_content( InstanceId='string', ContactFlowId='string', Content='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. * **Content** (*string*) -- **[REQUIRED]** The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidContactFlowException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_default_vocabularies list_default_vocabularies ************************* Connect.Client.list_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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', MaxResults=123, NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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? * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **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'|'en-NZ'|'en-ZA'|'ca-ES'|'da-DK'|'fi-FI'|'id-ID'|'ms-MY'|'nl-NL'|'no-NO'|'pl-PL'|'sv-SE'|'tl-PH', '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 instance ID in the Amazon Resource Name (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.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / list_rules list_rules ********** Connect.Client.list_rules(**kwargs) List all rules for the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_rules( InstanceId='string', PublishStatus='DRAFT'|'PUBLISHED', EventSourceName='OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach', MaxResults=123, NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **PublishStatus** (*string*) -- The publish status of the rule. * **EventSourceName** (*string*) -- The name of the event source. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'RuleSummaryList': [ { 'Name': 'string', 'RuleId': 'string', 'RuleArn': 'string', 'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach', 'PublishStatus': 'DRAFT'|'PUBLISHED', 'ActionSummaries': [ { 'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION' }, ], 'CreatedTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RuleSummaryList** *(list) --* Summary information about a rule. * *(dict) --* A list of "ActionTypes" associated with a rule. * **Name** *(string) --* The name of the rule. * **RuleId** *(string) --* A unique identifier for the rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the rule. * **EventSourceName** *(string) --* The name of the event source. * **PublishStatus** *(string) --* The publish status of the rule. * **ActionSummaries** *(list) --* A list of ActionTypes associated with a rule. * *(dict) --* Information about an action. * **ActionType** *(string) --* The action type. * **CreatedTime** *(datetime) --* The timestamp for when the rule was created. * **LastUpdatedTime** *(datetime) --* The timestamp for when the rule was last updated. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" Connect / Client / complete_attached_file_upload complete_attached_file_upload ***************************** Connect.Client.complete_attached_file_upload(**kwargs) Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API. See also: AWS API Documentation **Request Syntax** response = client.complete_attached_file_upload( InstanceId='string', FileId='string', AssociatedResourceArn='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Connect instance. * **FileId** (*string*) -- **[REQUIRED]** The unique identifier of the attached file resource. * **AssociatedResourceArn** (*string*) -- **[REQUIRED]** The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. Note: This value must be a valid ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Response from CompleteAttachedFileUpload API **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_integration_associations list_integration_associations ***************************** Connect.Client.list_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'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL', NextToken='string', MaxResults=123, IntegrationArn='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **IntegrationType** (*string*) -- The integration type. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **IntegrationArn** (*string*) -- The Amazon Resource Name (ARN) of the integration. Return type: dict Returns: **Response Syntax** { 'IntegrationAssociationSummaryList': [ { 'IntegrationAssociationId': 'string', 'IntegrationAssociationArn': 'string', 'InstanceId': 'string', 'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL', 'IntegrationArn': 'string', 'SourceApplicationUrl': 'string', 'SourceApplicationName': 'string', 'SourceType': 'SALESFORCE'|'ZENDESK'|'CASES' }, ], '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 instance ID in the Amazon Resource Name (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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / stop_contact_streaming stop_contact_streaming ********************** Connect.Client.stop_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' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center. * **StreamingId** (*string*) -- **[REQUIRED]** The identifier of the streaming configuration enabled. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / tag_resource tag_resource ************ Connect.Client.tag_resource(**kwargs) Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, 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' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tags** (*dict*) -- **[REQUIRED]** The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_security_profiles list_security_profiles ********************** Connect.Client.list_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*. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions. See also: AWS API Documentation **Request Syntax** response = client.list_security_profiles( InstanceId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'SecurityProfileSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_lambda_function disassociate_lambda_function **************************** Connect.Client.disassociate_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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.. * **FunctionArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Lambda function being disassociated. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_view_metadata update_view_metadata ******************** Connect.Client.update_view_metadata(**kwargs) Updates the view metadata. Note that either "Name" or "Description" must be provided. See also: AWS API Documentation **Request Syntax** response = client.update_view_metadata( InstanceId='string', ViewId='string', Name='string', Description='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. * **Name** (*string*) -- The name of the view. * **Description** (*string*) -- The description of the view. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceInUseException" Connect / Client / list_hours_of_operation_overrides list_hours_of_operation_overrides ********************************* Connect.Client.list_hours_of_operation_overrides(**kwargs) List the hours of operation overrides. See also: AWS API Documentation **Request Syntax** response = client.list_hours_of_operation_overrides( InstanceId='string', HoursOfOperationId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'HoursOfOperationOverrideList': [ { 'HoursOfOperationOverrideId': 'string', 'HoursOfOperationId': 'string', 'HoursOfOperationArn': 'string', 'Name': 'string', 'Description': 'string', 'Config': [ { 'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY', 'StartTime': { 'Hours': 123, 'Minutes': 123 }, 'EndTime': { 'Hours': 123, 'Minutes': 123 } }, ], 'EffectiveFrom': 'string', 'EffectiveTill': 'string' }, ], 'LastModifiedRegion': 'string', 'LastModifiedTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **HoursOfOperationOverrideList** *(list) --* Information about the hours of operation override. * *(dict) --* Information about the hours of operations override. * **HoursOfOperationOverrideId** *(string) --* The identifier for the hours of operation override. * **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 of the hours of operation override. * **Description** *(string) --* The description of the hours of operation override. * **Config** *(list) --* Configuration information for the hours of operation override: day, start time, and end time. * *(dict) --* Information about the hours of operation override config: day, start time, and end time. * **Day** *(string) --* The day that the hours of operation override applies to. * **StartTime** *(dict) --* The start time when your contact center opens if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EndTime** *(dict) --* The end time that your contact center closes if overrides are applied. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **EffectiveFrom** *(string) --* The date from which the hours of operation override would be effective. * **EffectiveTill** *(string) --* The date till which the hours of operation override would be effective. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / batch_get_attached_file_metadata batch_get_attached_file_metadata ******************************** Connect.Client.batch_get_attached_file_metadata(**kwargs) Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn. See also: AWS API Documentation **Request Syntax** response = client.batch_get_attached_file_metadata( FileIds=[ 'string', ], InstanceId='string', AssociatedResourceArn='string' ) Parameters: * **FileIds** (*list*) -- **[REQUIRED]** The unique identifiers of the attached file resource. * *(string) --* * **InstanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Connect instance. * **AssociatedResourceArn** (*string*) -- **[REQUIRED]** The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. Note: This value must be a valid ARN. Return type: dict Returns: **Response Syntax** { 'Files': [ { 'CreationTime': 'string', 'FileArn': 'string', 'FileId': 'string', 'FileName': 'string', 'FileSizeInBytes': 123, 'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'CreatedBy': { 'ConnectUserArn': 'string', 'AWSIdentityArn': 'string' }, 'FileUseCaseType': 'EMAIL_MESSAGE'|'ATTACHMENT', 'AssociatedResourceArn': 'string', 'Tags': { 'string': 'string' } }, ], 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string', 'FileId': 'string' }, ] } **Response Structure** * *(dict) --* * **Files** *(list) --* List of attached files that were successfully retrieved. * *(dict) --* Information about the attached file. * **CreationTime** *(string) --* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: "yyyy-MM- ddThh:mm:ss.SSSZ". For example, "2024-05-03T02:41:28.172Z". * **FileArn** *(string) --* The unique identifier of the attached file resource (ARN). * **FileId** *(string) --* The unique identifier of the attached file resource. * **FileName** *(string) --* A case-sensitive name of the attached file being uploaded. * **FileSizeInBytes** *(integer) --* The size of the attached file in bytes. * **FileStatus** *(string) --* The current status of the attached file. * **CreatedBy** *(dict) --* Represents the identity that created the file. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ConnectUserArn", "AWSIdentityArn". 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'} * **ConnectUserArn** *(string) --* An agent ARN representing a connect user. * **AWSIdentityArn** *(string) --* STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if "ConnectUserArn" is not provided. * **FileUseCaseType** *(string) --* The use case for the file. * **AssociatedResourceArn** *(string) --* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. Note: This value must be a valid ARN. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, "{ "Tags": {"key1":"value1", "key2":"value2"} }". * *(string) --* * *(string) --* * **Errors** *(list) --* List of errors of attached files that could not be retrieved. * *(dict) --* Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action. * **ErrorCode** *(string) --* Status code describing the failure. * **ErrorMessage** *(string) --* Why the attached file couldn't be retrieved. * **FileId** *(string) --* The unique identifier of the attached file resource. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / list_queues list_queues *********** Connect.Client.list_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 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **QueueTypes** (*list*) -- The type of queue. * *(string) --* * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'QueueSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'QueueType': 'STANDARD'|'AGENT', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' }, ], '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. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_task_template create_task_template ******************** Connect.Client.create_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', SelfAssignFlowId='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'|'SELF_ASSIGN'|'EXPIRY_DURATION', 'SingleSelectOptions': [ 'string', ] }, ], ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** 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. * **SelfAssignFlowId** (*string*) -- The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task. * **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. * **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. * **Fields** (*list*) -- **[REQUIRED]** Fields that are part of the template. * *(dict) --* Describes a single task template field. * **Id** *(dict) --* **[REQUIRED]** 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. * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **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.PropertyValidationException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_instance_storage_config describe_instance_storage_config ******************************** Connect.Client.describe_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'|'ATTACHMENTS'|'CONTACT_EVALUATIONS'|'SCREEN_RECORDINGS'|'REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS'|'REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS'|'EMAIL_MESSAGES' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **AssociationId** (*string*) -- **[REQUIRED]** The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. * **ResourceType** (*string*) -- **[REQUIRED]** A valid resource type. Return type: dict Returns: **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.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **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.Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT. * **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.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / update_user_security_profiles update_user_security_profiles ***************************** Connect.Client.update_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' ) Parameters: * **SecurityProfileIds** (*list*) -- **[REQUIRED]** The identifiers of the security profiles for the user. * *(string) --* * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / search_routing_profiles search_routing_profiles *********************** Connect.Client.search_routing_profiles(**kwargs) Searches routing profiles in an Amazon Connect instance, with optional filtering. Note: "SearchRoutingProfiles" does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does. 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' } } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. * **SearchFilter** (*dict*) -- Filters to be applied to search results. * **TagFilter** *(dict) --* An object that can be used to specify Tag conditions inside the "SearchFilter". This accepts an "OR" of "AND" (List of List) input where: * Top level list specifies conditions that need to be applied with "OR" operator * Inner list specifies conditions that need to be applied with "AND" operator. * **OrConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(list) --* * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **AndConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition, for example, "HAVE BPO = 123". * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **TagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **TagKey** *(string) --* The tag key in the tag condition. * **TagValue** *(string) --* The tag value in the tag condition. * **SearchCriteria** (*dict*) -- The search criteria to be used to return routing profiles. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **OrConditions** *(list) --* A list of conditions which would be applied together with an OR condition. * *(dict) --* The search criteria to be used to return routing profiles. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **AndConditions** *(list) --* A list of conditions which would be applied together with an AND condition. * *(dict) --* The search criteria to be used to return routing profiles. Note: The "name" and "description" fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. * **StringCondition** *(dict) --* A leaf node condition which can be used to specify a string condition. Note: The currently supported values for "FieldName" are "associatedQueueIds", "name", "description", and "resourceID". * **FieldName** *(string) --* The name of the field in the string condition. * **Value** *(string) --* The value of the string. * **ComparisonType** *(string) --* The type of comparison to be made when evaluating the string condition. Return type: dict Returns: **Response Syntax** { 'RoutingProfiles': [ { 'InstanceId': 'string', 'Name': 'string', 'RoutingProfileArn': 'string', 'RoutingProfileId': 'string', 'Description': 'string', 'MediaConcurrencies': [ { 'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL', 'Concurrency': 123, 'CrossChannelBehavior': { 'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL' } }, ], 'DefaultOutboundQueueId': 'string', 'Tags': { 'string': 'string' }, 'NumberOfAssociatedQueues': 123, 'NumberOfAssociatedUsers': 123, 'AgentAvailabilityTimer': 'TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string', 'IsDefault': True|False, 'AssociatedQueueIds': [ 'string', ] }, ], '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 instance ID in the Amazon Resource Name (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. * **CrossChannelBehavior** *(dict) --* Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel. * **BehaviorType** *(string) --* Specifies the other channels that can be routed to an agent handling their current channel. * **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"} }. * *(string) --* * *(string) --* * **NumberOfAssociatedQueues** *(integer) --* The number of associated queues in routing profile. * **NumberOfAssociatedUsers** *(integer) --* The number of associated users in routing profile. * **AgentAvailabilityTimer** *(string) --* Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. * **IsDefault** *(boolean) --* Whether this a default routing profile. * **AssociatedQueueIds** *(list) --* The IDs of the associated queue. * *(string) --* * **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / list_security_profile_applications list_security_profile_applications ********************************** Connect.Client.list_security_profile_applications(**kwargs) Returns a list of third-party applications in a specific security profile. See also: AWS API Documentation **Request Syntax** response = client.list_security_profile_applications( SecurityProfileId='string', InstanceId='string', NextToken='string', MaxResults=123 ) Parameters: * **SecurityProfileId** (*string*) -- **[REQUIRED]** The identifier for the security profle. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'Applications': [ { 'Namespace': 'string', 'ApplicationPermissions': [ 'string', ] }, ], 'NextToken': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': 'string' } **Response Structure** * *(dict) --* * **Applications** *(list) --* A list of the third-party application's metadata. * *(dict) --* This API is in preview release for Amazon Connect and is subject to change. A third-party application's metadata. * **Namespace** *(string) --* Namespace of the application that you want to give access to. * **ApplicationPermissions** *(list) --* The permissions that the agent is granted on the application. Only the "ACCESS" permission is supported. * *(string) --* * **NextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **LastModifiedTime** *(datetime) --* The timestamp when this resource was last modified. * **LastModifiedRegion** *(string) --* The Amazon Web Services Region where this resource was last modified. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_evaluation_form describe_evaluation_form ************************ Connect.Client.describe_evaluation_form(**kwargs) Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described. See also: AWS API Documentation **Request Syntax** response = client.describe_evaluation_form( InstanceId='string', EvaluationFormId='string', EvaluationFormVersion=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationFormId** (*string*) -- **[REQUIRED]** A unique identifier for the contact evaluation. * **EvaluationFormVersion** (*integer*) -- A version of the evaluation form. Return type: dict Returns: **Response Syntax** { 'EvaluationForm': { 'EvaluationFormId': 'string', 'EvaluationFormVersion': 123, 'Locked': True|False, 'EvaluationFormArn': 'string', 'Title': 'string', 'Description': 'string', 'Status': 'DRAFT'|'ACTIVE', 'Items': [ { 'Section': { 'Title': 'string', 'RefId': 'string', 'Instructions': 'string', 'Items': {'... recursive ...'}, 'Weight': 123.0 }, 'Question': { 'Title': 'string', 'Instructions': 'string', 'RefId': 'string', 'NotApplicableEnabled': True|False, 'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC', 'QuestionTypeProperties': { 'Numeric': { 'MinValue': 123, 'MaxValue': 123, 'Options': [ { 'MinValue': 123, 'MaxValue': 123, 'Score': 123, 'AutomaticFail': True|False }, ], 'Automation': { 'PropertyValue': { 'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME' } } }, 'SingleSelect': { 'Options': [ { 'RefId': 'string', 'Text': 'string', 'Score': 123, 'AutomaticFail': True|False }, ], 'DisplayAs': 'DROPDOWN'|'RADIO', 'Automation': { 'Options': [ { 'RuleCategory': { 'Category': 'string', 'Condition': 'PRESENT'|'NOT_PRESENT', 'OptionRefId': 'string' } }, ], 'DefaultOptionRefId': 'string' } } }, 'Weight': 123.0 } }, ], 'ScoringStrategy': { 'Mode': 'QUESTION_ONLY'|'SECTION_ONLY', 'Status': 'ENABLED'|'DISABLED' }, 'CreatedTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedBy': 'string', 'Tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **EvaluationForm** *(dict) --* Information about the evaluation form. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **EvaluationFormVersion** *(integer) --* A version of the evaluation form. * **Locked** *(boolean) --* The flag indicating whether the evaluation form is locked for changes. * **EvaluationFormArn** *(string) --* The Amazon Resource Name (ARN) for the evaluation form resource. * **Title** *(string) --* A title of the evaluation form. * **Description** *(string) --* The description of the evaluation form. * **Status** *(string) --* The status of the evaluation form. * **Items** *(list) --* Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. * *(dict) --* Information about an item from an evaluation form. The item must be either a section or a question. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Section", "Question". 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'} * **Section** *(dict) --* The information of the section. * **Title** *(string) --* The title of the section. * **RefId** *(string) --* The identifier of the section. An identifier must be unique within the evaluation form. * **Instructions** *(string) --* The instructions of the section. * **Items** *(list) --* The items of the section. * **Weight** *(float) --* The scoring weight of the section. * **Question** *(dict) --* The information of the question. * **Title** *(string) --* The title of the question. * **Instructions** *(string) --* The instructions of the section. * **RefId** *(string) --* The identifier of the question. An identifier must be unique within the evaluation form. * **NotApplicableEnabled** *(boolean) --* The flag to enable not applicable answers to the question. * **QuestionType** *(string) --* The type of the question. * **QuestionTypeProperties** *(dict) --* The properties of the type of question. Text questions do not have to define question type properties. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "Numeric", "SingleSelect". 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'} * **Numeric** *(dict) --* The properties of the numeric question. * **MinValue** *(integer) --* The minimum answer value. * **MaxValue** *(integer) --* The maximum answer value. * **Options** *(list) --* The scoring options of the numeric question. * *(dict) --* Information about the option range used for scoring in numeric questions. * **MinValue** *(integer) --* The minimum answer value of the range option. * **MaxValue** *(integer) --* The maximum answer value of the range option. * **Score** *(integer) --* The score assigned to answer values within the range option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **Automation** *(dict) --* The automation properties of the numeric question. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "PropertyValue". 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'} * **PropertyValue** *(dict) --* The property value of the automation. * **Label** *(string) --* The property label of the automation. * **SingleSelect** *(dict) --* The properties of the numeric question. * **Options** *(list) --* The answer options of the single select question. * *(dict) --* Information about the automation configuration in single select questions. * **RefId** *(string) --* The identifier of the answer option. An identifier must be unique within the question. * **Text** *(string) --* The title of the answer option. * **Score** *(integer) --* The score assigned to the answer option. * **AutomaticFail** *(boolean) --* The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. * **DisplayAs** *(string) --* The display mode of the single select question. * **Automation** *(dict) --* The display mode of the single select question. * **Options** *(list) --* The automation options of the single select question. * *(dict) --* Information about the automation option of a single select question. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "RuleCategory". 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'} * **RuleCategory** *(dict) --* The automation option based on a rule category for the single select question. * **Category** *(string) --* The category name, as defined in Rules. * **Condition** *(string) --* The condition to apply for the automation option. If the condition is "PRESENT", then the option is applied when the contact data includes the category. Similarly, if the condition is "NOT_PRESENT", then the option is applied when the contact data does not include the category. * **OptionRefId** *(string) --* The identifier of the answer option. * **DefaultOptionRefId** *(string) --* The identifier of the default answer option, when none of the automation options match the criteria. * **Weight** *(float) --* The scoring weight of the section. * **ScoringStrategy** *(dict) --* A scoring strategy of the evaluation form. * **Mode** *(string) --* The scoring mode of the evaluation form. * **Status** *(string) --* The scoring status of the evaluation form. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation form was created. * **CreatedBy** *(string) --* The Amazon Resource Name (ARN) of the user who created the evaluation form. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation form was last updated. * **LastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation form. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / get_federation_token get_federation_token ******************** Connect.Client.get_federation_token(**kwargs) Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. 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' ) Parameters: **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** { 'Credentials': { 'AccessToken': 'string', 'AccessTokenExpiration': datetime(2015, 1, 1), 'RefreshToken': 'string', 'RefreshTokenExpiration': datetime(2015, 1, 1) }, 'SignInUrl': 'string', 'UserArn': 'string', 'UserId': 'string' } **Response Structure** * *(dict) --* * **Credentials** *(dict) --* The credentials to use for federation. * **AccessToken** *(string) --* An access token generated for a federated user to access Amazon Connect. * **AccessTokenExpiration** *(datetime) --* A token generated with an expiration time for the session a user is logged in to Amazon Connect. * **RefreshToken** *(string) --* Renews a token generated for a user to access the Amazon Connect instance. * **RefreshTokenExpiration** *(datetime) --* Renews the expiration timer for a generated token. * **SignInUrl** *(string) --* The URL to sign into the user's instance. * **UserArn** *(string) --* The Amazon Resource Name (ARN) of the user. * **UserId** *(string) --* The identifier for the user. This can be the ID or the ARN of the user. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.UserNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.DuplicateResourceException" Connect / Client / list_view_versions list_view_versions ****************** Connect.Client.list_view_versions(**kwargs) Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest. See also: AWS API Documentation **Request Syntax** response = client.list_view_versions( InstanceId='string', ViewId='string', NextToken='string', MaxResults=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ViewId** (*string*) -- **[REQUIRED]** The identifier of the view. Both "ViewArn" and "ViewId" can be used. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **MaxResults** (*integer*) -- The maximum number of results to return per page. The default MaxResult size is 100. Return type: dict Returns: **Response Syntax** { 'ViewVersionSummaryList': [ { 'Id': 'string', 'Arn': 'string', 'Description': 'string', 'Name': 'string', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Version': 123, 'VersionDescription': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ViewVersionSummaryList** *(list) --* A list of view version summaries. * *(dict) --* A summary of a view version's metadata. * **Id** *(string) --* The identifier of the view version. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the view version. * **Description** *(string) --* The description of the view version. * **Name** *(string) --* The name of the view version. * **Type** *(string) --* The type of the view version. * **Version** *(integer) --* The sequentially incremented version of the view version. * **VersionDescription** *(string) --* The description of the view version. * **NextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.TooManyRequestsException" Connect / Client / update_user_identity_info update_user_identity_info ************************* Connect.Client.update_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' ) Parameters: * **IdentityInfo** (*dict*) -- **[REQUIRED]** The identity information for the user. * **FirstName** *(string) --* The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. * **LastName** *(string) --* The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted. * **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. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / resume_contact_recording resume_contact_recording ************************ Connect.Client.resume_contact_recording(**kwargs) When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported. See also: AWS API Documentation **Request Syntax** response = client.resume_contact_recording( InstanceId='string', ContactId='string', InitialContactId='string', ContactRecordingType='AGENT'|'IVR'|'SCREEN' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **InitialContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. * **ContactRecordingType** (*string*) -- The type of recording being operated on. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / monitor_contact monitor_contact *************** Connect.Client.monitor_contact(**kwargs) Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by *userId* will be set to silent monitoring mode on the contact. See also: AWS API Documentation **Request Syntax** response = client.monitor_contact( InstanceId='string', ContactId='string', UserId='string', AllowedMonitorCapabilities=[ 'SILENT_MONITOR'|'BARGE', ], ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **AllowedMonitorCapabilities** (*list*) -- Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled. * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ContactId': 'string', 'ContactArn': 'string' } **Response Structure** * *(dict) --* * **ContactId** *(string) --* The identifier of the contact. * **ContactArn** *(string) --* The ARN of the contact. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.IdempotencyException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_hours_of_operation create_hours_of_operation ************************* Connect.Client.create_hours_of_operation(**kwargs) 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' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of the hours of operation. * **Description** (*string*) -- The description of the hours of operation. * **TimeZone** (*string*) -- **[REQUIRED]** The time zone of the hours of operation. * **Config** (*list*) -- **[REQUIRED]** Configuration information for the hours of operation: day, start time, and end time. * *(dict) --* Contains information about the hours of operation. * **Day** *(string) --* **[REQUIRED]** The day that the hours of operation applies to. * **StartTime** *(dict) --* **[REQUIRED]** The start time that your contact center opens. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **EndTime** *(dict) --* **[REQUIRED]** The end time that your contact center closes. * **Hours** *(integer) --* **[REQUIRED]** The hours. * **Minutes** *(integer) --* **[REQUIRED]** The minutes. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.DuplicateResourceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_traffic_distribution_group_user associate_traffic_distribution_group_user ***************************************** Connect.Client.associate_traffic_distribution_group_user(**kwargs) Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. See also: AWS API Documentation **Request Syntax** response = client.associate_traffic_distribution_group_user( TrafficDistributionGroupId='string', UserId='string', InstanceId='string' ) Parameters: * **TrafficDistributionGroupId** (*string*) -- **[REQUIRED]** The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group. * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. This can be the ID or the ARN of the user. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_approved_origin associate_approved_origin ************************* Connect.Client.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', ClientToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Origin** (*string*) -- **[REQUIRED]** The domain to add to your allow list. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Returns: None **Exceptions** * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ServiceQuotaExceededException" * "Connect.Client.exceptions.ThrottlingException" Connect / Client / stop_contact_recording stop_contact_recording ********************** Connect.Client.stop_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', ContactRecordingType='AGENT'|'IVR'|'SCREEN' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **InitialContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. * **ContactRecordingType** (*string*) -- The type of recording being operated on. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / associate_user_proficiencies associate_user_proficiencies **************************** Connect.Client.associate_user_proficiencies(**kwargs) Associates a set of proficiencies with a user. See also: AWS API Documentation **Request Syntax** response = client.associate_user_proficiencies( InstanceId='string', UserId='string', UserProficiencies=[ { 'AttributeName': 'string', 'AttributeValue': 'string', 'Level': ... }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance). * **UserId** (*string*) -- **[REQUIRED]** The identifier of the user account. * **UserProficiencies** (*list*) -- **[REQUIRED]** The proficiencies to associate with the user. * *(dict) --* Information about proficiency of a user. * **AttributeName** *(string) --* **[REQUIRED]** The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance. * **AttributeValue** *(string) --* **[REQUIRED]** The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance. * **Level** *(float) --* **[REQUIRED]** The level of the proficiency. The valid values are 1, 2, 3, 4 and 5. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_queue create_queue ************ Connect.Client.create_queue(**kwargs) Creates a new queue for the specified Amazon Connect instance. Warning: * If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for "OutboundCallerIdNumberId". However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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". * Only use the phone number ARN format that doesn't contain "instance" in the path, for example, "arn:aws:connect:us- east-1:1234567890:phone-number/uuid". This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. * If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. See also: AWS API Documentation **Request Syntax** response = client.create_queue( InstanceId='string', Name='string', Description='string', OutboundCallerConfig={ 'OutboundCallerIdName': 'string', 'OutboundCallerIdNumberId': 'string', 'OutboundFlowId': 'string' }, OutboundEmailConfig={ 'OutboundEmailAddressId': 'string' }, HoursOfOperationId='string', MaxContacts=123, QuickConnectIds=[ 'string', ], Tags={ 'string': 'string' } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Name** (*string*) -- **[REQUIRED]** The name of 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. * **OutboundEmailConfig** (*dict*) -- The outbound email address ID for a specified queue. * **OutboundEmailAddressId** *(string) --* The identifier of the email address. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** 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. * **QuickConnectIds** (*list*) -- The quick connects available to agents who are working the queue. * *(string) --* * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / create_user_hierarchy_group create_user_hierarchy_group *************************** Connect.Client.create_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' } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the user hierarchy group. Must not be more than 100 characters. * **ParentGroupId** (*string*) -- The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **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.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.DuplicateResourceException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / disassociate_phone_number_contact_flow disassociate_phone_number_contact_flow ************************************** Connect.Client.disassociate_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' ) Parameters: * **PhoneNumberId** (*string*) -- **[REQUIRED]** A unique identifier for the phone number. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.AccessDeniedException" Connect / Client / get_effective_hours_of_operations get_effective_hours_of_operations ********************************* Connect.Client.get_effective_hours_of_operations(**kwargs) Get the hours of operations with the effective override applied. See also: AWS API Documentation **Request Syntax** response = client.get_effective_hours_of_operations( InstanceId='string', HoursOfOperationId='string', FromDate='string', ToDate='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **HoursOfOperationId** (*string*) -- **[REQUIRED]** The identifier for the hours of operation. * **FromDate** (*string*) -- **[REQUIRED]** The date from when the hours of operation are listed. * **ToDate** (*string*) -- **[REQUIRED]** The date until when the hours of operation are listed. Return type: dict Returns: **Response Syntax** { 'EffectiveHoursOfOperationList': [ { 'Date': 'string', 'OperationalHours': [ { 'Start': { 'Hours': 123, 'Minutes': 123 }, 'End': { 'Hours': 123, 'Minutes': 123 } }, ] }, ], 'TimeZone': 'string' } **Response Structure** * *(dict) --* * **EffectiveHoursOfOperationList** *(list) --* Information about the effective hours of operations. * *(dict) --* Information about the hours of operations with the effective override applied. * **Date** *(string) --* The date that the hours of operation or overrides applies to. * **OperationalHours** *(list) --* Information about the hours of operations with the effective override applied. * *(dict) --* Information about the hours of operations with the effective override applied. * **Start** *(dict) --* The start time that your contact center opens. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **End** *(dict) --* The end time that your contact center closes. * **Hours** *(integer) --* The hours. * **Minutes** *(integer) --* The minutes. * **TimeZone** *(string) --* The time zone for the hours of operation. **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / suspend_contact_recording suspend_contact_recording ************************* Connect.Client.suspend_contact_recording(**kwargs) When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice (IVR, agent) and screen recordings are supported. See also: AWS API Documentation **Request Syntax** response = client.suspend_contact_recording( InstanceId='string', ContactId='string', InitialContactId='string', ContactRecordingType='AGENT'|'IVR'|'SCREEN' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. * **InitialContactId** (*string*) -- **[REQUIRED]** The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center. * **ContactRecordingType** (*string*) -- The type of recording being operated on. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / start_attached_file_upload start_attached_file_upload ************************** Connect.Client.start_attached_file_upload(**kwargs) Provides a pre-signed Amazon S3 URL in response for uploading your content. Warning: You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email. See also: AWS API Documentation **Request Syntax** response = client.start_attached_file_upload( ClientToken='string', InstanceId='string', FileName='string', FileSizeInBytes=123, UrlExpiryInSeconds=123, FileUseCaseType='EMAIL_MESSAGE'|'ATTACHMENT', AssociatedResourceArn='string', CreatedBy={ 'ConnectUserArn': 'string', 'AWSIdentityArn': 'string' }, Tags={ 'string': 'string' } ) Parameters: * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **InstanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Connect instance. * **FileName** (*string*) -- **[REQUIRED]** A case-sensitive name of the attached file being uploaded. * **FileSizeInBytes** (*integer*) -- **[REQUIRED]** The size of the attached file in bytes. * **UrlExpiryInSeconds** (*integer*) -- Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300. * **FileUseCaseType** (*string*) -- **[REQUIRED]** The use case for the file. Warning: Only "ATTACHMENTS" are supported. * **AssociatedResourceArn** (*string*) -- **[REQUIRED]** The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email. Note: This value must be a valid ARN. * **CreatedBy** (*dict*) -- Represents the identity that created the file. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "ConnectUserArn", "AWSIdentityArn". * **ConnectUserArn** *(string) --* An agent ARN representing a connect user. * **AWSIdentityArn** *(string) --* STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if "ConnectUserArn" is not provided. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, "{ "Tags": {"key1":"value1", "key2":"value2"} }". * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'FileArn': 'string', 'FileId': 'string', 'CreationTime': 'string', 'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED', 'CreatedBy': { 'ConnectUserArn': 'string', 'AWSIdentityArn': 'string' }, 'UploadUrlMetadata': { 'Url': 'string', 'UrlExpiry': 'string', 'HeadersToInclude': { 'string': 'string' } } } **Response Structure** * *(dict) --* Response from StartAttachedFileUpload API. * **FileArn** *(string) --* The unique identifier of the attached file resource (ARN). * **FileId** *(string) --* The unique identifier of the attached file resource. * **CreationTime** *(string) --* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: "yyyy-MM- ddThh:mm:ss.SSSZ". For example, "2024-05-03T02:41:28.172Z". * **FileStatus** *(string) --* The current status of the attached file. * **CreatedBy** *(dict) --* Represents the identity that created the file. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "ConnectUserArn", "AWSIdentityArn". 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'} * **ConnectUserArn** *(string) --* An agent ARN representing a connect user. * **AWSIdentityArn** *(string) --* STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if "ConnectUserArn" is not provided. * **UploadUrlMetadata** *(dict) --* The headers to be provided while uploading the file to the URL. * **Url** *(string) --* A pre-signed S3 URL that should be used for uploading the attached file. * **UrlExpiry** *(string) --* The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: "yyyy-MM-ddThh:mm:ss.SSSZ". For example, "2019-11-08T02:41:28.172Z". * **HeadersToInclude** *(dict) --* A map of headers that should be provided when uploading the attached file. * *(string) --* * *(string) --* **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.ResourceConflictException" * "Connect.Client.exceptions.ServiceQuotaExceededException" Connect / Client / delete_contact_evaluation delete_contact_evaluation ************************* Connect.Client.delete_contact_evaluation(**kwargs) Deletes a contact evaluation in the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.delete_contact_evaluation( InstanceId='string', EvaluationId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **EvaluationId** (*string*) -- **[REQUIRED]** A unique identifier for the contact evaluation. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.ResourceConflictException" Connect / Client / update_routing_profile_queues update_routing_profile_queues ***************************** Connect.Client.update_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'|'EMAIL' }, 'Priority': 123, 'Delay': 123 }, ] ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **RoutingProfileId** (*string*) -- **[REQUIRED]** The identifier of the routing profile. * **QueueConfigs** (*list*) -- **[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. * *(dict) --* Contains information about the queue and channel for which priority and delay can be set. * **QueueReference** *(dict) --* **[REQUIRED]** Contains information about a queue resource. * **QueueId** *(string) --* **[REQUIRED]** The identifier for the queue. * **Channel** *(string) --* **[REQUIRED]** The channels agents can handle in the Contact Control Panel (CCP) for this routing profile. * **Priority** *(integer) --* **[REQUIRED]** The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay. * **Delay** *(integer) --* **[REQUIRED]** 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*. Returns: None **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / batch_put_contact batch_put_contact ***************** Connect.Client.batch_put_contact(**kwargs) Note: Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. See also: AWS API Documentation **Request Syntax** response = client.batch_put_contact( ClientToken='string', InstanceId='string', ContactDataRequestList=[ { 'SystemEndpoint': { 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string' }, 'CustomerEndpoint': { 'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS', 'Address': 'string' }, 'RequestIdentifier': 'string', 'QueueId': 'string', 'Attributes': { 'string': 'string' }, 'Campaign': { 'CampaignId': 'string' } }, ] ) Parameters: * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactDataRequestList** (*list*) -- **[REQUIRED]** List of individual contact requests. * *(dict) --* Request object with information to create a contact. * **SystemEndpoint** *(dict) --* Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign. * **Type** *(string) --* Type of the endpoint. * **Address** *(string) --* Address of the endpoint. * **CustomerEndpoint** *(dict) --* Endpoint of the customer for which contact will be initiated. * **Type** *(string) --* Type of the endpoint. * **Address** *(string) --* Address of the endpoint. * **RequestIdentifier** *(string) --* Identifier to uniquely identify individual requests in the batch. * **QueueId** *(string) --* The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued. * **Attributes** *(dict) --* List of attributes to be stored in a contact. * *(string) --* * *(string) --* * **Campaign** *(dict) --* Structure to store information associated with a campaign. * **CampaignId** *(string) --* A unique identifier for a campaign. Return type: dict Returns: **Response Syntax** { 'SuccessfulRequestList': [ { 'RequestIdentifier': 'string', 'ContactId': 'string' }, ], 'FailedRequestList': [ { 'RequestIdentifier': 'string', 'FailureReasonCode': 'INVALID_ATTRIBUTE_KEY'|'INVALID_CUSTOMER_ENDPOINT'|'INVALID_SYSTEM_ENDPOINT'|'INVALID_QUEUE'|'MISSING_CAMPAIGN'|'MISSING_CUSTOMER_ENDPOINT'|'MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT'|'REQUEST_THROTTLED'|'IDEMPOTENCY_EXCEPTION'|'INTERNAL_ERROR', 'FailureReasonMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **SuccessfulRequestList** *(list) --* List of requests for which contact was successfully created. * *(dict) --* Request for which contact was successfully created. * **RequestIdentifier** *(string) --* Request identifier provided in the API call in the ContactDataRequest to create a contact. * **ContactId** *(string) --* The contactId of the contact that was created successfully. * **FailedRequestList** *(list) --* List of requests for which contact creation failed. * *(dict) --* Request for which contact failed to be generated. * **RequestIdentifier** *(string) --* Request identifier provided in the API call in the ContactDataRequest to create a contact. * **FailureReasonCode** *(string) --* Reason code for the failure. * **FailureReasonMessage** *(string) --* Why the request to create a contact failed. **Exceptions** * "Connect.Client.exceptions.AccessDeniedException" * "Connect.Client.exceptions.InternalServiceException" * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.LimitExceededException" * "Connect.Client.exceptions.IdempotencyException" Connect / Client / list_contact_evaluations list_contact_evaluations ************************ Connect.Client.list_contact_evaluations(**kwargs) Lists contact evaluations in the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_contact_evaluations( InstanceId='string', ContactId='string', NextToken='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. * **ContactId** (*string*) -- **[REQUIRED]** The identifier of the contact in this instance of Amazon Connect. * **NextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Warning: This is not expected to be set because the value returned in the previous response is always null. Return type: dict Returns: **Response Syntax** { 'EvaluationSummaryList': [ { 'EvaluationId': 'string', 'EvaluationArn': 'string', 'EvaluationFormTitle': 'string', 'EvaluationFormId': 'string', 'Status': 'DRAFT'|'SUBMITTED', 'EvaluatorArn': 'string', 'Score': { 'Percentage': 123.0, 'NotApplicable': True|False, 'AutomaticFail': True|False }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **EvaluationSummaryList** *(list) --* Provides details about a list of contact evaluations belonging to an instance. * *(dict) --* Summary information about a contact evaluation. * **EvaluationId** *(string) --* A unique identifier for the contact evaluation. * **EvaluationArn** *(string) --* The Amazon Resource Name (ARN) for the contact evaluation resource. * **EvaluationFormTitle** *(string) --* A title of the evaluation form. * **EvaluationFormId** *(string) --* The unique identifier for the evaluation form. * **Status** *(string) --* The status of the contact evaluation. * **EvaluatorArn** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the evaluation. * **Score** *(dict) --* The overall score of the contact evaluation. * **Percentage** *(float) --* The score percentage for an item in a contact evaluation. * **NotApplicable** *(boolean) --* The flag to mark the item as not applicable for scoring. * **AutomaticFail** *(boolean) --* The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true. * **CreatedTime** *(datetime) --* The timestamp for when the evaluation was created. * **LastModifiedTime** *(datetime) --* The timestamp for when the evaluation was last updated. * **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.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException" Connect / Client / describe_contact_flow describe_contact_flow ********************* Connect.Client.describe_contact_flow(**kwargs) Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the "$SAVED" alias in the request to describe the "SAVED" content of a Flow. For example, "arn:aws:.../contact- flow/{id}:$SAVED". After a flow is published, "$SAVED" needs to be supplied to view saved content that has not been published. Use "arn:aws:.../contact-flow/{id}:{version}" to retrieve the content of a specific flow version. In the response, **Status** indicates the flow status as either "SAVED" or "PUBLISHED". The "PUBLISHED" status will initiate validation on the content. "SAVED" does not initiate validation of the content. "SAVED" | "PUBLISHED" See also: AWS API Documentation **Request Syntax** response = client.describe_contact_flow( InstanceId='string', ContactFlowId='string' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Connect instance. * **ContactFlowId** (*string*) -- **[REQUIRED]** The identifier of the flow. Return type: dict Returns: **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'|'CAMPAIGN', 'State': 'ACTIVE'|'ARCHIVED', 'Status': 'PUBLISHED'|'SAVED', 'Description': 'string', 'Content': 'string', 'Tags': { 'string': 'string' }, 'FlowContentSha256': 'string', 'Version': 123, 'VersionDescription': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'LastModifiedRegion': '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. * **Status** *(string) --* The status of the flow. * **Description** *(string) --* The description of the flow. * **Content** *(string) --* The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language. Length Constraints: Minimum length of 1. Maximum length of 256000. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **FlowContentSha256** *(string) --* Indicates the checksum value of the flow content. * **Version** *(integer) --* The identifier of the flow version. * **VersionDescription** *(string) --* The description of the flow version. * **LastModifiedTime** *(datetime) --* The time at which the flow was last modified. * **LastModifiedRegion** *(string) --* The region in which the flow was last modified **Exceptions** * "Connect.Client.exceptions.InvalidRequestException" * "Connect.Client.exceptions.InvalidParameterException" * "Connect.Client.exceptions.ResourceNotFoundException" * "Connect.Client.exceptions.ContactFlowNotPublishedException" * "Connect.Client.exceptions.ThrottlingException" * "Connect.Client.exceptions.InternalServiceException"