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_email_address_alias(params = {}) ⇒ Struct
Associates an email address alias with an existing email address in an Amazon Connect instance.
-
#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_email_address_alias(params = {}) ⇒ Struct
Removes the alias association between two email addresses in an Amazon Connect instance.
-
#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:
Programmatically assign queued contacts to available users.
Leverage the IAM context key
connect:PreferredUserArn
to restrict contact association to specific preferred user.
Important things to know
Use this API with chat, 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.The service quota Queues per routing profile per instance applies to manually assigned queues, too. For more information about this quota, see Amazon Connect quotas in the Amazon Connect Administrator Guide.
Endpoints: See Amazon Connect endpoints and quotas.
755 756 757 758 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 755 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.
799 800 801 802 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 799 def associate_default_vocabulary(params = {}, = {}) req = build_request(:associate_default_vocabulary, params) req.send_request() end |
#associate_email_address_alias(params = {}) ⇒ Struct
Associates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address.
Use cases
Following are common uses cases for this API:
Unified customer support: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management.
Department consolidation: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring.
Brand management: Enable you to use familiar brand-specific email addresses that forward to the appropriate Amazon Connect instance email address.
Important things to know
Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address.
If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails.
You cannot chain email aliases together (that is, create an alias of an alias).
AssociateEmailAddressAlias
does not return the following
information:
A confirmation of the alias relationship details (you must call DescribeEmailAddress to verify).
The timestamp of when the association occurred.
The status of the forwarding configuration.
Endpoints: See Amazon Connect endpoints and quotas.
Related operations
DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Amazon Connect instance.
DescribeEmailAddress: View current alias configurations for an email address.
SearchEmailAddresses: Find email addresses and their alias relationships across an instance.
CreateEmailAddress: Create new email addresses that can participate in alias relationships.
DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships).
UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
927 928 929 930 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 927 def associate_email_address_alias(params = {}, = {}) req = build_request(:associate_email_address_alias, params) req.send_request() end |
#associate_flow(params = {}) ⇒ Struct
Associates a connect resource to a flow.
972 973 974 975 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 972 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.
1083 1084 1085 1086 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1083 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.
1133 1134 1135 1136 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1133 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.
1186 1187 1188 1189 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1186 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
.
1233 1234 1235 1236 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1233 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.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1268 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.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1323 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.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1377 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.
1416 1417 1418 1419 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1416 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.
1453 1454 1455 1456 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1453 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.
1508 1509 1510 1511 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1508 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.
1559 1560 1561 1562 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1559 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.
1624 1625 1626 1627 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1624 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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1674 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.
1779 1780 1781 1782 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1779 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.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1894 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.
1935 1936 1937 1938 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1935 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.
1994 1995 1996 1997 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1994 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.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2187 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.
2269 2270 2271 2272 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2269 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2343 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
.
2401 2402 2403 2404 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2401 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.
2473 2474 2475 2476 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2473 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.
2608 2609 2610 2611 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2608 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.
2680 2681 2682 2683 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2680 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.
2746 2747 2748 2749 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2746 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.
2826 2827 2828 2829 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2826 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.
2899 2900 2901 2902 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2899 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.
2979 2980 2981 2982 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2979 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.
3101 3102 3103 3104 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3101 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.
3176 3177 3178 3179 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3176 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.
3243 3244 3245 3246 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3243 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.
3317 3318 3319 3320 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3317 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.
3422 3423 3424 3425 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3422 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.
3490 3491 3492 3493 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3490 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.
3607 3608 3609 3610 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3607 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.
3772 3773 3774 3775 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3772 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.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3881 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.
4008 4009 4010 4011 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4008 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.
4088 4089 4090 4091 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4088 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.
4140 4141 4142 4143 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4140 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.
4264 4265 4266 4267 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4264 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.
4317 4318 4319 4320 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4317 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.
4408 4409 4410 4411 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4408 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.
4472 4473 4474 4475 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4472 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.
4563 4564 4565 4566 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4563 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.
4611 4612 4613 4614 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4611 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.
4653 4654 4655 4656 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4653 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.
4684 4685 4686 4687 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4684 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.
4715 4716 4717 4718 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4715 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.
4746 4747 4748 4749 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4746 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.
4781 4782 4783 4784 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4781 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.
4812 4813 4814 4815 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4812 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.
4853 4854 4855 4856 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4853 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.
4884 4885 4886 4887 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4884 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.
4915 4916 4917 4918 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4915 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.
4972 4973 4974 4975 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4972 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.
5005 5006 5007 5008 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5005 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.
5033 5034 5035 5036 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5033 def delete_predefined_attribute(params = {}, = {}) req = build_request(:delete_predefined_attribute, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
5064 5065 5066 5067 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5064 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.
5099 5100 5101 5102 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5099 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.
5130 5131 5132 5133 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5130 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.
5179 5180 5181 5182 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5179 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.
5210 5211 5212 5213 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5210 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.
5241 5242 5243 5244 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5241 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
5272 5273 5274 5275 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5272 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.
5303 5304 5305 5306 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5303 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.
5335 5336 5337 5338 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5335 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.
5370 5371 5372 5373 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5370 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.
5423 5424 5425 5426 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5423 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.
5455 5456 5457 5458 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5455 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).
5483 5484 5485 5486 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5483 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.
5514 5515 5516 5517 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5514 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.
5555 5556 5557 5558 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5555 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
Describes an agent status.
5602 5603 5604 5605 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5602 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 ServicesSupport.
Describes the target authentication profile.
5656 5657 5658 5659 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5656 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.
Use cases
Following are common uses cases for this API:
Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.
Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup.
Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream.
Important things to know
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.
Endpoints: See Amazon Connect endpoints and quotas.
5898 5899 5900 5901 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5898 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.
6000 6001 6002 6003 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6000 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
6066 6067 6068 6069 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6066 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.
6116 6117 6118 6119 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6116 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.
6171 6172 6173 6174 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6171 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.
6259 6260 6261 6262 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6259 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.
6310 6311 6312 6313 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6310 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.
6358 6359 6360 6361 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6358 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.
6420 6421 6422 6423 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6420 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.
6461 6462 6463 6464 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6461 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.
6518 6519 6520 6521 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6518 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
.
6569 6570 6571 6572 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6569 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.
6633 6634 6635 6636 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6633 def describe_predefined_attribute(params = {}, = {}) req = build_request(:describe_predefined_attribute, params) req.send_request() end |
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
6677 6678 6679 6680 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6677 def describe_prompt(params = {}, = {}) req = build_request(:describe_prompt, params) req.send_request() end |
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
Describes the specified queue.
6728 6729 6730 6731 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6728 def describe_queue(params = {}, = {}) req = build_request(:describe_queue, params) req.send_request() end |
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
6778 6779 6780 6781 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6778 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.
6848 6849 6850 6851 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6848 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.
6937 6938 6939 6940 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6937 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.
6999 7000 7001 7002 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6999 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.
7038 7039 7040 7041 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7038 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.
7103 7104 7105 7106 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7103 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.
7172 7173 7174 7175 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7172 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.
7230 7231 7232 7233 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7230 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.
7292 7293 7294 7295 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7292 def describe_view(params = {}, = {}) req = build_request(:describe_view, params) req.send_request() end |
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
7338 7339 7340 7341 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7338 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.
7377 7378 7379 7380 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7377 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.
7425 7426 7427 7428 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7425 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.
7483 7484 7485 7486 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7483 def disassociate_bot(params = {}, = {}) req = build_request(:disassociate_bot, params) req.send_request() end |
#disassociate_email_address_alias(params = {}) ⇒ Struct
Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly.
Use cases
Following are common uses cases for this API:
Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues.
Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses.
Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed.
Important things to know
Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked.
Emails sent to the former alias address are still delivered directly to that address if it exists.
You do not need to delete the email addresses after disassociation. Both addresses remain active independently.
After a successful disassociation, you can immediately create a new alias relationship with the same addresses.
200 status means alias was successfully disassociated.
DisassociateEmailAddressAlias
does not return the following
information:
Details in the response about the email that was disassociated. The response returns an empty body.
The timestamp of when the disassociation occurred.
Endpoints: See Amazon Connect endpoints and quotas.
Related operations
AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance.
DescribeEmailAddress: View current alias configurations for an email address.
SearchEmailAddresses: Find email addresses and their alias relationships across an instance.
CreateEmailAddress: Create new email addresses that can participate in alias relationships.
DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships).
UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).
7611 7612 7613 7614 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7611 def disassociate_email_address_alias(params = {}, = {}) req = build_request(:disassociate_email_address_alias, params) req.send_request() end |
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
7652 7653 7654 7655 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7652 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.
7706 7707 7708 7709 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7706 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.
7756 7757 7758 7759 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7756 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.
7810 7811 7812 7813 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7810 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
.
7853 7854 7855 7856 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7853 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.
7888 7889 7890 7891 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7888 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.
7942 7943 7944 7945 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7942 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.
7991 7992 7993 7994 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7991 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.
8030 8031 8032 8033 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8030 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.
8066 8067 8068 8069 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8066 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.
8104 8105 8106 8107 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8104 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
.
8180 8181 8182 8183 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8180 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.
8213 8214 8215 8216 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8213 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.
8295 8296 8297 8298 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8295 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.
8604 8605 8606 8607 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8604 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.
8717 8718 8719 8720 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8717 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.
8765 8766 8767 8768 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8765 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
8826 8827 8828 8829 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8826 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.
8877 8878 8879 8880 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8877 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.
9269 9270 9271 9272 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9269 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.
11151 11152 11153 11154 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11151 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.
11192 11193 11194 11195 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11192 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.
11274 11275 11276 11277 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11274 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.
11320 11321 11322 11323 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11320 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 ServicesSupport ticket.
11417 11418 11419 11420 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11417 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.
11474 11475 11476 11477 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11474 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.
11529 11530 11531 11532 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11529 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.
11577 11578 11579 11580 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11577 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.
11629 11630 11631 11632 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11629 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.
11688 11689 11690 11691 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11688 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 ServicesSupport.
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.
11746 11747 11748 11749 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11746 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.
11805 11806 11807 11808 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11805 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.
11866 11867 11868 11869 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11866 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.
11922 11923 11924 11925 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11922 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.
11973 11974 11975 11976 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11973 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.
12043 12044 12045 12046 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12043 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.
12118 12119 12120 12121 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12118 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.
12180 12181 12182 12183 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12180 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.
12241 12242 12243 12244 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12241 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.
12299 12300 12301 12302 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12299 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.
12353 12354 12355 12356 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12353 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.
12416 12417 12418 12419 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12416 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.
12477 12478 12479 12480 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12477 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.
12530 12531 12532 12533 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12530 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.
12597 12598 12599 12600 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12597 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.
12651 12652 12653 12654 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12651 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.
12715 12716 12717 12718 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12715 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.
12767 12768 12769 12770 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12767 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.
12826 12827 12828 12829 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12826 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.
12921 12922 12923 12924 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12921 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.
13023 13024 13025 13026 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13023 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.
13092 13093 13094 13095 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13092 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.
13141 13142 13143 13144 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13141 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.
13203 13204 13205 13206 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13203 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.
13274 13275 13276 13277 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13274 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.
13337 13338 13339 13340 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13337 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.
13449 13450 13451 13452 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13449 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 by an agent who has access to the Worklist app. 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.
13537 13538 13539 13540 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13537 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.
13599 13600 13601 13602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13599 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.
13662 13663 13664 13665 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13662 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.
13726 13727 13728 13729 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13726 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.
13780 13781 13782 13783 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13780 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.
13839 13840 13841 13842 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13839 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.
13905 13906 13907 13908 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13905 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.
13969 13970 13971 13972 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13969 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.
14012 14013 14014 14015 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14012 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.
14082 14083 14084 14085 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14082 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.
14128 14129 14130 14131 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14128 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.
14181 14182 14183 14184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14181 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.
14235 14236 14237 14238 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14235 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.
14296 14297 14298 14299 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14296 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.
14350 14351 14352 14353 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14350 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.
14404 14405 14406 14407 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14404 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.
14462 14463 14464 14465 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14462 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.
14518 14519 14520 14521 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14518 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.
14580 14581 14582 14583 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14580 def monitor_contact(params = {}, = {}) req = build_request(:monitor_contact, params) req.send_request() end |
#pause_contact(params = {}) ⇒ Struct
Allows pausing an ongoing task contact.
14611 14612 14613 14614 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14611 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.
14656 14657 14658 14659 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14656 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 ServicesSupport.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
14720 14721 14722 14723 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14720 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.
14790 14791 14792 14793 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14790 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.
14821 14822 14823 14824 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14821 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.
14867 14868 14869 14870 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14867 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.
14973 14974 14975 14976 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14973 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.
15048 15049 15050 15051 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15048 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.
15157 15158 15159 15160 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15157 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.
15273 15274 15275 15276 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15273 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.
15458 15459 15460 15461 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15458 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.
15557 15558 15559 15560 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15557 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.
15665 15666 15667 15668 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15665 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.
15775 15776 15777 15778 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15775 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.
15872 15873 15874 15875 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15872 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.
15975 15976 15977 15978 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15975 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.
16093 16094 16095 16096 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16093 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.
16202 16203 16204 16205 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16202 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.
16287 16288 16289 16290 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16287 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.
16423 16424 16425 16426 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16423 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.
16545 16546 16547 16548 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16545 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.
16677 16678 16679 16680 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16677 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.
16857 16858 16859 16860 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16857 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.
16930 16931 16932 16933 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16930 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.
17015 17016 17017 17018 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17015 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.
17127 17128 17129 17130 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17127 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.
17239 17240 17241 17242 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17239 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
ServicesSupport.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
17457 17458 17459 17460 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17457 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.
17523 17524 17525 17526 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17523 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.
17588 17589 17590 17591 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17588 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:
17665 17666 17667 17668 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17665 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.
17856 17857 17858 17859 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17856 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:
18036 18037 18038 18039 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18036 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.
18134 18135 18136 18137 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18134 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.
18327 18328 18329 18330 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18327 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.
18378 18379 18380 18381 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18378 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.
18604 18605 18606 18607 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18604 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).
18739 18740 18741 18742 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18739 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.
18799 18800 18801 18802 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18799 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.
18847 18848 18849 18850 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18847 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.
18888 18889 18890 18891 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18888 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.
18955 18956 18957 18958 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18955 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.
19010 19011 19012 19013 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19010 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.
19058 19059 19060 19061 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19058 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.
19101 19102 19103 19104 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19101 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.
19185 19186 19187 19188 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19185 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.
19227 19228 19229 19230 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19227 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.
19253 19254 19255 19256 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19253 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent_status(params = {}) ⇒ Struct
Updates agent status.
19304 19305 19306 19307 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19304 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 ServicesSupport.
Updates the selected authentication profile.
19382 19383 19384 19385 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19382 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.
19532 19533 19534 19535 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19532 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.
19613 19614 19615 19616 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19613 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.
19676 19677 19678 19679 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19676 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.
19725 19726 19727 19728 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19725 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.
19768 19769 19770 19771 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19768 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.
19814 19815 19816 19817 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19814 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.
19857 19858 19859 19860 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19857 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.
19898 19899 19900 19901 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19898 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.
20017 20018 20019 20020 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20017 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.
20055 20056 20057 20058 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20055 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.
20119 20120 20121 20122 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20119 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.
20270 20271 20272 20273 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20270 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.
20329 20330 20331 20332 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20329 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.
20392 20393 20394 20395 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20392 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.
20450 20451 20452 20453 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20450 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.
20533 20534 20535 20536 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20533 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.
20597 20598 20599 20600 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20597 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.
20662 20663 20664 20665 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20662 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.
20740 20741 20742 20743 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20740 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.
20787 20788 20789 20790 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20787 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.
20862 20863 20864 20865 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20862 def update_predefined_attribute(params = {}, = {}) req = build_request(:update_predefined_attribute, params) req.send_request() end |
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
20919 20920 20921 20922 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20919 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.
20954 20955 20956 20957 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20954 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.
20991 20992 20993 20994 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20991 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.
21031 21032 21033 21034 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21031 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.
21098 21099 21100 21101 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21098 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.
21135 21136 21137 21138 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21135 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.
21170 21171 21172 21173 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21170 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.
21218 21219 21220 21221 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21218 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.
21259 21260 21261 21262 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21259 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.
21298 21299 21300 21301 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21298 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.
21343 21344 21345 21346 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21343 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.
21378 21379 21380 21381 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21378 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.
21420 21421 21422 21423 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21420 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.
21467 21468 21469 21470 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21467 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.
21610 21611 21612 21613 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21610 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.
21696 21697 21698 21699 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21696 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.
21849 21850 21851 21852 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21849 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.
21933 21934 21935 21936 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21933 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.
21968 21969 21970 21971 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21968 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.
22003 22004 22005 22006 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22003 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.
22051 22052 22053 22054 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22051 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.
22104 22105 22106 22107 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22104 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.
22145 22146 22147 22148 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22145 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.
22184 22185 22186 22187 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22184 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.
22219 22220 22221 22222 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22219 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.
22254 22255 22256 22257 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22254 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
.
22325 22326 22327 22328 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22325 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.
22361 22362 22363 22364 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22361 def (params = {}, = {}) req = build_request(:update_view_metadata, params) req.send_request() end |