Class: Aws::Connect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Connect::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb
Overview
An API client for Connect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Connect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse
Activates an evaluation form in the specified Amazon Connect instance.
-
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_default_vocabulary(params = {}) ⇒ Struct
Associates an existing vocabulary as the default.
-
#associate_flow(params = {}) ⇒ Struct
Associates a connect resource to a flow.
-
#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_phone_number_contact_flow(params = {}) ⇒ Struct
Associates a flow with a phone number claimed to your Amazon Connect instance.
-
#associate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_routing_profile_queues(params = {}) ⇒ Struct
Associates a set of queues with a routing profile.
-
#associate_security_key(params = {}) ⇒ Types::AssociateSecurityKeyResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_traffic_distribution_group_user(params = {}) ⇒ Struct
Associates an agent with a traffic distribution group.
-
#associate_user_proficiencies(params = {}) ⇒ Struct
>Associates a set of proficiencies with a user.
-
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#batch_get_flow_association(params = {}) ⇒ Types::BatchGetFlowAssociationResponse
Retrieve the flow associations for the given resources.
-
#batch_put_contact(params = {}) ⇒ Types::BatchPutContactResponse
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. -
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
-
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse
Creates a flow for the specified Amazon Connect instance.
-
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Amazon Connect instance.
-
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
Creates an evaluation form in the specified Amazon Connect instance.
-
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_integration_association(params = {}) ⇒ Types::CreateIntegrationAssociationResponse
Creates an Amazon Web Services resource association with an Amazon Connect instance.
-
#create_participant(params = {}) ⇒ Types::CreateParticipantResponse
Adds a new participant into an on-going chat contact.
-
#create_persistent_contact_association(params = {}) ⇒ Types::CreatePersistentContactAssociationResponse
Enables rehydration of chats for the lifespan of a contact.
-
#create_predefined_attribute(params = {}) ⇒ Struct
Creates a new predefined attribute for the specified Amazon Connect instance.
-
#create_prompt(params = {}) ⇒ Types::CreatePromptResponse
Creates a prompt.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_quick_connect(params = {}) ⇒ Types::CreateQuickConnectResponse
Creates a quick connect for the specified Amazon Connect instance.
-
#create_routing_profile(params = {}) ⇒ Types::CreateRoutingProfileResponse
Creates a new routing profile.
-
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a rule for the specified Amazon Connect instance.
-
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a security profile.
-
#create_task_template(params = {}) ⇒ Types::CreateTaskTemplateResponse
Creates a new task template in the specified Amazon Connect instance.
-
#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
-
#create_use_case(params = {}) ⇒ Types::CreateUseCaseResponse
Creates a use case for an integration association.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user account for the specified Amazon Connect instance.
-
#create_user_hierarchy_group(params = {}) ⇒ Types::CreateUserHierarchyGroupResponse
Creates a new user hierarchy group.
-
#create_view(params = {}) ⇒ Types::CreateViewResponse
Creates a new view with the possible status of
SAVED
orPUBLISHED
. -
#create_view_version(params = {}) ⇒ Types::CreateViewVersionResponse
Publishes a new version of the view identifier.
-
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
Creates a custom vocabulary associated with your Amazon Connect instance.
-
#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse
Deactivates an evaluation form in the specified Amazon Connect instance.
-
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Amazon Connect instance.
-
#delete_contact_flow(params = {}) ⇒ Struct
Deletes a flow for the specified Amazon Connect instance.
-
#delete_contact_flow_module(params = {}) ⇒ Struct
Deletes the specified flow module.
-
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Amazon Connect instance.
-
#delete_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#delete_instance(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#delete_integration_association(params = {}) ⇒ Struct
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
-
#delete_predefined_attribute(params = {}) ⇒ Struct
Deletes a predefined attribute from the specified Amazon Connect instance.
-
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
-
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
-
#delete_quick_connect(params = {}) ⇒ Struct
Deletes a quick connect.
-
#delete_routing_profile(params = {}) ⇒ Struct
Deletes a routing profile.
-
#delete_rule(params = {}) ⇒ Struct
Deletes a rule for the specified Amazon Connect instance.
-
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
-
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
-
#delete_traffic_distribution_group(params = {}) ⇒ Struct
Deletes a traffic distribution group.
-
#delete_use_case(params = {}) ⇒ Struct
Deletes a use case from an integration association.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user account from the specified Amazon Connect instance.
-
#delete_user_hierarchy_group(params = {}) ⇒ Struct
Deletes an existing user hierarchy group.
-
#delete_view(params = {}) ⇒ Struct
Deletes the view entirely.
-
#delete_view_version(params = {}) ⇒ Struct
Deletes the particular version specified in
ViewVersion
identifier. -
#delete_vocabulary(params = {}) ⇒ Types::DeleteVocabularyResponse
Deletes the vocabulary that has the given identifier.
-
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_contact_evaluation(params = {}) ⇒ Types::DescribeContactEvaluationResponse
Describes a contact evaluation in the specified Amazon Connect instance.
-
#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse
Describes the specified flow.
-
#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse
Describes the specified flow module.
-
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Amazon Connect instance.
-
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_instance_attribute(params = {}) ⇒ Types::DescribeInstanceAttributeResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_instance_storage_config(params = {}) ⇒ Types::DescribeInstanceStorageConfigResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
-
#describe_predefined_attribute(params = {}) ⇒ Types::DescribePredefinedAttributeResponse
Describes a predefined attribute for the specified Amazon Connect instance.
-
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
-
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
-
#describe_routing_profile(params = {}) ⇒ Types::DescribeRoutingProfileResponse
Describes the specified routing profile.
-
#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse
Describes a rule for the specified Amazon Connect instance.
-
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets basic information about the security profle.
-
#describe_traffic_distribution_group(params = {}) ⇒ Types::DescribeTrafficDistributionGroupResponse
Gets details and status of a traffic distribution group.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Describes the specified user.
-
#describe_user_hierarchy_group(params = {}) ⇒ Types::DescribeUserHierarchyGroupResponse
Describes the specified hierarchy group.
-
#describe_user_hierarchy_structure(params = {}) ⇒ Types::DescribeUserHierarchyStructureResponse
Describes the hierarchy structure of the specified Amazon Connect instance.
-
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
Retrieves the view for the specified Amazon Connect instance and view identifier.
-
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
-
#disassociate_analytics_data_set(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
-
#disassociate_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct
Removes the flow association from a phone number claimed to your Amazon Connect instance.
-
#disassociate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_routing_profile_queues(params = {}) ⇒ Struct
Disassociates a set of queues from a routing profile.
-
#disassociate_security_key(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_traffic_distribution_group_user(params = {}) ⇒ Struct
Disassociates an agent from a traffic distribution group.
-
#disassociate_user_proficiencies(params = {}) ⇒ Struct
Disassociates a set of proficiencies from a user.
-
#dismiss_user_contact(params = {}) ⇒ Struct
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.
-
#get_contact_attributes(params = {}) ⇒ Types::GetContactAttributesResponse
Retrieves the contact attributes for the specified contact.
-
#get_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse
Gets the real-time metric data from the specified Amazon Connect instance.
-
#get_current_user_data(params = {}) ⇒ Types::GetCurrentUserDataResponse
Gets the real-time active user data from the specified Amazon Connect instance.
-
#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse
Supports SAML sign-in for Amazon Connect.
-
#get_flow_association(params = {}) ⇒ Types::GetFlowAssociationResponse
Retrieves the flow associated for a given resource.
-
#get_metric_data(params = {}) ⇒ Types::GetMetricDataResponse
Gets historical metric data from the specified Amazon Connect instance.
-
#get_metric_data_v2(params = {}) ⇒ Types::GetMetricDataV2Response
Gets metric data from the specified Amazon Connect instance.
-
#get_prompt_file(params = {}) ⇒ Types::GetPromptFileResponse
Gets the prompt file.
-
#get_task_template(params = {}) ⇒ Types::GetTaskTemplateResponse
Gets details about a specific task template in the specified Amazon Connect instance.
-
#get_traffic_distribution(params = {}) ⇒ Types::GetTrafficDistributionResponse
Retrieves the current traffic distribution for a given traffic distribution group.
-
#import_phone_number(params = {}) ⇒ Types::ImportPhoneNumberResponse
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.
-
#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_bots(params = {}) ⇒ Types::ListBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Amazon Connect instance.
-
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Amazon Connect instance.
-
#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse
Provides information about the flows for the specified Amazon Connect instance.
-
#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Amazon Connect instance.
-
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Amazon Connect instance.
-
#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse
Lists evaluation forms in the specified Amazon Connect instance.
-
#list_flow_associations(params = {}) ⇒ Types::ListFlowAssociationsResponse
List the flow association based on the filters.
-
#list_hours_of_operations(params = {}) ⇒ Types::ListHoursOfOperationsResponse
Provides information about the hours of operation for the specified Amazon Connect instance.
-
#list_instance_attributes(params = {}) ⇒ Types::ListInstanceAttributesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_instance_storage_configs(params = {}) ⇒ Types::ListInstanceStorageConfigsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_integration_associations(params = {}) ⇒ Types::ListIntegrationAssociationsResponse
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
-
#list_lambda_functions(params = {}) ⇒ Types::ListLambdaFunctionsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_lex_bots(params = {}) ⇒ Types::ListLexBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Provides information about the phone numbers for the specified Amazon Connect instance.
-
#list_phone_numbers_v2(params = {}) ⇒ Types::ListPhoneNumbersV2Response
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
-
#list_predefined_attributes(params = {}) ⇒ Types::ListPredefinedAttributesResponse
Lists predefined attributes for the specified Amazon Connect instance.
-
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Provides information about the prompts for the specified Amazon Connect instance.
-
#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Provides information about the queues for the specified Amazon Connect instance.
-
#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse
Provides information about the quick connects for the specified Amazon Connect instance.
-
#list_realtime_contact_analysis_segments_v2(params = {}) ⇒ Types::ListRealtimeContactAnalysisSegmentsV2Response
Provides a list of analysis segments for a real-time analysis session.
-
#list_routing_profile_queues(params = {}) ⇒ Types::ListRoutingProfileQueuesResponse
Lists the queues associated with a routing profile.
-
#list_routing_profiles(params = {}) ⇒ Types::ListRoutingProfilesResponse
Provides summary information about the routing profiles for the specified Amazon Connect instance.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
List all rules for the specified Amazon Connect instance.
-
#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse
Returns a list of third-party applications in a specific security profile.
-
#list_security_profile_permissions(params = {}) ⇒ Types::ListSecurityProfilePermissionsResponse
Lists the permissions granted to a security profile.
-
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
Provides summary information about the security profiles for the specified Amazon Connect instance.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#list_task_templates(params = {}) ⇒ Types::ListTaskTemplatesResponse
Lists task templates for the specified Amazon Connect instance.
-
#list_traffic_distribution_group_users(params = {}) ⇒ Types::ListTrafficDistributionGroupUsersResponse
Lists traffic distribution group users.
-
#list_traffic_distribution_groups(params = {}) ⇒ Types::ListTrafficDistributionGroupsResponse
Lists traffic distribution groups.
-
#list_use_cases(params = {}) ⇒ Types::ListUseCasesResponse
Lists the use cases for the integration association.
-
#list_user_hierarchy_groups(params = {}) ⇒ Types::ListUserHierarchyGroupsResponse
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
-
#list_user_proficiencies(params = {}) ⇒ Types::ListUserProficienciesResponse
Lists proficiencies associated with a user.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Provides summary information about the users for the specified Amazon Connect instance.
-
#list_view_versions(params = {}) ⇒ Types::ListViewVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and view identifier.
-
#list_views(params = {}) ⇒ Types::ListViewsResponse
Returns views in the given instance.
-
#monitor_contact(params = {}) ⇒ Types::MonitorContactResponse
Initiates silent monitoring of a contact.
-
#pause_contact(params = {}) ⇒ Struct
Allows pausing an ongoing task contact.
-
#put_user_status(params = {}) ⇒ Struct
Changes the current status of a user or agent in Amazon Connect.
-
#release_phone_number(params = {}) ⇒ Struct
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
-
#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse
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.
-
#resume_contact(params = {}) ⇒ Struct
Allows resuming a task contact in a paused state.
-
#resume_contact_recording(params = {}) ⇒ Struct
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.
-
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
-
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Amazon Connect instance.
-
#search_hours_of_operations(params = {}) ⇒ Types::SearchHoursOfOperationsResponse
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
-
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Predefined attributes that meet certain criteria.
-
#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse
Searches prompts in an Amazon Connect instance, with optional filtering.
-
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Amazon Connect instance, with optional filtering.
-
#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse
Searches quick connects in an Amazon Connect instance, with optional filtering.
-
#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse
Searches tags used in an Amazon Connect instance using optional search criteria.
-
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Amazon Connect instance, with optional filtering.
-
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Amazon Connect instance, with optional filtering.
-
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users in an Amazon Connect instance, with optional filtering.
-
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Amazon Connect instance using
State
,NameStartsWith
, andLanguageCode
. -
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
-
#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse
Initiates a flow to start a new chat for the customer.
-
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
-
#start_contact_recording(params = {}) ⇒ Struct
Starts recording the contact:.
-
#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse
Initiates real-time message streaming for a new chat contact.
-
#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse
Places an outbound call to a contact, and then initiates the flow.
-
#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse
Initiates a flow to start a new task contact.
-
#start_web_rtc_contact(params = {}) ⇒ Types::StartWebRTCContactResponse
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
-
#stop_contact(params = {}) ⇒ Struct
Ends the specified contact.
-
#stop_contact_recording(params = {}) ⇒ Struct
Stops recording a call when a contact is being recorded.
-
#stop_contact_streaming(params = {}) ⇒ Struct
Ends message streaming on a specified contact.
-
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
Submits a contact evaluation in the specified Amazon Connect instance.
-
#suspend_contact_recording(params = {}) ⇒ Struct
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.
-
#tag_contact(params = {}) ⇒ Struct
Adds the specified tags to the contact resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#transfer_contact(params = {}) ⇒ Types::TransferContactResponse
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
-
#untag_contact(params = {}) ⇒ Struct
Removes the specified tags from the contact resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_agent_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_contact(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_contact_attributes(params = {}) ⇒ Struct
Creates or updates user-defined contact attributes associated with the specified contact.
-
#update_contact_evaluation(params = {}) ⇒ Types::UpdateContactEvaluationResponse
Updates details about a contact evaluation in the specified Amazon Connect instance.
-
#update_contact_flow_content(params = {}) ⇒ Struct
Updates the specified flow.
-
#update_contact_flow_metadata(params = {}) ⇒ Struct
Updates metadata about specified flow.
-
#update_contact_flow_module_content(params = {}) ⇒ Struct
Updates specified flow module for the specified Amazon Connect instance.
-
#update_contact_flow_module_metadata(params = {}) ⇒ Struct
Updates metadata about specified flow module.
-
#update_contact_flow_name(params = {}) ⇒ Struct
The name of the flow.
-
#update_contact_routing_data(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_contact_schedule(params = {}) ⇒ Struct
Updates the scheduled time of a task contact that is already scheduled.
-
#update_evaluation_form(params = {}) ⇒ Types::UpdateEvaluationFormResponse
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
-
#update_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_instance_attribute(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_participant_role_config(params = {}) ⇒ Struct
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
-
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse
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.
-
#update_phone_number_metadata(params = {}) ⇒ Struct
Updates a phone number’s metadata.
-
#update_predefined_attribute(params = {}) ⇒ Struct
Updates a predefined attribute for the specified Amazon Connect instance.
-
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
-
#update_queue_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_max_contacts(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_name(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_outbound_caller_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_quick_connect_config(params = {}) ⇒ Struct
Updates the configuration settings for the specified quick connect.
-
#update_quick_connect_name(params = {}) ⇒ Struct
Updates the name and description of a quick connect.
-
#update_routing_profile_agent_availability_timer(params = {}) ⇒ Struct
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
-
#update_routing_profile_concurrency(params = {}) ⇒ Struct
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
-
#update_routing_profile_default_outbound_queue(params = {}) ⇒ Struct
Updates the default outbound queue of a routing profile.
-
#update_routing_profile_name(params = {}) ⇒ Struct
Updates the name and description of a routing profile.
-
#update_routing_profile_queues(params = {}) ⇒ Struct
Updates the properties associated with a set of queues for a routing profile.
-
#update_rule(params = {}) ⇒ Struct
Updates a rule for the specified Amazon Connect instance.
-
#update_security_profile(params = {}) ⇒ Struct
Updates a security profile.
-
#update_task_template(params = {}) ⇒ Types::UpdateTaskTemplateResponse
Updates details about a specific task template in the specified Amazon Connect instance.
-
#update_traffic_distribution(params = {}) ⇒ Struct
Updates the traffic distribution for a given traffic distribution group.
-
#update_user_hierarchy(params = {}) ⇒ Struct
Assigns the specified hierarchy group to the specified user.
-
#update_user_hierarchy_group_name(params = {}) ⇒ Struct
Updates the name of the user hierarchy group.
-
#update_user_hierarchy_structure(params = {}) ⇒ Struct
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
-
#update_user_identity_info(params = {}) ⇒ Struct
Updates the identity information for the specified user.
-
#update_user_phone_config(params = {}) ⇒ Struct
Updates the phone configuration settings for the specified user.
-
#update_user_proficiencies(params = {}) ⇒ Struct
Updates the properties associated with the proficiencies of a user.
-
#update_user_routing_profile(params = {}) ⇒ Struct
Assigns the specified routing profile to the specified user.
-
#update_user_security_profiles(params = {}) ⇒ Struct
Assigns the specified security profiles to the specified user.
-
#update_view_content(params = {}) ⇒ Types::UpdateViewContentResponse
Updates the view content of the given view identifier in the specified Amazon Connect instance.
-
#update_view_metadata(params = {}) ⇒ Struct
Updates the view metadata.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse
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.
435 436 437 438 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 435 def activate_evaluation_form(params = {}, = {}) req = build_request(:activate_evaluation_form, params) req.send_request() end |
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
490 491 492 493 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 490 def associate_analytics_data_set(params = {}, = {}) req = build_request(:associate_analytics_data_set, params) req.send_request() end |
#associate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
524 525 526 527 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 524 def associate_approved_origin(params = {}, = {}) req = build_request(:associate_approved_origin, params) req.send_request() end |
#associate_bot(params = {}) ⇒ Struct
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.
568 569 570 571 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 568 def associate_bot(params = {}, = {}) req = build_request(:associate_bot, params) req.send_request() end |
#associate_default_vocabulary(params = {}) ⇒ Struct
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.
612 613 614 615 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 612 def associate_default_vocabulary(params = {}, = {}) req = build_request(:associate_default_vocabulary, params) req.send_request() end |
#associate_flow(params = {}) ⇒ Struct
Associates a connect resource to a flow.
651 652 653 654 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 651 def associate_flow(params = {}, = {}) req = build_request(:associate_flow, params) req.send_request() end |
#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse
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.
748 749 750 751 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 748 def associate_instance_storage_config(params = {}, = {}) req = build_request(:associate_instance_storage_config, params) req.send_request() end |
#associate_lambda_function(params = {}) ⇒ Struct
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.
784 785 786 787 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 784 def associate_lambda_function(params = {}, = {}) req = build_request(:associate_lambda_function, params) req.send_request() end |
#associate_lex_bot(params = {}) ⇒ Struct
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.
823 824 825 826 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 823 def associate_lex_bot(params = {}, = {}) req = build_request(:associate_lex_bot, params) req.send_request() end |
#associate_phone_number_contact_flow(params = {}) ⇒ Struct
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are
calling this API using an instance in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a
full phone number ARN or UUID value for the PhoneNumberId
URI
request parameter. However, if the number is claimed to a traffic
distribution group and you are calling this API using an instance in
the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a
UUID is provided in this scenario, you will receive a
ResourceNotFoundException
.
870 871 872 873 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 870 def associate_phone_number_contact_flow(params = {}, = {}) req = build_request(:associate_phone_number_contact_flow, params) req.send_request() end |
#associate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
908 909 910 911 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 908 def associate_queue_quick_connects(params = {}, = {}) req = build_request(:associate_queue_quick_connects, params) req.send_request() end |
#associate_routing_profile_queues(params = {}) ⇒ Struct
Associates a set of queues with a routing profile.
952 953 954 955 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 952 def associate_routing_profile_queues(params = {}, = {}) req = build_request(:associate_routing_profile_queues, params) req.send_request() end |
#associate_security_key(params = {}) ⇒ Types::AssociateSecurityKeyResponse
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
992 993 994 995 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 992 def associate_security_key(params = {}, = {}) req = build_request(:associate_security_key, params) req.send_request() end |
#associate_traffic_distribution_group_user(params = {}) ⇒ Struct
Associates an agent with a traffic distribution group.
1031 1032 1033 1034 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1031 def associate_traffic_distribution_group_user(params = {}, = {}) req = build_request(:associate_traffic_distribution_group_user, params) req.send_request() end |
#associate_user_proficiencies(params = {}) ⇒ Struct
>Associates a set of proficiencies with a user.
1068 1069 1070 1071 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1068 def associate_user_proficiencies(params = {}, = {}) req = build_request(:associate_user_proficiencies, params) req.send_request() end |
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
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.
1125 1126 1127 1128 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1125 def batch_associate_analytics_data_set(params = {}, = {}) req = build_request(:batch_associate_analytics_data_set, params) req.send_request() end |
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
1179 1180 1181 1182 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1179 def batch_disassociate_analytics_data_set(params = {}, = {}) req = build_request(:batch_disassociate_analytics_data_set, params) req.send_request() end |
#batch_get_flow_association(params = {}) ⇒ Types::BatchGetFlowAssociationResponse
Retrieve the flow associations for the given resources.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1223 def batch_get_flow_association(params = {}, = {}) req = build_request(:batch_get_flow_association, params) req.send_request() end |
#batch_put_contact(params = {}) ⇒ Types::BatchPutContactResponse
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.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1315 def batch_put_contact(params = {}, = {}) req = build_request(:batch_put_contact, params) req.send_request() end |
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 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 during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 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 30 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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1430 def claim_phone_number(params = {}, = {}) req = build_request(:claim_phone_number, params) req.send_request() end |
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1492 def create_agent_status(params = {}, = {}) req = build_request(:create_agent_status, params) req.send_request() end |
#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1565 def create_contact_flow(params = {}, = {}) req = build_request(:create_contact_flow, params) req.send_request() end |
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Amazon Connect instance.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1639 def create_contact_flow_module(params = {}, = {}) req = build_request(:create_contact_flow_module, params) req.send_request() end |
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
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.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1774 def create_evaluation_form(params = {}, = {}) req = build_request(:create_evaluation_form, params) req.send_request() end |
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1849 def create_hours_of_operation(params = {}, = {}) req = build_request(:create_hours_of_operation, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
1919 1920 1921 1922 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1919 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#create_integration_association(params = {}) ⇒ Types::CreateIntegrationAssociationResponse
Creates an Amazon Web Services resource association with an Amazon Connect instance.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1991 def create_integration_association(params = {}, = {}) req = build_request(:create_integration_association, params) req.send_request() end |
#create_participant(params = {}) ⇒ Types::CreateParticipantResponse
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2063 def create_participant(params = {}, = {}) req = build_request(:create_participant, params) req.send_request() end |
#create_persistent_contact_association(params = {}) ⇒ Types::CreatePersistentContactAssociationResponse
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.
2188 2189 2190 2191 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2188 def create_persistent_contact_association(params = {}, = {}) req = build_request(:create_persistent_contact_association, params) req.send_request() end |
#create_predefined_attribute(params = {}) ⇒ Struct
Creates a new predefined attribute for the specified Amazon Connect instance.
2222 2223 2224 2225 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2222 def create_predefined_attribute(params = {}, = {}) req = build_request(:create_predefined_attribute, params) req.send_request() end |
#create_prompt(params = {}) ⇒ Types::CreatePromptResponse
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide.
2289 2290 2291 2292 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2289 def create_prompt(params = {}, = {}) req = build_request(:create_prompt, params) req.send_request() end |
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the 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 aResourceNotFoundException
.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.
2391 2392 2393 2394 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2391 def create_queue(params = {}, = {}) req = build_request(:create_queue, params) req.send_request() end |
#create_quick_connect(params = {}) ⇒ Types::CreateQuickConnectResponse
Creates a quick connect for the specified Amazon Connect instance.
2459 2460 2461 2462 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2459 def create_quick_connect(params = {}, = {}) req = build_request(:create_quick_connect, params) req.send_request() end |
#create_routing_profile(params = {}) ⇒ Types::CreateRoutingProfileResponse
Creates a new routing profile.
2558 2559 2560 2561 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2558 def create_routing_profile(params = {}, = {}) req = build_request(:create_routing_profile, params) req.send_request() end |
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
2699 2700 2701 2702 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2699 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a security profile.
2796 2797 2798 2799 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2796 def create_security_profile(params = {}, = {}) req = build_request(:create_security_profile, params) req.send_request() end |
#create_task_template(params = {}) ⇒ Types::CreateTaskTemplateResponse
Creates a new task template in the specified Amazon Connect instance.
2918 2919 2920 2921 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2918 def create_task_template(params = {}, = {}) req = build_request(:create_task_template, params) req.send_request() end |
#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
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.
2998 2999 3000 3001 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2998 def create_traffic_distribution_group(params = {}, = {}) req = build_request(:create_traffic_distribution_group, params) req.send_request() end |
#create_use_case(params = {}) ⇒ Types::CreateUseCaseResponse
Creates a use case for an integration association.
3050 3051 3052 3053 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3050 def create_use_case(params = {}, = {}) req = build_request(:create_use_case, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some
situations. For example, Email
is required if you are using SAML for
identity management. 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.
3173 3174 3175 3176 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3173 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#create_user_hierarchy_group(params = {}) ⇒ Types::CreateUserHierarchyGroupResponse
Creates a new user hierarchy group.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3226 def create_user_hierarchy_group(params = {}, = {}) req = build_request(:create_user_hierarchy_group, params) req.send_request() end |
#create_view(params = {}) ⇒ Types::CreateViewResponse
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.
3317 3318 3319 3320 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3317 def create_view(params = {}, = {}) req = build_request(:create_view, params) req.send_request() end |
#create_view_version(params = {}) ⇒ Types::CreateViewVersionResponse
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.
3381 3382 3383 3384 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3381 def create_view_version(params = {}, = {}) req = build_request(:create_view_version, params) req.send_request() end |
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
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.
3472 3473 3474 3475 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3472 def create_vocabulary(params = {}, = {}) req = build_request(:create_vocabulary, params) req.send_request() end |
#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse
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.
3520 3521 3522 3523 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3520 def deactivate_evaluation_form(params = {}, = {}) req = build_request(:deactivate_evaluation_form, params) req.send_request() end |
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Amazon Connect instance.
3551 3552 3553 3554 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3551 def delete_contact_evaluation(params = {}, = {}) req = build_request(:delete_contact_evaluation, params) req.send_request() end |
#delete_contact_flow(params = {}) ⇒ Struct
Deletes a flow for the specified Amazon Connect instance.
3582 3583 3584 3585 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3582 def delete_contact_flow(params = {}, = {}) req = build_request(:delete_contact_flow, params) req.send_request() end |
#delete_contact_flow_module(params = {}) ⇒ Struct
Deletes the specified flow module.
3613 3614 3615 3616 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3613 def delete_contact_flow_module(params = {}, = {}) req = build_request(:delete_contact_flow_module, params) req.send_request() end |
#delete_evaluation_form(params = {}) ⇒ Struct
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.
3654 3655 3656 3657 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3654 def delete_evaluation_form(params = {}, = {}) req = build_request(:delete_evaluation_form, params) req.send_request() end |
#delete_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
3688 3689 3690 3691 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3688 def delete_hours_of_operation(params = {}, = {}) req = build_request(:delete_hours_of_operation, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
3725 3726 3727 3728 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3725 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_integration_association(params = {}) ⇒ Struct
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
3758 3759 3760 3761 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3758 def delete_integration_association(params = {}, = {}) req = build_request(:delete_integration_association, params) req.send_request() end |
#delete_predefined_attribute(params = {}) ⇒ Struct
Deletes a predefined attribute from the specified Amazon Connect instance.
3786 3787 3788 3789 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3786 def delete_predefined_attribute(params = {}, = {}) req = build_request(:delete_predefined_attribute, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
3817 3818 3819 3820 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3817 def delete_prompt(params = {}, = {}) req = build_request(:delete_prompt, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
3848 3849 3850 3851 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3848 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#delete_quick_connect(params = {}) ⇒ Struct
Deletes a quick connect.
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.
3897 3898 3899 3900 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3897 def delete_quick_connect(params = {}, = {}) req = build_request(:delete_quick_connect, params) req.send_request() end |
#delete_routing_profile(params = {}) ⇒ Struct
Deletes a routing profile.
3928 3929 3930 3931 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3928 def delete_routing_profile(params = {}, = {}) req = build_request(:delete_routing_profile, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
Deletes a rule for the specified Amazon Connect instance.
3959 3960 3961 3962 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3959 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
3990 3991 3992 3993 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3990 def delete_security_profile(params = {}, = {}) req = build_request(:delete_security_profile, params) req.send_request() end |
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
4021 4022 4023 4024 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4021 def delete_task_template(params = {}, = {}) req = build_request(:delete_task_template, params) req.send_request() end |
#delete_traffic_distribution_group(params = {}) ⇒ Struct
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.
4055 4056 4057 4058 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4055 def delete_traffic_distribution_group(params = {}, = {}) req = build_request(:delete_traffic_distribution_group, params) req.send_request() end |
#delete_use_case(params = {}) ⇒ Struct
Deletes a use case from an integration association.
4090 4091 4092 4093 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4090 def delete_use_case(params = {}, = {}) req = build_request(:delete_use_case, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
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.
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.
4143 4144 4145 4146 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4143 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#delete_user_hierarchy_group(params = {}) ⇒ Struct
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
4175 4176 4177 4178 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4175 def delete_user_hierarchy_group(params = {}, = {}) req = build_request(:delete_user_hierarchy_group, params) req.send_request() end |
#delete_view(params = {}) ⇒ Struct
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
4203 4204 4205 4206 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4203 def delete_view(params = {}, = {}) req = build_request(:delete_view, params) req.send_request() end |
#delete_view_version(params = {}) ⇒ Struct
Deletes the particular version specified in ViewVersion
identifier.
4234 4235 4236 4237 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4234 def delete_view_version(params = {}, = {}) req = build_request(:delete_view_version, params) req.send_request() end |
#delete_vocabulary(params = {}) ⇒ Types::DeleteVocabularyResponse
Deletes the vocabulary that has the given identifier.
4275 4276 4277 4278 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4275 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
4325 4326 4327 4328 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4325 def describe_agent_status(params = {}, = {}) req = build_request(:describe_agent_status, params) req.send_request() end |
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
4396 4397 4398 4399 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4396 def describe_contact(params = {}, = {}) req = build_request(:describe_contact, params) req.send_request() end |
#describe_contact_evaluation(params = {}) ⇒ Types::DescribeContactEvaluationResponse
Describes a contact evaluation in the specified Amazon Connect instance.
4498 4499 4500 4501 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4498 def describe_contact_evaluation(params = {}, = {}) req = build_request(:describe_contact_evaluation, params) req.send_request() end |
#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
4545 4546 4547 4548 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4545 def describe_contact_flow(params = {}, = {}) req = build_request(:describe_contact_flow, params) req.send_request() end |
#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse
Describes the specified flow module.
4590 4591 4592 4593 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4590 def describe_contact_flow_module(params = {}, = {}) req = build_request(:describe_contact_flow_module, params) req.send_request() end |
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
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.
4678 4679 4680 4681 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4678 def describe_evaluation_form(params = {}, = {}) req = build_request(:describe_evaluation_form, params) req.send_request() end |
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
4732 4733 4734 4735 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4732 def describe_hours_of_operation(params = {}, = {}) req = build_request(:describe_hours_of_operation, params) req.send_request() end |
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
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.
4787 4788 4789 4790 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4787 def describe_instance(params = {}, = {}) req = build_request(:describe_instance, params) req.send_request() end |
#describe_instance_attribute(params = {}) ⇒ Types::DescribeInstanceAttributeResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
4828 4829 4830 4831 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4828 def describe_instance_attribute(params = {}, = {}) req = build_request(:describe_instance_attribute, params) req.send_request() end |
#describe_instance_storage_config(params = {}) ⇒ Types::DescribeInstanceStorageConfigResponse
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.
4885 4886 4887 4888 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4885 def describe_instance_storage_config(params = {}, = {}) req = build_request(:describe_instance_storage_config, params) req.send_request() end |
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are
calling in the Amazon Web Services Region where the traffic
distribution group was created, you can use either a phone number ARN
or UUID value for the PhoneNumberId
URI request parameter. However,
if the number is claimed to a traffic distribution group and you are
calling this API in the alternate Amazon Web Services Region
associated with the traffic distribution group, you must provide a
full phone number ARN. If a UUID is provided in this scenario, you
will receive a ResourceNotFoundException
.
4936 4937 4938 4939 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4936 def describe_phone_number(params = {}, = {}) req = build_request(:describe_phone_number, params) req.send_request() end |
#describe_predefined_attribute(params = {}) ⇒ Types::DescribePredefinedAttributeResponse
Describes a predefined attribute for the specified Amazon Connect instance.
4974 4975 4976 4977 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4974 def describe_predefined_attribute(params = {}, = {}) req = build_request(:describe_predefined_attribute, params) req.send_request() end |
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
5018 5019 5020 5021 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5018 def describe_prompt(params = {}, = {}) req = build_request(:describe_prompt, params) req.send_request() end |
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
5071 5072 5073 5074 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5071 def describe_queue(params = {}, = {}) req = build_request(:describe_queue, params) req.send_request() end |
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
5121 5122 5123 5124 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5121 def describe_quick_connect(params = {}, = {}) req = build_request(:describe_quick_connect, params) req.send_request() end |
#describe_routing_profile(params = {}) ⇒ Types::DescribeRoutingProfileResponse
Describes the specified routing profile.
5175 5176 5177 5178 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5175 def describe_routing_profile(params = {}, = {}) req = build_request(:describe_routing_profile, params) req.send_request() end |
#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse
Describes a rule for the specified Amazon Connect instance.
5251 5252 5253 5254 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5251 def describe_rule(params = {}, = {}) req = build_request(:describe_rule, params) req.send_request() end |
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets basic information about the security profle.
5303 5304 5305 5306 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5303 def describe_security_profile(params = {}, = {}) req = build_request(:describe_security_profile, params) req.send_request() end |
#describe_traffic_distribution_group(params = {}) ⇒ Types::DescribeTrafficDistributionGroupResponse
Gets details and status of a traffic distribution group.
5342 5343 5344 5345 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5342 def describe_traffic_distribution_group(params = {}, = {}) req = build_request(:describe_traffic_distribution_group, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
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.
5406 5407 5408 5409 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5406 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_user_hierarchy_group(params = {}) ⇒ Types::DescribeUserHierarchyGroupResponse
Describes the specified hierarchy group.
5475 5476 5477 5478 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5475 def describe_user_hierarchy_group(params = {}, = {}) req = build_request(:describe_user_hierarchy_group, params) req.send_request() end |
#describe_user_hierarchy_structure(params = {}) ⇒ Types::DescribeUserHierarchyStructureResponse
Describes the hierarchy structure of the specified Amazon Connect instance.
5533 5534 5535 5536 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5533 def describe_user_hierarchy_structure(params = {}, = {}) req = build_request(:describe_user_hierarchy_structure, params) req.send_request() end |
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
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,
<view-id>:$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.
5595 5596 5597 5598 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5595 def describe_view(params = {}, = {}) req = build_request(:describe_view, params) req.send_request() end |
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
5641 5642 5643 5644 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5641 def describe_vocabulary(params = {}, = {}) req = build_request(:describe_vocabulary, params) req.send_request() end |
#disassociate_analytics_data_set(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
5683 5684 5685 5686 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5683 def disassociate_analytics_data_set(params = {}, = {}) req = build_request(:disassociate_analytics_data_set, params) req.send_request() end |
#disassociate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
5717 5718 5719 5720 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5717 def disassociate_approved_origin(params = {}, = {}) req = build_request(:disassociate_approved_origin, params) req.send_request() end |
#disassociate_bot(params = {}) ⇒ Struct
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.
5761 5762 5763 5764 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5761 def disassociate_bot(params = {}, = {}) req = build_request(:disassociate_bot, params) req.send_request() end |
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
5796 5797 5798 5799 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5796 def disassociate_flow(params = {}, = {}) req = build_request(:disassociate_flow, params) req.send_request() end |
#disassociate_instance_storage_config(params = {}) ⇒ Struct
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.
5836 5837 5838 5839 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5836 def disassociate_instance_storage_config(params = {}, = {}) req = build_request(:disassociate_instance_storage_config, params) req.send_request() end |
#disassociate_lambda_function(params = {}) ⇒ Struct
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.
5872 5873 5874 5875 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5872 def disassociate_lambda_function(params = {}, = {}) req = build_request(:disassociate_lambda_function, params) req.send_request() end |
#disassociate_lex_bot(params = {}) ⇒ Struct
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.
5912 5913 5914 5915 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5912 def disassociate_lex_bot(params = {}, = {}) req = build_request(:disassociate_lex_bot, params) req.send_request() end |
#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are
calling this API using an instance in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a
full phone number ARN or UUID value for the PhoneNumberId
URI
request parameter. However, if the number is claimed to a traffic
distribution group and you are calling this API using an instance in
the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a
UUID is provided in this scenario, you will receive a
ResourceNotFoundException
.
5955 5956 5957 5958 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5955 def disassociate_phone_number_contact_flow(params = {}, = {}) req = build_request(:disassociate_phone_number_contact_flow, params) req.send_request() end |
#disassociate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
5993 5994 5995 5996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5993 def disassociate_queue_quick_connects(params = {}, = {}) req = build_request(:disassociate_queue_quick_connects, params) req.send_request() end |
#disassociate_routing_profile_queues(params = {}) ⇒ Struct
Disassociates a set of queues from a routing profile.
6033 6034 6035 6036 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6033 def disassociate_routing_profile_queues(params = {}, = {}) req = build_request(:disassociate_routing_profile_queues, params) req.send_request() end |
#disassociate_security_key(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
6068 6069 6070 6071 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6068 def disassociate_security_key(params = {}, = {}) req = build_request(:disassociate_security_key, params) req.send_request() end |
#disassociate_traffic_distribution_group_user(params = {}) ⇒ Struct
Disassociates an agent from a traffic distribution group.
6107 6108 6109 6110 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6107 def disassociate_traffic_distribution_group_user(params = {}, = {}) req = build_request(:disassociate_traffic_distribution_group_user, params) req.send_request() end |
#disassociate_user_proficiencies(params = {}) ⇒ Struct
Disassociates a set of proficiencies from a user.
6143 6144 6145 6146 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6143 def disassociate_user_proficiencies(params = {}, = {}) req = build_request(:disassociate_user_proficiencies, params) req.send_request() end |
#dismiss_user_contact(params = {}) ⇒ Struct
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.
6181 6182 6183 6184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6181 def dismiss_user_contact(params = {}, = {}) req = build_request(:dismiss_user_contact, params) req.send_request() end |
#get_contact_attributes(params = {}) ⇒ Types::GetContactAttributesResponse
Retrieves the contact attributes for the specified contact.
6214 6215 6216 6217 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6214 def get_contact_attributes(params = {}, = {}) req = build_request(:get_contact_attributes, params) req.send_request() end |
#get_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6480 6481 6482 6483 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6480 def get_current_metric_data(params = {}, = {}) req = build_request(:get_current_metric_data, params) req.send_request() end |
#get_current_user_data(params = {}) ⇒ Types::GetCurrentUserDataResponse
Gets the real-time active user data from the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6593 6594 6595 6596 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6593 def get_current_user_data(params = {}, = {}) req = build_request(:get_current_user_data, params) req.send_request() end |
#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse
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.
Provided identity: Principal: .... User: .... cannot be used for
federation with Amazon Connect
6654 6655 6656 6657 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6654 def get_federation_token(params = {}, = {}) req = build_request(:get_federation_token, params) req.send_request() end |
#get_flow_association(params = {}) ⇒ Types::GetFlowAssociationResponse
Retrieves the flow associated for a given resource.
6699 6700 6701 6702 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6699 def get_flow_association(params = {}, = {}) req = build_request(:get_flow_association, params) req.send_request() end |
#get_metric_data(params = {}) ⇒ Types::GetMetricDataResponse
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7015 7016 7017 7018 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7015 def get_metric_data(params = {}, = {}) req = build_request(:get_metric_data, params) req.send_request() end |
#get_metric_data_v2(params = {}) ⇒ Types::GetMetricDataV2Response
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.
For a description of the historical metrics that are supported by
GetMetricDataV2
and GetMetricData
, see Historical metrics
definitions in the Amazon Connect Administrator's Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8176 8177 8178 8179 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8176 def get_metric_data_v2(params = {}, = {}) req = build_request(:get_metric_data_v2, params) req.send_request() end |
#get_prompt_file(params = {}) ⇒ Types::GetPromptFileResponse
Gets the prompt file.
8217 8218 8219 8220 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8217 def get_prompt_file(params = {}, = {}) req = build_request(:get_prompt_file, params) req.send_request() end |
#get_task_template(params = {}) ⇒ Types::GetTaskTemplateResponse
Gets details about a specific task template in the specified Amazon Connect instance.
8297 8298 8299 8300 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8297 def get_task_template(params = {}, = {}) req = build_request(:get_task_template, params) req.send_request() end |
#get_traffic_distribution(params = {}) ⇒ Types::GetTrafficDistributionResponse
Retrieves the current traffic distribution for a given traffic distribution group.
8343 8344 8345 8346 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8343 def get_traffic_distribution(params = {}, = {}) req = build_request(:get_traffic_distribution, params) req.send_request() end |
#import_phone_number(params = {}) ⇒ Types::ImportPhoneNumberResponse
Imports a claimed phone number from an external service, such as Amazon Pinpoint, 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.
8413 8414 8415 8416 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8413 def import_phone_number(params = {}, = {}) req = build_request(:import_phone_number, params) req.send_request() end |
#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8473 8474 8475 8476 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8473 def list_agent_statuses(params = {}, = {}) req = build_request(:list_agent_statuses, params) req.send_request() end |
#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse
This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
8530 8531 8532 8533 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8530 def list_analytics_data_associations(params = {}, = {}) req = build_request(:list_analytics_data_associations, params) req.send_request() end |
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8582 8583 8584 8585 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8582 def list_approved_origins(params = {}, = {}) req = build_request(:list_approved_origins, params) req.send_request() end |
#list_bots(params = {}) ⇒ Types::ListBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8641 8642 8643 8644 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8641 def list_bots(params = {}, = {}) req = build_request(:list_bots, params) req.send_request() end |
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8702 8703 8704 8705 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8702 def list_contact_evaluations(params = {}, = {}) req = build_request(:list_contact_evaluations, params) req.send_request() end |
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8758 8759 8760 8761 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8758 def list_contact_flow_modules(params = {}, = {}) req = build_request(:list_contact_flow_modules, params) req.send_request() end |
#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8827 8828 8829 8830 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8827 def list_contact_flows(params = {}, = {}) req = build_request(:list_contact_flows, params) req.send_request() end |
#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8899 8900 8901 8902 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8899 def list_contact_references(params = {}, = {}) req = build_request(:list_contact_references, params) req.send_request() end |
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8961 8962 8963 8964 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8961 def list_default_vocabularies(params = {}, = {}) req = build_request(:list_default_vocabularies, params) req.send_request() end |
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9022 9023 9024 9025 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9022 def list_evaluation_form_versions(params = {}, = {}) req = build_request(:list_evaluation_form_versions, params) req.send_request() end |
#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse
Lists evaluation forms in the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9080 9081 9082 9083 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9080 def list_evaluation_forms(params = {}, = {}) req = build_request(:list_evaluation_forms, params) req.send_request() end |
#list_flow_associations(params = {}) ⇒ Types::ListFlowAssociationsResponse
List the flow association based on the filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9134 9135 9136 9137 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9134 def list_flow_associations(params = {}, = {}) req = build_request(:list_flow_associations, params) req.send_request() end |
#list_hours_of_operations(params = {}) ⇒ Types::ListHoursOfOperationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9195 9196 9197 9198 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9195 def list_hours_of_operations(params = {}, = {}) req = build_request(:list_hours_of_operations, params) req.send_request() end |
#list_instance_attributes(params = {}) ⇒ Types::ListInstanceAttributesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9248 9249 9250 9251 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9248 def list_instance_attributes(params = {}, = {}) req = build_request(:list_instance_attributes, params) req.send_request() end |
#list_instance_storage_configs(params = {}) ⇒ Types::ListInstanceStorageConfigsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9315 9316 9317 9318 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9315 def list_instance_storage_configs(params = {}, = {}) req = build_request(:list_instance_storage_configs, params) req.send_request() end |
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9369 9370 9371 9372 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9369 def list_instances(params = {}, = {}) req = build_request(:list_instances, params) req.send_request() end |
#list_integration_associations(params = {}) ⇒ Types::ListIntegrationAssociationsResponse
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9433 9434 9435 9436 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9433 def list_integration_associations(params = {}, = {}) req = build_request(:list_integration_associations, params) req.send_request() end |
#list_lambda_functions(params = {}) ⇒ Types::ListLambdaFunctionsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9485 9486 9487 9488 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9485 def list_lambda_functions(params = {}, = {}) req = build_request(:list_lambda_functions, params) req.send_request() end |
#list_lex_bots(params = {}) ⇒ Types::ListLexBotsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9544 9545 9546 9547 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9544 def list_lex_bots(params = {}, = {}) req = build_request(:list_lex_bots, params) req.send_request() end |
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
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.
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types
UIFN
,SHARED
,THIRD_PARTY_TF
, andTHIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them asTOLL_FREE
orDID
.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 aResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9639 9640 9641 9642 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9639 def list_phone_numbers(params = {}, = {}) req = build_request(:list_phone_numbers, params) req.send_request() end |
#list_phone_numbers_v2(params = {}) ⇒ Types::ListPhoneNumbersV2Response
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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9741 9742 9743 9744 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9741 def list_phone_numbers_v2(params = {}, = {}) req = build_request(:list_phone_numbers_v2, params) req.send_request() end |
#list_predefined_attributes(params = {}) ⇒ Types::ListPredefinedAttributesResponse
Lists predefined attributes for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9787 9788 9789 9790 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9787 def list_predefined_attributes(params = {}, = {}) req = build_request(:list_predefined_attributes, params) req.send_request() end |
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Provides information about the prompts for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9836 9837 9838 9839 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9836 def list_prompts(params = {}, = {}) req = build_request(:list_prompts, params) req.send_request() end |
#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9901 9902 9903 9904 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9901 def list_queue_quick_connects(params = {}, = {}) req = build_request(:list_queue_quick_connects, params) req.send_request() end |
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9972 9973 9974 9975 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9972 def list_queues(params = {}, = {}) req = build_request(:list_queues, params) req.send_request() end |
#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse
Provides information about the quick connects for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10034 10035 10036 10037 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10034 def list_quick_connects(params = {}, = {}) req = build_request(:list_quick_connects, params) req.send_request() end |
#list_realtime_contact_analysis_segments_v2(params = {}) ⇒ Types::ListRealtimeContactAnalysisSegmentsV2Response
Provides a list of analysis segments for a real-time analysis session.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10139 10140 10141 10142 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10139 def list_realtime_contact_analysis_segments_v2(params = {}, = {}) req = build_request(:list_realtime_contact_analysis_segments_v2, params) req.send_request() end |
#list_routing_profile_queues(params = {}) ⇒ Types::ListRoutingProfileQueuesResponse
Lists the queues associated with a routing profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10201 10202 10203 10204 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10201 def list_routing_profile_queues(params = {}, = {}) req = build_request(:list_routing_profile_queues, params) req.send_request() end |
#list_routing_profiles(params = {}) ⇒ Types::ListRoutingProfilesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10264 10265 10266 10267 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10264 def list_routing_profiles(params = {}, = {}) req = build_request(:list_routing_profiles, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
List all rules for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10328 10329 10330 10331 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10328 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10382 10383 10384 10385 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10382 def list_security_keys(params = {}, = {}) req = build_request(:list_security_keys, params) req.send_request() end |
#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse
Returns a list of third-party applications in a specific security profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10441 10442 10443 10444 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10441 def list_security_profile_applications(params = {}, = {}) req = build_request(:list_security_profile_applications, params) req.send_request() end |
#list_security_profile_permissions(params = {}) ⇒ Types::ListSecurityProfilePermissionsResponse
Lists the permissions granted to a security profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10497 10498 10499 10500 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10497 def (params = {}, = {}) req = build_request(:list_security_profile_permissions, params) req.send_request() end |
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10558 10559 10560 10561 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10558 def list_security_profiles(params = {}, = {}) req = build_request(:list_security_profiles, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
10601 10602 10603 10604 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10601 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_task_templates(params = {}) ⇒ Types::ListTaskTemplatesResponse
Lists task templates for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10671 10672 10673 10674 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10671 def list_task_templates(params = {}, = {}) req = build_request(:list_task_templates, params) req.send_request() end |
#list_traffic_distribution_group_users(params = {}) ⇒ Types::ListTrafficDistributionGroupUsersResponse
Lists traffic distribution group users.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10717 10718 10719 10720 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10717 def list_traffic_distribution_group_users(params = {}, = {}) req = build_request(:list_traffic_distribution_group_users, params) req.send_request() end |
#list_traffic_distribution_groups(params = {}) ⇒ Types::ListTrafficDistributionGroupsResponse
Lists traffic distribution groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10770 10771 10772 10773 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10770 def list_traffic_distribution_groups(params = {}, = {}) req = build_request(:list_traffic_distribution_groups, params) req.send_request() end |
#list_use_cases(params = {}) ⇒ Types::ListUseCasesResponse
Lists the use cases for the integration association.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10824 10825 10826 10827 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10824 def list_use_cases(params = {}, = {}) req = build_request(:list_use_cases, params) req.send_request() end |
#list_user_hierarchy_groups(params = {}) ⇒ Types::ListUserHierarchyGroupsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10885 10886 10887 10888 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10885 def list_user_hierarchy_groups(params = {}, = {}) req = build_request(:list_user_hierarchy_groups, params) req.send_request() end |
#list_user_proficiencies(params = {}) ⇒ Types::ListUserProficienciesResponse
Lists proficiencies associated with a user.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10939 10940 10941 10942 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10939 def list_user_proficiencies(params = {}, = {}) req = build_request(:list_user_proficiencies, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Provides summary information about the users for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10993 10994 10995 10996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10993 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_view_versions(params = {}) ⇒ Types::ListViewVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11051 11052 11053 11054 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11051 def list_view_versions(params = {}, = {}) req = build_request(:list_view_versions, params) req.send_request() end |
#list_views(params = {}) ⇒ Types::ListViewsResponse
Returns views in the given instance.
Results are sorted primarily by type, and secondarily by name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11107 11108 11109 11110 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11107 def list_views(params = {}, = {}) req = build_request(:list_views, params) req.send_request() end |
#monitor_contact(params = {}) ⇒ Types::MonitorContactResponse
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.
11169 11170 11171 11172 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11169 def monitor_contact(params = {}, = {}) req = build_request(:monitor_contact, params) req.send_request() end |
#pause_contact(params = {}) ⇒ Struct
Allows pausing an ongoing task contact.
11200 11201 11202 11203 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11200 def pause_contact(params = {}, = {}) req = build_request(:pause_contact, params) req.send_request() end |
#put_user_status(params = {}) ⇒ Struct
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.
11245 11246 11247 11248 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11245 def put_user_status(params = {}, = {}) req = build_request(:put_user_status, params) req.send_request() end |
#release_phone_number(params = {}) ⇒ Struct
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the
ReleasePhoneNumber
API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 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 during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 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 30 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.
11309 11310 11311 11312 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11309 def release_phone_number(params = {}, = {}) req = build_request(:release_phone_number, params) req.send_request() end |
#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse
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.
11379 11380 11381 11382 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11379 def replicate_instance(params = {}, = {}) req = build_request(:replicate_instance, params) req.send_request() end |
#resume_contact(params = {}) ⇒ Struct
Allows resuming a task contact in a paused state.
11410 11411 11412 11413 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11410 def resume_contact(params = {}, = {}) req = build_request(:resume_contact, params) req.send_request() end |
#resume_contact_recording(params = {}) ⇒ Struct
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.
11452 11453 11454 11455 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11452 def resume_contact_recording(params = {}, = {}) req = build_request(:resume_contact_recording, params) req.send_request() end |
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11527 11528 11529 11530 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11527 def search_available_phone_numbers(params = {}, = {}) req = build_request(:search_available_phone_numbers, params) req.send_request() end |
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11637 11638 11639 11640 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11637 def search_contacts(params = {}, = {}) req = build_request(:search_contacts, params) req.send_request() end |
#search_hours_of_operations(params = {}) ⇒ Types::SearchHoursOfOperationsResponse
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11747 11748 11749 11750 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11747 def search_hours_of_operations(params = {}, = {}) req = build_request(:search_hours_of_operations, params) req.send_request() end |
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Predefined attributes that meet certain criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11817 11818 11819 11820 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11817 def search_predefined_attributes(params = {}, = {}) req = build_request(:search_predefined_attributes, params) req.send_request() end |
#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse
Searches prompts in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11920 11921 11922 11923 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11920 def search_prompts(params = {}, = {}) req = build_request(:search_prompts, params) req.send_request() end |
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12037 12038 12039 12040 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12037 def search_queues(params = {}, = {}) req = build_request(:search_queues, params) req.send_request() end |
#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse
Searches quick connects in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12146 12147 12148 12149 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12146 def search_quick_connects(params = {}, = {}) req = build_request(:search_quick_connects, params) req.send_request() end |
#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse
Searches tags used in an Amazon Connect instance using optional search criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12209 12210 12211 12212 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12209 def (params = {}, = {}) req = build_request(:search_resource_tags, params) req.send_request() end |
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12329 12330 12331 12332 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12329 def search_routing_profiles(params = {}, = {}) req = build_request(:search_routing_profiles, params) req.send_request() end |
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12441 12442 12443 12444 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12441 def search_security_profiles(params = {}, = {}) req = build_request(:search_security_profiles, params) req.send_request() end |
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12607 12608 12609 12610 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12607 def search_users(params = {}, = {}) req = build_request(:search_users, params) req.send_request() end |
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Amazon Connect instance
using State
, NameStartsWith
, and LanguageCode
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12680 12681 12682 12683 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12680 def search_vocabularies(params = {}, = {}) req = build_request(:search_vocabularies, params) req.send_request() end |
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
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 Pinpoint for supporting SMS integration.
12764 12765 12766 12767 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12764 def send_chat_integration_event(params = {}, = {}) req = build_request(:send_chat_integration_event, params) req.send_request() end |
#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a
TooManyRequests
exception.The quota for concurrent active chats is exceeded. Active chat throttling returns a
LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400
error, your account may not support the ability to configure custom
chat durations. For more information, contact Amazon Web Services
Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
12961 12962 12963 12964 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12961 def start_chat_contact(params = {}, = {}) req = build_request(:start_chat_contact, params) req.send_request() end |
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
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.
13027 13028 13029 13030 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13027 def start_contact_evaluation(params = {}, = {}) req = build_request(:start_contact_evaluation, params) req.send_request() end |
#start_contact_recording(params = {}) ⇒ Struct
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.
13091 13092 13093 13094 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13091 def start_contact_recording(params = {}, = {}) req = build_request(:start_contact_recording, params) req.send_request() end |
#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse
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.
13158 13159 13160 13161 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13158 def start_contact_streaming(params = {}, = {}) req = build_request(:start_contact_streaming, params) req.send_request() end |
#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse
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.
TrafficType
= CAMPAIGN
, you must submit a service quota
increase request to the quota Amazon Connect campaigns.
13326 13327 13328 13329 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13326 def start_outbound_voice_contact(params = {}, = {}) req = build_request(:start_outbound_voice_contact, params) req.send_request() end |
#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse
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.
13511 13512 13513 13514 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13511 def start_task_contact(params = {}, = {}) req = build_request(:start_task_contact, params) req.send_request() end |
#start_web_rtc_contact(params = {}) ⇒ Types::StartWebRTCContactResponse
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).
13642 13643 13644 13645 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13642 def start_web_rtc_contact(params = {}, = {}) req = build_request(:start_web_rtc_contact, params) req.send_request() end |
#stop_contact(params = {}) ⇒ Struct
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
Chat and task contacts can be terminated in any state, regardless of initiation method.
13691 13692 13693 13694 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13691 def stop_contact(params = {}, = {}) req = build_request(:stop_contact, params) req.send_request() end |
#stop_contact_recording(params = {}) ⇒ Struct
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.
13735 13736 13737 13738 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13735 def stop_contact_recording(params = {}, = {}) req = build_request(:stop_contact_recording, params) req.send_request() end |
#stop_contact_streaming(params = {}) ⇒ Struct
Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
13776 13777 13778 13779 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13776 def stop_contact_streaming(params = {}, = {}) req = build_request(:stop_contact_streaming, params) req.send_request() end |
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
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.
13843 13844 13845 13846 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13843 def submit_contact_evaluation(params = {}, = {}) req = build_request(:submit_contact_evaluation, params) req.send_request() end |
#suspend_contact_recording(params = {}) ⇒ Struct
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, 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 and screen recordings are supported.
13889 13890 13891 13892 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13889 def suspend_contact_recording(params = {}, = {}) req = build_request(:suspend_contact_recording, params) req.send_request() end |
#tag_contact(params = {}) ⇒ Struct
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.
13937 13938 13939 13940 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13937 def tag_contact(params = {}, = {}) req = build_request(:tag_contact, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
13980 13981 13982 13983 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13980 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#transfer_contact(params = {}) ⇒ Types::TransferContactResponse
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only
TASK
contacts.Do not use both
QueueId
andUserId
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.
14064 14065 14066 14067 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14064 def transfer_contact(params = {}, = {}) req = build_request(:transfer_contact, params) req.send_request() end |
#untag_contact(params = {}) ⇒ Struct
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.
14106 14107 14108 14109 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14106 def untag_contact(params = {}, = {}) req = build_request(:untag_contact, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
14132 14133 14134 14135 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14132 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
14186 14187 14188 14189 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14186 def update_agent_status(params = {}, = {}) req = build_request(:update_agent_status, params) req.send_request() end |
#update_contact(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
14244 14245 14246 14247 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14244 def update_contact(params = {}, = {}) req = build_request(:update_contact, params) req.send_request() end |
#update_contact_attributes(params = {}) ⇒ Struct
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.
14308 14309 14310 14311 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14308 def update_contact_attributes(params = {}, = {}) req = build_request(:update_contact_attributes, params) req.send_request() end |
#update_contact_evaluation(params = {}) ⇒ Types::UpdateContactEvaluationResponse
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.
14371 14372 14373 14374 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14371 def update_contact_evaluation(params = {}, = {}) req = build_request(:update_contact_evaluation, params) req.send_request() end |
#update_contact_flow_content(params = {}) ⇒ Struct
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
14415 14416 14417 14418 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14415 def update_contact_flow_content(params = {}, = {}) req = build_request(:update_contact_flow_content, params) req.send_request() end |
#update_contact_flow_metadata(params = {}) ⇒ Struct
Updates metadata about specified flow.
14458 14459 14460 14461 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14458 def (params = {}, = {}) req = build_request(:update_contact_flow_metadata, params) req.send_request() end |
#update_contact_flow_module_content(params = {}) ⇒ Struct
Updates specified flow module for the specified Amazon Connect instance.
14499 14500 14501 14502 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14499 def update_contact_flow_module_content(params = {}, = {}) req = build_request(:update_contact_flow_module_content, params) req.send_request() end |
#update_contact_flow_module_metadata(params = {}) ⇒ Struct
Updates metadata about specified flow module.
14542 14543 14544 14545 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14542 def (params = {}, = {}) req = build_request(:update_contact_flow_module_metadata, params) req.send_request() end |
#update_contact_flow_name(params = {}) ⇒ Struct
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
14583 14584 14585 14586 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14583 def update_contact_flow_name(params = {}, = {}) req = build_request(:update_contact_flow_name, params) req.send_request() end |
#update_contact_routing_data(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
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.
14645 14646 14647 14648 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14645 def update_contact_routing_data(params = {}, = {}) req = build_request(:update_contact_routing_data, params) req.send_request() end |
#update_contact_schedule(params = {}) ⇒ Struct
Updates the scheduled time of a task contact that is already scheduled.
14683 14684 14685 14686 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14683 def update_contact_schedule(params = {}, = {}) req = build_request(:update_contact_schedule, params) req.send_request() end |
#update_evaluation_form(params = {}) ⇒ Types::UpdateEvaluationFormResponse
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.
14834 14835 14836 14837 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14834 def update_evaluation_form(params = {}, = {}) req = build_request(:update_evaluation_form, params) req.send_request() end |
#update_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
14896 14897 14898 14899 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14896 def update_hours_of_operation(params = {}, = {}) req = build_request(:update_hours_of_operation, params) req.send_request() end |
#update_instance_attribute(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
14940 14941 14942 14943 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14940 def update_instance_attribute(params = {}, = {}) req = build_request(:update_instance_attribute, params) req.send_request() end |
#update_instance_storage_config(params = {}) ⇒ Struct
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.
15009 15010 15011 15012 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15009 def update_instance_storage_config(params = {}, = {}) req = build_request(:update_instance_storage_config, params) req.send_request() end |
#update_participant_role_config(params = {}) ⇒ Struct
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.
15074 15075 15076 15077 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15074 def update_participant_role_config(params = {}, = {}) req = build_request(:update_participant_role_config, params) req.send_request() end |
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse
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.
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.
15152 15153 15154 15155 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15152 def update_phone_number(params = {}, = {}) req = build_request(:update_phone_number, params) req.send_request() end |
#update_phone_number_metadata(params = {}) ⇒ Struct
Updates a phone number’s metadata.
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
15199 15200 15201 15202 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15199 def (params = {}, = {}) req = build_request(:update_phone_number_metadata, params) req.send_request() end |
#update_predefined_attribute(params = {}) ⇒ Struct
Updates a predefined attribute for the specified Amazon Connect instance.
15233 15234 15235 15236 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15233 def update_predefined_attribute(params = {}, = {}) req = build_request(:update_predefined_attribute, params) req.send_request() end |
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
15290 15291 15292 15293 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15290 def update_prompt(params = {}, = {}) req = build_request(:update_prompt, params) req.send_request() end |
#update_queue_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
15328 15329 15330 15331 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15328 def update_queue_hours_of_operation(params = {}, = {}) req = build_request(:update_queue_hours_of_operation, params) req.send_request() end |
#update_queue_max_contacts(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
15368 15369 15370 15371 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15368 def update_queue_max_contacts(params = {}, = {}) req = build_request(:update_queue_max_contacts, params) req.send_request() end |
#update_queue_name(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or
Description
must be provided.
15411 15412 15413 15414 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15411 def update_queue_name(params = {}, = {}) req = build_request(:update_queue_name, params) req.send_request() end |
#update_queue_outbound_caller_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the 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 aResourceNotFoundException
.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.
15481 15482 15483 15484 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15481 def update_queue_outbound_caller_config(params = {}, = {}) req = build_request(:update_queue_outbound_caller_config, params) req.send_request() end |
#update_queue_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
15519 15520 15521 15522 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15519 def update_queue_status(params = {}, = {}) req = build_request(:update_queue_status, params) req.send_request() end |
#update_quick_connect_config(params = {}) ⇒ Struct
Updates the configuration settings for the specified quick connect.
15567 15568 15569 15570 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15567 def update_quick_connect_config(params = {}, = {}) req = build_request(:update_quick_connect_config, params) req.send_request() end |
#update_quick_connect_name(params = {}) ⇒ Struct
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.
15608 15609 15610 15611 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15608 def update_quick_connect_name(params = {}, = {}) req = build_request(:update_quick_connect_name, params) req.send_request() end |
#update_routing_profile_agent_availability_timer(params = {}) ⇒ Struct
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
15647 15648 15649 15650 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15647 def update_routing_profile_agent_availability_timer(params = {}, = {}) req = build_request(:update_routing_profile_agent_availability_timer, params) req.send_request() end |
#update_routing_profile_concurrency(params = {}) ⇒ Struct
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
15692 15693 15694 15695 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15692 def update_routing_profile_concurrency(params = {}, = {}) req = build_request(:update_routing_profile_concurrency, params) req.send_request() end |
#update_routing_profile_default_outbound_queue(params = {}) ⇒ Struct
Updates the default outbound queue of a routing profile.
15727 15728 15729 15730 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15727 def update_routing_profile_default_outbound_queue(params = {}, = {}) req = build_request(:update_routing_profile_default_outbound_queue, params) req.send_request() end |
#update_routing_profile_name(params = {}) ⇒ Struct
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.
15769 15770 15771 15772 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15769 def update_routing_profile_name(params = {}, = {}) req = build_request(:update_routing_profile_name, params) req.send_request() end |
#update_routing_profile_queues(params = {}) ⇒ Struct
Updates the properties associated with a set of queues for a routing profile.
15816 15817 15818 15819 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15816 def update_routing_profile_queues(params = {}, = {}) req = build_request(:update_routing_profile_queues, params) req.send_request() end |
#update_rule(params = {}) ⇒ Struct
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
15935 15936 15937 15938 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15935 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |
#update_security_profile(params = {}) ⇒ Struct
Updates a security profile.
16014 16015 16016 16017 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16014 def update_security_profile(params = {}, = {}) req = build_request(:update_security_profile, params) req.send_request() end |
#update_task_template(params = {}) ⇒ Types::UpdateTaskTemplateResponse
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.
16160 16161 16162 16163 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16160 def update_task_template(params = {}, = {}) req = build_request(:update_task_template, params) req.send_request() end |
#update_traffic_distribution(params = {}) ⇒ Struct
Updates the traffic distribution for a given traffic distribution group.
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.
16239 16240 16241 16242 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16239 def update_traffic_distribution(params = {}, = {}) req = build_request(:update_traffic_distribution, params) req.send_request() end |
#update_user_hierarchy(params = {}) ⇒ Struct
Assigns the specified hierarchy group to the specified user.
16274 16275 16276 16277 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16274 def update_user_hierarchy(params = {}, = {}) req = build_request(:update_user_hierarchy, params) req.send_request() end |
#update_user_hierarchy_group_name(params = {}) ⇒ Struct
Updates the name of the user hierarchy group.
16309 16310 16311 16312 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16309 def update_user_hierarchy_group_name(params = {}, = {}) req = build_request(:update_user_hierarchy_group_name, params) req.send_request() end |
#update_user_hierarchy_structure(params = {}) ⇒ Struct
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
16357 16358 16359 16360 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16357 def update_user_hierarchy_structure(params = {}, = {}) req = build_request(:update_user_hierarchy_structure, params) req.send_request() end |
#update_user_identity_info(params = {}) ⇒ Struct
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke
UpdateUserIdentityInfo
. Someone with that ability can change the
login credentials of other users by changing their email address. This
poses a security risk to your organization. They can change the email
address of a user to the attacker's email address, and then reset the
password through email. For more information, see Best Practices for
Security Profiles in the Amazon Connect Administrator Guide.
16410 16411 16412 16413 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16410 def update_user_identity_info(params = {}, = {}) req = build_request(:update_user_identity_info, params) req.send_request() end |
#update_user_phone_config(params = {}) ⇒ Struct
Updates the phone configuration settings for the specified user.
16450 16451 16452 16453 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16450 def update_user_phone_config(params = {}, = {}) req = build_request(:update_user_phone_config, params) req.send_request() end |
#update_user_proficiencies(params = {}) ⇒ Struct
Updates the properties associated with the proficiencies of a user.
16489 16490 16491 16492 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16489 def update_user_proficiencies(params = {}, = {}) req = build_request(:update_user_proficiencies, params) req.send_request() end |
#update_user_routing_profile(params = {}) ⇒ Struct
Assigns the specified routing profile to the specified user.
16524 16525 16526 16527 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16524 def update_user_routing_profile(params = {}, = {}) req = build_request(:update_user_routing_profile, params) req.send_request() end |
#update_user_security_profiles(params = {}) ⇒ Struct
Assigns the specified security profiles to the specified user.
16559 16560 16561 16562 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16559 def update_user_security_profiles(params = {}, = {}) req = build_request(:update_user_security_profiles, params) req.send_request() end |
#update_view_content(params = {}) ⇒ Types::UpdateViewContentResponse
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
.
16630 16631 16632 16633 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16630 def update_view_content(params = {}, = {}) req = build_request(:update_view_content, params) req.send_request() end |
#update_view_metadata(params = {}) ⇒ Struct
Updates the view metadata. Note that either Name
or Description
must be provided.
16666 16667 16668 16669 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16666 def (params = {}, = {}) req = build_request(:update_view_metadata, params) req.send_request() end |