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
Associates the specified dataset for a Amazon Connect instance with the target account.
-
#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_contact_with_user(params = {}) ⇒ Struct
Associates a queued contact with an agent.
-
#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
Associates a set of quick connects with a queue.
-
#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
Associates a list of analytics datasets for a given Amazon Connect instance to a target account.
-
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
Removes a list of analytics datasets associated with a given Amazon Connect instance.
-
#batch_get_attached_file_metadata(params = {}) ⇒ Types::BatchGetAttachedFileMetadataResponse
Allows you to retrieve metadata about multiple attached files on an associated resource.
-
#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.
-
#complete_attached_file_upload(params = {}) ⇒ Struct
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
-
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
Creates an agent status for the specified Amazon Connect instance.
-
#create_contact(params = {}) ⇒ Types::CreateContactResponse
Only the VOICE, EMAIL, and TASK channels are supported.
-
#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_contact_flow_version(params = {}) ⇒ Types::CreateContactFlowVersionResponse
Publishes a new version of the flow provided.
-
#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse
Create new email address in 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
Creates hours of operation.
-
#create_hours_of_operation_override(params = {}) ⇒ Types::CreateHoursOfOperationOverrideResponse
Creates an hours of operation override in an Amazon Connect hours of operation resource.
-
#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 or webRTC call.
-
#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_push_notification_registration(params = {}) ⇒ Types::CreatePushNotificationRegistrationResponse
Creates registration for a device token and a chat contact to receive real-time push notifications.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
Creates a new queue for the specified Amazon Connect instance.
-
#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_attached_file(params = {}) ⇒ Struct
Deletes an attached file along with the underlying S3 Object.
-
#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_contact_flow_version(params = {}) ⇒ Struct
Deletes the particular version specified in flow version identifier.
-
#delete_email_address(params = {}) ⇒ Struct
Deletes email address from the specified Amazon Connect instance.
-
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Amazon Connect instance.
-
#delete_hours_of_operation(params = {}) ⇒ Struct
Deletes an hours of operation.
-
#delete_hours_of_operation_override(params = {}) ⇒ Struct
Deletes an hours of operation override in an Amazon Connect hours of operation resource.
-
#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_push_notification_registration(params = {}) ⇒ Struct
Deletes registration for a device token and a chat contact.
-
#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
Describes an agent status.
-
#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse
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_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse
Describe email address form the specified Amazon Connect instance.
-
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Amazon Connect instance.
-
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
Describes the hours of operation.
-
#describe_hours_of_operation_override(params = {}) ⇒ Types::DescribeHoursOfOperationOverrideResponse
Describes the hours of operation override.
-
#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
Describes the specified queue.
-
#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 profile.
-
#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
Removes the dataset ID associated with a given Amazon Connect instance.
-
#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
Disassociates a set of quick connects from a queue.
-
#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_attached_file(params = {}) ⇒ Types::GetAttachedFileResponse
Provides a pre-signed URL for download of an approved attached file.
-
#get_contact_attributes(params = {}) ⇒ Types::GetContactAttributesResponse
Retrieves the contact attributes for the specified contact.
-
#get_contact_metrics(params = {}) ⇒ Types::GetContactMetricsResponse
Retrieves the position of the contact in the queue.
-
#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_effective_hours_of_operations(params = {}) ⇒ Types::GetEffectiveHoursOfOperationsResponse
Get the hours of operations with the effective override applied.
-
#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 Web Services End User Messaging, into an Amazon Connect instance.
-
#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse
Lists agent statuses.
-
#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse
Lists the association status of requested dataset ID for a given Amazon Connect instance.
-
#list_analytics_data_lake_data_sets(params = {}) ⇒ Types::ListAnalyticsDataLakeDataSetsResponse
Lists the data lake datasets available to associate with for a given Amazon Connect instance.
-
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_associated_contacts(params = {}) ⇒ Types::ListAssociatedContactsResponse
Provides information about contact tree, a list of associated contacts with a unique identifier.
-
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
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_flow_versions(params = {}) ⇒ Types::ListContactFlowVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
-
#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_operation_overrides(params = {}) ⇒ Types::ListHoursOfOperationOverridesResponse
List the hours of operation overrides.
-
#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
Lists the quick connects associated with a queue.
-
#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 chat analysis session.
-
#list_routing_profile_manual_assignment_queues(params = {}) ⇒ Types::ListRoutingProfileManualAssignmentQueuesResponse
Lists the manual assignment queues associated with a routing profile.
-
#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_agent_statuses(params = {}) ⇒ Types::SearchAgentStatusesResponse
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
-
#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_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse
Searches the flow modules in an Amazon Connect instance, with optional filtering.
-
#search_contact_flows(params = {}) ⇒ Types::SearchContactFlowsResponse
Searches the flows in an Amazon Connect instance, with optional filtering.
-
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Amazon Connect instance.
-
#search_email_addresses(params = {}) ⇒ Types::SearchEmailAddressesResponse
Searches email address in an instance, with optional filtering.
-
#search_hours_of_operation_overrides(params = {}) ⇒ Types::SearchHoursOfOperationOverridesResponse
Searches the hours of operation overrides.
-
#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
Searches 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_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups 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.
-
#send_outbound_email(params = {}) ⇒ Struct
Send outbound email for outbound campaigns.
-
#start_attached_file_upload(params = {}) ⇒ Types::StartAttachedFileUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading your content.
-
#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_email_contact(params = {}) ⇒ Types::StartEmailContactResponse
Creates an inbound email contact and initiates a flow to start the email contact for the customer.
-
#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse
Initiates a new outbound SMS contact to a customer.
-
#start_outbound_email_contact(params = {}) ⇒ Types::StartOutboundEmailContactResponse
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
-
#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse
Places an outbound call to a contact, and then initiates the flow.
-
#start_screen_sharing(params = {}) ⇒ Struct
Starts screen sharing for a contact.
-
#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 (IVR or agent), 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
TASK
orEMAIL
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
Updates agent status.
-
#update_authentication_profile(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
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).
-
#update_contact_schedule(params = {}) ⇒ Struct
Updates the scheduled time of a task contact that is already scheduled.
-
#update_email_address_metadata(params = {}) ⇒ Types::UpdateEmailAddressMetadataResponse
Updates an email address metadata.
-
#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
Updates the hours of operation.
-
#update_hours_of_operation_override(params = {}) ⇒ Struct
Update the hours of operation override.
-
#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_authentication(params = {}) ⇒ Struct
Instructs Amazon Connect to resume the authentication process.
-
#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
Updates the hours of operation for the specified queue.
-
#update_queue_max_contacts(params = {}) ⇒ Struct
Updates the maximum number of contacts allowed in a queue before it is considered full.
-
#update_queue_name(params = {}) ⇒ Struct
Updates the name and description of a queue.
-
#update_queue_outbound_caller_config(params = {}) ⇒ Struct
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
-
#update_queue_outbound_email_config(params = {}) ⇒ Struct
Updates the outbound email address Id for a specified queue.
-
#update_queue_status(params = {}) ⇒ Struct
Updates the status of the queue.
-
#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.
473 474 475 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 473 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.
523 524 525 526 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 523 def activate_evaluation_form(params = {}, = {}) req = build_request(:activate_evaluation_form, params) req.send_request() end |
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
575 576 577 578 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 575 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.
623 624 625 626 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 623 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.
681 682 683 684 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 681 def associate_bot(params = {}, = {}) req = build_request(:associate_bot, params) req.send_request() end |
#associate_contact_with_user(params = {}) ⇒ Struct
Associates a queued contact with an agent.
Use cases
Following are common uses cases for this API:
Custom contact routing. You can build custom contact routing mechanisms beyond the default system routing in Amazon Connect. You can create tailored contact distribution logic that offers queued contacts directly to specific agents.
Manual contact assignment. You can programmatically assign queued contacts to available users. This provides flexibility to contact centers that require manual oversight or specialized routing workflows outside of standard queue management.
For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide.
Important things to know
Use this API chat/SMS, email, and task contacts. It does not support voice contacts.
Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.
It honors the IAM context key
connect:PreferredUserArn
to prevent unauthorized contact associations.It respects the IAM context key
connect:PreferredUserArn
to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.
Endpoints: See Amazon Connect endpoints and quotas.
760 761 762 763 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 760 def associate_contact_with_user(params = {}, = {}) req = build_request(:associate_contact_with_user, 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.
804 805 806 807 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 804 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.
849 850 851 852 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 849 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.
960 961 962 963 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 960 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.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1010 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.
1063 1064 1065 1066 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1063 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
.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1110 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
Associates a set of quick connects with a queue.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1145 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.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1200 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.
1254 1255 1256 1257 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1254 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. This API can be called only in the Region where the traffic distribution group is created.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1293 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.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1330 def associate_user_proficiencies(params = {}, = {}) req = build_request(:associate_user_proficiencies, params) req.send_request() end |
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
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.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1385 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
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1436 def batch_disassociate_analytics_data_set(params = {}, = {}) req = build_request(:batch_disassociate_analytics_data_set, params) req.send_request() end |
#batch_get_attached_file_metadata(params = {}) ⇒ Types::BatchGetAttachedFileMetadataResponse
Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
1501 1502 1503 1504 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1501 def (params = {}, = {}) req = build_request(:batch_get_attached_file_metadata, params) req.send_request() end |
#batch_get_flow_association(params = {}) ⇒ Types::BatchGetFlowAssociationResponse
Retrieve the flow associations for the given resources.
1551 1552 1553 1554 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1551 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.
1643 1644 1645 1646 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1643 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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1758 def claim_phone_number(params = {}, = {}) req = build_request(:claim_phone_number, params) req.send_request() end |
#complete_attached_file_upload(params = {}) ⇒ Struct
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
1799 1800 1801 1802 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1799 def complete_attached_file_upload(params = {}, = {}) req = build_request(:complete_attached_file_upload, params) req.send_request() end |
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
Creates an agent status for the specified Amazon Connect instance.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1858 def create_agent_status(params = {}, = {}) req = build_request(:create_agent_status, params) req.send_request() end |
#create_contact(params = {}) ⇒ Types::CreateContactResponse
Only the VOICE, EMAIL, and TASK channels are supported.
For VOICE: The supported initiation method is
TRANSFER
. The contacts created with this initiation method have a subtypeconnect:ExternalAudio
.For EMAIL: The supported initiation methods are
OUTBOUND
,AGENT_REPLY
, andFLOW
.For TASK: The supported initiation method is
API
. Contacts created with this API have a sub-type ofconnect:ExternalTask
.
Creates a new VOICE, EMAIL, or TASK contact.
After a contact is created, you can move it to the desired state by
using the InitiateAs
parameter. While you can use API to create task
contacts that are in the COMPLETED
state, you must contact Amazon
Web Services Support before using it for bulk import use cases. Bulk
import causes your requests to be throttled or fail if your
CreateContact limits aren't high enough.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2051 def create_contact(params = {}, = {}) req = build_request(:create_contact, 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.
2133 2134 2135 2136 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2133 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.
2207 2208 2209 2210 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2207 def create_contact_flow_module(params = {}, = {}) req = build_request(:create_contact_flow_module, params) req.send_request() end |
#create_contact_flow_version(params = {}) ⇒ Types::CreateContactFlowVersionResponse
Publishes a new version of the flow provided. Versions are immutable
and monotonically increasing. If the FlowContentSha256
provided is
different from the FlowContentSha256
of the $LATEST
published flow
content, then an error is returned. This API only supports creating
versions for flows of type Campaign
.
2265 2266 2267 2268 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2265 def create_contact_flow_version(params = {}, = {}) req = build_request(:create_contact_flow_version, params) req.send_request() end |
#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse
Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
2337 2338 2339 2340 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2337 def create_email_address(params = {}, = {}) req = build_request(:create_email_address, 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.
2472 2473 2474 2475 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2472 def create_evaluation_form(params = {}, = {}) req = build_request(:create_evaluation_form, params) req.send_request() end |
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
Creates hours of operation.
2544 2545 2546 2547 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2544 def create_hours_of_operation(params = {}, = {}) req = build_request(:create_hours_of_operation, params) req.send_request() end |
#create_hours_of_operation_override(params = {}) ⇒ Types::CreateHoursOfOperationOverrideResponse
Creates an hours of operation override in an Amazon Connect hours of operation resource.
2610 2611 2612 2613 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2610 def create_hours_of_operation_override(params = {}, = {}) req = build_request(:create_hours_of_operation_override, 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.
For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
2690 2691 2692 2693 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2690 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.
2763 2764 2765 2766 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2763 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 or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.
2843 2844 2845 2846 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2843 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.
2965 2966 2967 2968 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2965 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. A predefined attribute is made up of a name and a value.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Use cases
Following are common uses cases for this API:
Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.
Endpoints: See Amazon Connect endpoints and quotas.
3040 3041 3042 3043 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3040 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 Guide.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3107 def create_prompt(params = {}, = {}) req = build_request(:create_prompt, params) req.send_request() end |
#create_push_notification_registration(params = {}) ⇒ Types::CreatePushNotificationRegistrationResponse
Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.
3181 3182 3183 3184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3181 def create_push_notification_registration(params = {}, = {}) req = build_request(:create_push_notification_registration, params) req.send_request() end |
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
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.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3286 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.
3354 3355 3356 3357 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3354 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.
3471 3472 3473 3474 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3471 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.
3636 3637 3638 3639 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3636 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
3745 3746 3747 3748 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3745 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.
3872 3873 3874 3875 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3872 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.
3952 3953 3954 3955 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3952 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.
4004 4005 4006 4007 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4004 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
, 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.
4128 4129 4130 4131 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4128 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.
4181 4182 4183 4184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4181 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.
4272 4273 4274 4275 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4272 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.
4336 4337 4338 4339 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4336 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.
4427 4428 4429 4430 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4427 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.
4475 4476 4477 4478 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4475 def deactivate_evaluation_form(params = {}, = {}) req = build_request(:deactivate_evaluation_form, params) req.send_request() end |
#delete_attached_file(params = {}) ⇒ Struct
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
4517 4518 4519 4520 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4517 def delete_attached_file(params = {}, = {}) req = build_request(:delete_attached_file, params) req.send_request() end |
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Amazon Connect instance.
4548 4549 4550 4551 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4548 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.
4579 4580 4581 4582 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4579 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.
4610 4611 4612 4613 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4610 def delete_contact_flow_module(params = {}, = {}) req = build_request(:delete_contact_flow_module, params) req.send_request() end |
#delete_contact_flow_version(params = {}) ⇒ Struct
Deletes the particular version specified in flow version identifier.
4645 4646 4647 4648 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4645 def delete_contact_flow_version(params = {}, = {}) req = build_request(:delete_contact_flow_version, params) req.send_request() end |
#delete_email_address(params = {}) ⇒ Struct
Deletes email address from the specified Amazon Connect instance.
4676 4677 4678 4679 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4676 def delete_email_address(params = {}, = {}) req = build_request(:delete_email_address, 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.
4717 4718 4719 4720 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4717 def delete_evaluation_form(params = {}, = {}) req = build_request(:delete_evaluation_form, params) req.send_request() end |
#delete_hours_of_operation(params = {}) ⇒ Struct
Deletes an hours of operation.
4748 4749 4750 4751 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4748 def delete_hours_of_operation(params = {}, = {}) req = build_request(:delete_hours_of_operation, params) req.send_request() end |
#delete_hours_of_operation_override(params = {}) ⇒ Struct
Deletes an hours of operation override in an Amazon Connect hours of operation resource.
4779 4780 4781 4782 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4779 def delete_hours_of_operation_override(params = {}, = {}) req = build_request(:delete_hours_of_operation_override, 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. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
4836 4837 4838 4839 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4836 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.
4869 4870 4871 4872 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4869 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.
4897 4898 4899 4900 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4897 def delete_predefined_attribute(params = {}, = {}) req = build_request(:delete_predefined_attribute, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
4928 4929 4930 4931 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4928 def delete_prompt(params = {}, = {}) req = build_request(:delete_prompt, params) req.send_request() end |
#delete_push_notification_registration(params = {}) ⇒ Struct
Deletes registration for a device token and a chat contact.
4963 4964 4965 4966 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4963 def delete_push_notification_registration(params = {}, = {}) req = build_request(:delete_push_notification_registration, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
4994 4995 4996 4997 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4994 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.
5043 5044 5045 5046 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5043 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.
5074 5075 5076 5077 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5074 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.
5105 5106 5107 5108 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5105 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
5136 5137 5138 5139 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5136 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.
5167 5168 5169 5170 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5167 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.
5199 5200 5201 5202 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5199 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.
5234 5235 5236 5237 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5234 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.
5287 5288 5289 5290 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5287 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.
5319 5320 5321 5322 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5319 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).
5347 5348 5349 5350 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5347 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.
5378 5379 5380 5381 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5378 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.
5419 5420 5421 5422 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5419 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
Describes an agent status.
5466 5467 5468 5469 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5466 def describe_agent_status(params = {}, = {}) req = build_request(:describe_agent_status, params) req.send_request() end |
#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
5520 5521 5522 5523 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5520 def describe_authentication_profile(params = {}, = {}) req = build_request(:describe_authentication_profile, 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.
SystemEndpoint
is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACKContact information remains available in Amazon Connect for 24 months from the
InitiationTimestamp
, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
5727 5728 5729 5730 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5727 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.
5829 5830 5831 5832 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5829 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.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. After
a flow is published, $SAVED
needs to be supplied to view saved
content that has not been published.
Use arn:aws:.../contact-flow/{id}:{version}
to retrieve the content
of a specific flow version.
In the response, Status indicates the flow status as either
SAVED
or PUBLISHED
. The PUBLISHED
status will initiate
validation on the content. SAVED
does not initiate validation of the
content. SAVED
| PUBLISHED
5895 5896 5897 5898 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5895 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.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. After
a flow is published, $SAVED
needs to be supplied to view saved
content that has not been published.
5945 5946 5947 5948 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5945 def describe_contact_flow_module(params = {}, = {}) req = build_request(:describe_contact_flow_module, params) req.send_request() end |
#describe_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse
Describe email address form the specified Amazon Connect instance.
5997 5998 5999 6000 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5997 def describe_email_address(params = {}, = {}) req = build_request(:describe_email_address, 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.
6085 6086 6087 6088 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6085 def describe_evaluation_form(params = {}, = {}) req = build_request(:describe_evaluation_form, params) req.send_request() end |
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
Describes the hours of operation.
6136 6137 6138 6139 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6136 def describe_hours_of_operation(params = {}, = {}) req = build_request(:describe_hours_of_operation, params) req.send_request() end |
#describe_hours_of_operation_override(params = {}) ⇒ Types::DescribeHoursOfOperationOverrideResponse
Describes the hours of operation override.
6184 6185 6186 6187 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6184 def describe_hours_of_operation_override(params = {}, = {}) req = build_request(:describe_hours_of_operation_override, 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.
6246 6247 6248 6249 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6246 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.
6287 6288 6289 6290 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6287 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.
6344 6345 6346 6347 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6344 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
receive a ResourceNotFoundException
.
6395 6396 6397 6398 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6395 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. A predefined attribute is made up of a name and a value. You can use predefined attributes for:
Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Endpoints: See Amazon Connect endpoints and quotas.
6459 6460 6461 6462 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6459 def describe_predefined_attribute(params = {}, = {}) req = build_request(:describe_predefined_attribute, params) req.send_request() end |
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
6503 6504 6505 6506 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6503 def describe_prompt(params = {}, = {}) req = build_request(:describe_prompt, params) req.send_request() end |
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
Describes the specified queue.
6554 6555 6556 6557 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6554 def describe_queue(params = {}, = {}) req = build_request(:describe_queue, params) req.send_request() end |
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
6604 6605 6606 6607 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6604 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.
DescribeRoutingProfile
does not populate AssociatedQueueIds in its
response. The example Response Syntax shown on this page is incorrect;
we are working to update it. SearchRoutingProfiles does include
AssociatedQueueIds.
6674 6675 6676 6677 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6674 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.
6763 6764 6765 6766 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6763 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 profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
6825 6826 6827 6828 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6825 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.
6864 6865 6866 6867 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6864 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.
6929 6930 6931 6932 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6929 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.
6998 6999 7000 7001 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6998 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.
7056 7057 7058 7059 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7056 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.
7118 7119 7120 7121 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7118 def describe_view(params = {}, = {}) req = build_request(:describe_view, params) req.send_request() end |
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
7164 7165 7166 7167 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7164 def describe_vocabulary(params = {}, = {}) req = build_request(:describe_vocabulary, params) req.send_request() end |
#disassociate_analytics_data_set(params = {}) ⇒ Struct
Removes the dataset ID associated with a given Amazon Connect instance.
7203 7204 7205 7206 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7203 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.
7251 7252 7253 7254 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7251 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.
7309 7310 7311 7312 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7309 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.
7350 7351 7352 7353 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7350 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.
7404 7405 7406 7407 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7404 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.
7454 7455 7456 7457 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7454 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.
7508 7509 7510 7511 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7508 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
.
7551 7552 7553 7554 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7551 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
Disassociates a set of quick connects from a queue.
7586 7587 7588 7589 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7586 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.
Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.
7640 7641 7642 7643 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7640 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.
7689 7690 7691 7692 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7689 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. This API can be called only in the Region where the traffic distribution group is created.
7728 7729 7730 7731 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7728 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.
7764 7765 7766 7767 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7764 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.
7802 7803 7804 7805 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7802 def dismiss_user_contact(params = {}, = {}) req = build_request(:dismiss_user_contact, params) req.send_request() end |
#get_attached_file(params = {}) ⇒ Types::GetAttachedFileResponse
Provides a pre-signed URL for download of an approved attached file.
This API also returns metadata about the attached file. It will only
return a downloadURL if the status of the attached file is APPROVED
.
7878 7879 7880 7881 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7878 def get_attached_file(params = {}, = {}) req = build_request(:get_attached_file, params) req.send_request() end |
#get_contact_attributes(params = {}) ⇒ Types::GetContactAttributesResponse
Retrieves the contact attributes for the specified contact.
7911 7912 7913 7914 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7911 def get_contact_attributes(params = {}, = {}) req = build_request(:get_contact_attributes, params) req.send_request() end |
#get_contact_metrics(params = {}) ⇒ Types::GetContactMetricsResponse
Retrieves the position of the contact in the queue.
Use cases
Following are common uses cases for position in queue:
Understand the expected wait experience of a contact.
Inform customers of their position in queue and potentially offer a callback.
Make data-driven routing decisions between primary and alternative queues.
Enhance queue visibility and leverage agent proficiencies to streamline contact routing.
Important things to know
The only way to retrieve the position of the contact in queue is by using this API. You can't retrieve the position by using flows and attributes.
For more information, see the Position in queue metric in the Amazon Connect Administrator Guide.
Endpoints: See Amazon Connect endpoints and quotas.
7993 7994 7995 7996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7993 def get_contact_metrics(params = {}, = {}) req = build_request(:get_contact_metrics, 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 Metrics definitions in the Amazon Connect Administrator Guide.
Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data
Metric value is a number (including 0) of defined type: The number provided is the calculation result
MetricResult list is empty: The request cannot find any data in the system
The following guidelines can help you work with the API:
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:
- Add filters to reduce the amount of data returned
^
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8302 8303 8304 8305 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8302 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.
8415 8416 8417 8418 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8415 def get_current_user_data(params = {}, = {}) req = build_request(:get_current_user_data, params) req.send_request() end |
#get_effective_hours_of_operations(params = {}) ⇒ Types::GetEffectiveHoursOfOperationsResponse
Get the hours of operations with the effective override applied.
8463 8464 8465 8466 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8463 def get_effective_hours_of_operations(params = {}, = {}) req = build_request(:get_effective_hours_of_operations, 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
8524 8525 8526 8527 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8524 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.
8575 8576 8577 8578 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8575 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 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.
8967 8968 8969 8970 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8967 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. It does not support agent queues.
For a description of the historical metrics that are supported by
GetMetricDataV2
and GetMetricData
, see Metrics definitions in
the Amazon Connect Administrator Guide.
Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data
Metric value is a number (including 0) of defined type: The number provided is the calculation result
MetricResult list is empty: The request cannot find any data in the system
The following guidelines can help you work with the API:
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:
Narrow the time range of your request
Add filters to reduce the amount of data returned
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10849 10850 10851 10852 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10849 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.
10890 10891 10892 10893 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10890 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.
10972 10973 10974 10975 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10972 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.
11018 11019 11020 11021 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11018 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 Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber API to verify the status of a
previous ImportPhoneNumber
operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
11115 11116 11117 11118 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11115 def import_phone_number(params = {}, = {}) req = build_request(:import_phone_number, params) req.send_request() end |
#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse
Lists agent statuses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11172 11173 11174 11175 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11172 def list_agent_statuses(params = {}, = {}) req = build_request(:list_agent_statuses, params) req.send_request() end |
#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse
Lists the association status of requested dataset ID for a given Amazon Connect instance.
11227 11228 11229 11230 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11227 def list_analytics_data_associations(params = {}, = {}) req = build_request(:list_analytics_data_associations, params) req.send_request() end |
#list_analytics_data_lake_data_sets(params = {}) ⇒ Types::ListAnalyticsDataLakeDataSetsResponse
Lists the data lake datasets available to associate with for a given Amazon Connect instance.
11275 11276 11277 11278 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11275 def list_analytics_data_lake_data_sets(params = {}, = {}) req = build_request(:list_analytics_data_lake_data_sets, 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.
11327 11328 11329 11330 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11327 def list_approved_origins(params = {}, = {}) req = build_request(:list_approved_origins, params) req.send_request() end |
#list_associated_contacts(params = {}) ⇒ Types::ListAssociatedContactsResponse
Provides information about contact tree, a list of associated contacts with a unique identifier.
11386 11387 11388 11389 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11386 def list_associated_contacts(params = {}, = {}) req = build_request(:list_associated_contacts, params) req.send_request() end |
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11444 11445 11446 11447 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11444 def list_authentication_profiles(params = {}, = {}) req = build_request(:list_authentication_profiles, 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 return both Amazon Lex V1 and V2 bots.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11503 11504 11505 11506 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11503 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.
11564 11565 11566 11567 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11564 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.
11620 11621 11622 11623 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11620 def list_contact_flow_modules(params = {}, = {}) req = build_request(:list_contact_flow_modules, params) req.send_request() end |
#list_contact_flow_versions(params = {}) ⇒ Types::ListContactFlowVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11671 11672 11673 11674 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11671 def list_contact_flow_versions(params = {}, = {}) req = build_request(:list_contact_flow_versions, 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.
11741 11742 11743 11744 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11741 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.
11816 11817 11818 11819 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11816 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.
11878 11879 11880 11881 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11878 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.
11939 11940 11941 11942 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11939 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.
11997 11998 11999 12000 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11997 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.
12051 12052 12053 12054 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12051 def list_flow_associations(params = {}, = {}) req = build_request(:list_flow_associations, params) req.send_request() end |
#list_hours_of_operation_overrides(params = {}) ⇒ Types::ListHoursOfOperationOverridesResponse
List the hours of operation overrides.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12114 12115 12116 12117 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12114 def list_hours_of_operation_overrides(params = {}, = {}) req = build_request(:list_hours_of_operation_overrides, 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.
12175 12176 12177 12178 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12175 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.
12228 12229 12230 12231 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12228 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.
12295 12296 12297 12298 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12295 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.
12349 12350 12351 12352 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12349 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.
12413 12414 12415 12416 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12413 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.
12465 12466 12467 12468 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12465 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.
12524 12525 12526 12527 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12524 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.
12619 12620 12621 12622 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12619 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.
12721 12722 12723 12724 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12721 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. A predefined attribute is made up of a name and a value. You can use predefined attributes for:
Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Endpoints: See Amazon Connect endpoints and quotas.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12790 12791 12792 12793 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12790 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.
12839 12840 12841 12842 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12839 def list_prompts(params = {}, = {}) req = build_request(:list_prompts, params) req.send_request() end |
#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse
Lists the quick connects associated with a queue.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12901 12902 12903 12904 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12901 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.
12972 12973 12974 12975 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12972 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.
13034 13035 13036 13037 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13034 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 chat analysis session. This API supports CHAT channels only.
This API does not support VOICE. If you attempt to use it for VOICE,
an InvalidRequestException
occurs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13146 13147 13148 13149 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13146 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_manual_assignment_queues(params = {}) ⇒ Types::ListRoutingProfileManualAssignmentQueuesResponse
Lists the manual assignment queues associated with a routing profile.
Use cases
Following are common uses cases for this API:
This API returns list of queues where contacts can be manually assigned or picked. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).
For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide.
Important things to know
- This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.
^
Endpoints: See Amazon Connect endpoints and quotas.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13234 13235 13236 13237 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13234 def list_routing_profile_manual_assignment_queues(params = {}, = {}) req = build_request(:list_routing_profile_manual_assignment_queues, 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.
13296 13297 13298 13299 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13296 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.
13359 13360 13361 13362 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13359 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.
13423 13424 13425 13426 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13423 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.
13477 13478 13479 13480 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13477 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.
13536 13537 13538 13539 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13536 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.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13602 13603 13604 13605 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13602 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. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13666 13667 13668 13669 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13666 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.
13709 13710 13711 13712 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13709 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.
13779 13780 13781 13782 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13779 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.
13825 13826 13827 13828 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13825 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.
13878 13879 13880 13881 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13878 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.
13932 13933 13934 13935 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13932 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.
13993 13994 13995 13996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13993 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.
14047 14048 14049 14050 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14047 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.
14101 14102 14103 14104 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14101 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.
14159 14160 14161 14162 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14159 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.
14215 14216 14217 14218 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14215 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.
14277 14278 14279 14280 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14277 def monitor_contact(params = {}, = {}) req = build_request(:monitor_contact, params) req.send_request() end |
#pause_contact(params = {}) ⇒ Struct
Allows pausing an ongoing task contact.
14308 14309 14310 14311 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14308 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.
14353 14354 14355 14356 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14353 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 for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
14417 14418 14419 14420 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14417 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.
14487 14488 14489 14490 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14487 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.
14518 14519 14520 14521 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14518 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.
14564 14565 14566 14567 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14564 def resume_contact_recording(params = {}, = {}) req = build_request(:resume_contact_recording, params) req.send_request() end |
#search_agent_statuses(params = {}) ⇒ Types::SearchAgentStatusesResponse
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14670 14671 14672 14673 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14670 def search_agent_statuses(params = {}, = {}) req = build_request(:search_agent_statuses, 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.
14745 14746 14747 14748 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14745 def search_available_phone_numbers(params = {}, = {}) req = build_request(:search_available_phone_numbers, params) req.send_request() end |
#search_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse
Searches the flow modules in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14854 14855 14856 14857 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14854 def search_contact_flow_modules(params = {}, = {}) req = build_request(:search_contact_flow_modules, params) req.send_request() end |
#search_contact_flows(params = {}) ⇒ Types::SearchContactFlowsResponse
Searches the flows in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14970 14971 14972 14973 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14970 def search_contact_flows(params = {}, = {}) req = build_request(:search_contact_flows, 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.
15155 15156 15157 15158 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15155 def search_contacts(params = {}, = {}) req = build_request(:search_contacts, params) req.send_request() end |
#search_email_addresses(params = {}) ⇒ Types::SearchEmailAddressesResponse
Searches email address in an instance, with optional filtering.
15252 15253 15254 15255 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15252 def search_email_addresses(params = {}, = {}) req = build_request(:search_email_addresses, params) req.send_request() end |
#search_hours_of_operation_overrides(params = {}) ⇒ Types::SearchHoursOfOperationOverridesResponse
Searches the hours of operation overrides.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
15360 15361 15362 15363 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15360 def search_hours_of_operation_overrides(params = {}, = {}) req = build_request(:search_hours_of_operation_overrides, 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.
15470 15471 15472 15473 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15470 def search_hours_of_operations(params = {}, = {}) req = build_request(:search_hours_of_operations, params) req.send_request() end |
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Searches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for:
Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Endpoints: See Amazon Connect endpoints and quotas.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
15567 15568 15569 15570 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15567 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.
15670 15671 15672 15673 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15670 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.
15788 15789 15790 15791 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15788 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.
15897 15898 15899 15900 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15897 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.
15982 15983 15984 15985 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15982 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.
SearchRoutingProfiles
does not populate LastModifiedRegion,
LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and
AgentAvailabilityTimer in its response, but
DescribeRoutingProfile does.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16118 16119 16120 16121 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16118 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.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16240 16241 16242 16243 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16240 def search_security_profiles(params = {}, = {}) req = build_request(:search_security_profiles, params) req.send_request() end |
#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0"
is the foundation for
building levels on top of an instance. It is not user-definable, nor
is it visible in the UI.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16372 16373 16374 16375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16372 def search_user_hierarchy_groups(params = {}, = {}) req = build_request(:search_user_hierarchy_groups, 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.
16552 16553 16554 16555 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16552 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.
16625 16626 16627 16628 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16625 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 Web Services End User Messaging for supporting SMS integration.
16710 16711 16712 16713 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16710 def send_chat_integration_event(params = {}, = {}) req = build_request(:send_chat_integration_event, params) req.send_request() end |
#send_outbound_email(params = {}) ⇒ Struct
Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.
16822 16823 16824 16825 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16822 def send_outbound_email(params = {}, = {}) req = build_request(:send_outbound_email, params) req.send_request() end |
#start_attached_file_upload(params = {}) ⇒ Types::StartAttachedFileUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email.
16934 16935 16936 16937 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16934 def start_attached_file_upload(params = {}, = {}) req = build_request(:start_attached_file_upload, 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 the following topics in the Amazon Connect Administrator Guide:
17152 17153 17154 17155 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17152 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.
17218 17219 17220 17221 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17218 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.
17283 17284 17285 17286 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17283 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.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
17360 17361 17362 17363 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17360 def start_contact_streaming(params = {}, = {}) req = build_request(:start_contact_streaming, params) req.send_request() end |
#start_email_contact(params = {}) ⇒ Types::StartEmailContactResponse
Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
17551 17552 17553 17554 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17551 def start_email_contact(params = {}, = {}) req = build_request(:start_email_contact, params) req.send_request() end |
#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse
Initiates a new outbound SMS contact to a customer. Response of this
API provides the ContactId
of the outbound SMS contact created.
SourceEndpoint only supports Endpoints with
CONNECT_PHONENUMBER_ARN
as Type and DestinationEndpoint only
supports Endpoints with TELEPHONE_NUMBER
as Type. ContactFlowId
initiates the flow to manage the new SMS contact created.
This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.
For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:
17731 17732 17733 17734 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17731 def start_outbound_chat_contact(params = {}, = {}) req = build_request(:start_outbound_chat_contact, params) req.send_request() end |
#start_outbound_email_contact(params = {}) ⇒ Types::StartOutboundEmailContactResponse
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
17829 17830 17831 17832 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17829 def start_outbound_email_contact(params = {}, = {}) req = build_request(:start_outbound_email_contact, 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.
18006 18007 18008 18009 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18006 def start_outbound_voice_contact(params = {}, = {}) req = build_request(:start_outbound_voice_contact, params) req.send_request() end |
#start_screen_sharing(params = {}) ⇒ Struct
Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
18057 18058 18059 18060 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18057 def start_screen_sharing(params = {}, = {}) req = build_request(:start_screen_sharing, 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.
18283 18284 18285 18286 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18283 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).
18418 18419 18420 18421 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18418 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
EXTERNAL_OUTBOUND
MONITOR
Chat and task contacts can be terminated in any state, regardless of initiation method.
18471 18472 18473 18474 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18471 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.
18519 18520 18521 18522 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18519 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.
18560 18561 18562 18563 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18560 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.
18627 18628 18629 18630 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18627 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 (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice (IVR, agent) and screen recordings are supported.
18682 18683 18684 18685 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18682 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.
18730 18731 18732 18733 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18730 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, 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.
18773 18774 18775 18776 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18773 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#transfer_contact(params = {}) ⇒ Types::TransferContactResponse
Transfers TASK
or EMAIL
contacts from one agent or queue to
another agent or queue at any point after a contact is created. You
can transfer a contact to another queue by providing the flow which
orchestrates the contact to the destination queue. This gives you more
control over contact handling and helps you adhere to the service
level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is only supported for
TASK
andEMAIL
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.
18857 18858 18859 18860 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18857 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.
18899 18900 18901 18902 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18899 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.
18925 18926 18927 18928 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18925 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent_status(params = {}) ⇒ Struct
Updates agent status.
18976 18977 18978 18979 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18976 def update_agent_status(params = {}, = {}) req = build_request(:update_agent_status, params) req.send_request() end |
#update_authentication_profile(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
19054 19055 19056 19057 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19054 def update_authentication_profile(params = {}, = {}) req = build_request(:update_authentication_profile, 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.
19204 19205 19206 19207 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19204 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.
19285 19286 19287 19288 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19285 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.
19348 19349 19350 19351 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19348 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.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. After
a flow is published, $SAVED
needs to be supplied to view saved
content that has not been published.
19397 19398 19399 19400 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19397 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.
19440 19441 19442 19443 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19440 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.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. After
a flow is published, $SAVED
needs to be supplied to view saved
content that has not been published.
19486 19487 19488 19489 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19486 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.
19529 19530 19531 19532 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19529 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.
19570 19571 19572 19573 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19570 def update_contact_flow_name(params = {}, = {}) req = build_request(:update_contact_flow_name, params) req.send_request() end |
#update_contact_routing_data(params = {}) ⇒ Struct
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.
19689 19690 19691 19692 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19689 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.
19727 19728 19729 19730 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19727 def update_contact_schedule(params = {}, = {}) req = build_request(:update_contact_schedule, params) req.send_request() end |
#update_email_address_metadata(params = {}) ⇒ Types::UpdateEmailAddressMetadataResponse
Updates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
19791 19792 19793 19794 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19791 def (params = {}, = {}) req = build_request(:update_email_address_metadata, 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.
19942 19943 19944 19945 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19942 def update_evaluation_form(params = {}, = {}) req = build_request(:update_evaluation_form, params) req.send_request() end |
#update_hours_of_operation(params = {}) ⇒ Struct
Updates the hours of operation.
20001 20002 20003 20004 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20001 def update_hours_of_operation(params = {}, = {}) req = build_request(:update_hours_of_operation, params) req.send_request() end |
#update_hours_of_operation_override(params = {}) ⇒ Struct
Update the hours of operation override.
20064 20065 20066 20067 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20064 def update_hours_of_operation_override(params = {}, = {}) req = build_request(:update_hours_of_operation_override, 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.
20122 20123 20124 20125 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20122 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.
20205 20206 20207 20208 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20205 def update_instance_storage_config(params = {}, = {}) req = build_request(:update_instance_storage_config, params) req.send_request() end |
#update_participant_authentication(params = {}) ⇒ Struct
Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:
If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.
If an error is provided: The error branch of the Authenticate Customer block is executed.
20269 20270 20271 20272 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20269 def update_participant_authentication(params = {}, = {}) req = build_request(:update_participant_authentication, 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.
20334 20335 20336 20337 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20334 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.
20412 20413 20414 20415 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20412 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.
20459 20460 20461 20462 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20459 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. A predefined attribute is made up of a name and a value.
For the predefined attributes per instance quota, see Amazon Connect quotas.
Use cases
Following are common uses cases for this API:
Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.
Endpoints: See Amazon Connect endpoints and quotas.
20534 20535 20536 20537 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20534 def update_predefined_attribute(params = {}, = {}) req = build_request(:update_predefined_attribute, params) req.send_request() end |
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
20591 20592 20593 20594 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20591 def update_prompt(params = {}, = {}) req = build_request(:update_prompt, params) req.send_request() end |
#update_queue_hours_of_operation(params = {}) ⇒ Struct
Updates the hours of operation for the specified queue.
20626 20627 20628 20629 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20626 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
Updates the maximum number of contacts allowed in a queue before it is considered full.
20663 20664 20665 20666 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20663 def update_queue_max_contacts(params = {}, = {}) req = build_request(:update_queue_max_contacts, params) req.send_request() end |
#update_queue_name(params = {}) ⇒ Struct
Updates the name and description of a queue. At least Name
or
Description
must be provided.
20703 20704 20705 20706 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20703 def update_queue_name(params = {}, = {}) req = build_request(:update_queue_name, params) req.send_request() end |
#update_queue_outbound_caller_config(params = {}) ⇒ Struct
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.
20770 20771 20772 20773 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20770 def update_queue_outbound_caller_config(params = {}, = {}) req = build_request(:update_queue_outbound_caller_config, params) req.send_request() end |
#update_queue_outbound_email_config(params = {}) ⇒ Struct
Updates the outbound email address Id for a specified queue.
20807 20808 20809 20810 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20807 def update_queue_outbound_email_config(params = {}, = {}) req = build_request(:update_queue_outbound_email_config, params) req.send_request() end |
#update_queue_status(params = {}) ⇒ Struct
Updates the status of the queue.
20842 20843 20844 20845 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20842 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.
20890 20891 20892 20893 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20890 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.
20931 20932 20933 20934 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20931 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.
20970 20971 20972 20973 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20970 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.
21015 21016 21017 21018 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21015 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.
21050 21051 21052 21053 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21050 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.
21092 21093 21094 21095 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21092 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.
21139 21140 21141 21142 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21139 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.
21282 21283 21284 21285 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21282 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |
#update_security_profile(params = {}) ⇒ Struct
Updates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
21368 21369 21370 21371 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21368 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.
21521 21522 21523 21524 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21521 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.
When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.
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.
21605 21606 21607 21608 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21605 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.
21640 21641 21642 21643 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21640 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.
21675 21676 21677 21678 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21675 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.
21723 21724 21725 21726 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21723 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.
21776 21777 21778 21779 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21776 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.
21817 21818 21819 21820 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21817 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.
21856 21857 21858 21859 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21856 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.
21891 21892 21893 21894 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21891 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.
21926 21927 21928 21929 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21926 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
.
21997 21998 21999 22000 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21997 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.
22033 22034 22035 22036 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22033 def (params = {}, = {}) req = build_request(:update_view_metadata, params) req.send_request() end |