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 Connect Customer instance.
-
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
Associates the specified dataset for a Connect Customer instance with the target account.
-
#associate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#associate_bot(params = {}) ⇒ Struct
This API is in preview release for Connect Customer 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 Connect Customer instance.
-
#associate_flow(params = {}) ⇒ Struct
Associates a connect resource to a flow.
-
#associate_hours_of_operations(params = {}) ⇒ Struct
Associates a set of hours of operations with another hours of operation.
-
#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse
This API is in preview release for Connect Customer and is subject to change.
-
#associate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#associate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#associate_phone_number_contact_flow(params = {}) ⇒ Struct
Associates a flow with a phone number claimed to your Connect Customer instance.
-
#associate_queue_email_addresses(params = {}) ⇒ Struct
Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts.
-
#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 Connect Customer and is subject to change.
-
#associate_security_profiles(params = {}) ⇒ Struct
Associate security profiles with an Entity in an Amazon Connect instance.
-
#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.
-
#associate_workspace(params = {}) ⇒ Types::AssociateWorkspaceResponse
Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
-
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
Associates a list of analytics datasets for a given Connect Customer instance to a target account.
-
#batch_create_data_table_value(params = {}) ⇒ Types::BatchCreateDataTableValueResponse
Creates values for attributes in a data table.
-
#batch_delete_data_table_value(params = {}) ⇒ Types::BatchDeleteDataTableValueResponse
Deletes multiple values from a data table.
-
#batch_describe_data_table_value(params = {}) ⇒ Types::BatchDescribeDataTableValueResponse
Retrieves multiple values from a data table without evaluating expressions.
-
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
Removes a list of analytics datasets associated with a given Connect Customer 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 Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API. -
#batch_update_data_table_value(params = {}) ⇒ Types::BatchUpdateDataTableValueResponse
Updates multiple data table values using all properties from BatchCreateDataTableValue.
-
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Connect Customer 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 Connect Customer instance.
-
#create_attached_file(params = {}) ⇒ Types::CreateAttachedFileResponse
Creates an attached file for a completed voice contact by copying a recording from a source S3 URI into Connect Customer managed storage.
-
#create_auth_code(params = {}) ⇒ Types::CreateAuthCodeResponse
Creates an authorization code for the specified Connect Customer 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 Connect Customer instance.
-
#create_contact_flow_alias(params = {}) ⇒ Types::CreateContactFlowAliasResponse
Creates a named alias that points to a specific version of a flow.
-
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Connect Customer instance.
-
#create_contact_flow_module_alias(params = {}) ⇒ Types::CreateContactFlowModuleAliasResponse
Creates a named alias that points to a specific version of a contact flow module.
-
#create_contact_flow_module_version(params = {}) ⇒ Types::CreateContactFlowModuleVersionResponse
Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.
-
#create_contact_flow_version(params = {}) ⇒ Types::CreateContactFlowVersionResponse
Publishes a new version of the flow provided.
-
#create_data_table(params = {}) ⇒ Types::CreateDataTableResponse
Creates a new data table with the specified properties.
-
#create_data_table_attribute(params = {}) ⇒ Types::CreateDataTableAttributeResponse
Adds an attribute to an existing data table.
-
#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse
Create new email address in the specified Connect Customer instance.
-
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
Creates an evaluation form in the specified Connect Customer instance.
-
#create_extraction_definition(params = {}) ⇒ Types::CreateExtractionDefinitionResponse
Creates an extraction definition in the specified Connect Customer 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 Connect Customer hours of operation resource.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
This API is in preview release for Connect Customer and is subject to change.
-
#create_integration_association(params = {}) ⇒ Types::CreateIntegrationAssociationResponse
Creates an Amazon Web Services resource association with an Connect Customer instance.
-
#create_metric(params = {}) ⇒ Types::CreateMetricResponse
Creates a new metric definition for the specified Connect Customer instance.
-
#create_notification(params = {}) ⇒ Types::CreateNotificationResponse
Creates a new notification to be delivered to specified recipients.
-
#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 Connect Customer 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 Connect Customer instance.
-
#create_quick_connect(params = {}) ⇒ Types::CreateQuickConnectResponse
Creates a quick connect for the specified Connect Customer instance.
-
#create_routing_profile(params = {}) ⇒ Types::CreateRoutingProfileResponse
Creates a new routing profile.
-
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a rule for the specified Connect Customer 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 Connect Customer instance.
-
#create_test_case(params = {}) ⇒ Types::CreateTestCaseResponse
Creates a test case with its content and metadata for the specified Amazon Connect instance.
-
#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse
Creates a traffic distribution group given an Connect Customer 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 Connect Customer 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
SAVEDorPUBLISHED. -
#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 Connect Customer instance.
-
#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse
Creates a workspace that defines the user experience by mapping views to pages.
-
#create_workspace_page(params = {}) ⇒ Struct
Associates a view with a page in a workspace, defining what users see when they navigate to that page.
-
#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse
Deactivates an evaluation form in the specified Connect Customer instance.
-
#delete_all_entity_sessions(params = {}) ⇒ Struct
Deletes all active sessions for the specified entity in the specified Connect Customer instance.
-
#delete_attached_file(params = {}) ⇒ Struct
Deletes an attached file along with the underlying S3 Object.
-
#delete_contact_data(params = {}) ⇒ Struct
Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance.
-
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Connect Customer instance.
-
#delete_contact_flow(params = {}) ⇒ Struct
Deletes a flow for the specified Connect Customer instance.
-
#delete_contact_flow_alias(params = {}) ⇒ Struct
Deletes an alias from a flow without deleting the version that the alias points to.
-
#delete_contact_flow_module(params = {}) ⇒ Struct
Deletes the specified flow module.
-
#delete_contact_flow_module_alias(params = {}) ⇒ Struct
Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.
-
#delete_contact_flow_module_version(params = {}) ⇒ Struct
Removes a specific version of a contact flow module.
-
#delete_contact_flow_version(params = {}) ⇒ Struct
Deletes the particular version specified in flow version identifier.
-
#delete_data_table(params = {}) ⇒ Struct
Deletes a data table and all associated attributes, versions, audits, and values.
-
#delete_data_table_attribute(params = {}) ⇒ Types::DeleteDataTableAttributeResponse
Deletes an attribute and all its values from a data table.
-
#delete_email_address(params = {}) ⇒ Struct
Deletes email address from the specified Connect Customer instance.
-
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Connect Customer instance.
-
#delete_extraction_definition(params = {}) ⇒ Struct
Deletes an extraction definition from the specified Connect Customer 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 Connect Customer hours of operation resource.
-
#delete_instance(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#delete_integration_association(params = {}) ⇒ Struct
Deletes an Amazon Web Services resource association from an Connect Customer instance.
-
#delete_metric(params = {}) ⇒ Struct
Deletes an existing metric from the specified Connect Customer instance.
-
#delete_notification(params = {}) ⇒ Struct
Deletes a notification.
-
#delete_predefined_attribute(params = {}) ⇒ Struct
Deletes a predefined attribute from the specified Connect Customer 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 Connect Customer instance.
-
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
-
#delete_session(params = {}) ⇒ Struct
Deletes a session for the specified Connect Customer instance.
-
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
-
#delete_test_case(params = {}) ⇒ Struct
Deletes the test case that has already been created for the specified Amazon Connect instance.
-
#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 Connect Customer 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
ViewVersionidentifier. -
#delete_vocabulary(params = {}) ⇒ Types::DeleteVocabularyResponse
Deletes the vocabulary that has the given identifier.
-
#delete_workspace(params = {}) ⇒ Struct
Deletes a workspace and removes all associated view and resource assignments.
-
#delete_workspace_media(params = {}) ⇒ Struct
Deletes a media asset (such as a logo) from a workspace.
-
#delete_workspace_page(params = {}) ⇒ Struct
Removes the association between a view and a page in a workspace.
-
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
Describes an agent status.
-
#describe_attached_files_configuration(params = {}) ⇒ Types::DescribeAttachedFilesConfigurationResponse
Describes the attached files configuration for the specified Connect Customer instance and attachment scope.
-
#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse
This API is in preview release for Connect Customer and is subject to change.
-
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
This API is in preview release for Connect Customer and is subject to change.
-
#describe_contact_evaluation(params = {}) ⇒ Types::DescribeContactEvaluationResponse
Describes a contact evaluation in the specified Connect Customer instance.
-
#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse
Describes the specified flow.
-
#describe_contact_flow_alias(params = {}) ⇒ Types::DescribeContactFlowAliasResponse
Returns information about a specific flow alias, including the version that it points to.
-
#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse
Describes the specified flow module.
-
#describe_contact_flow_module_alias(params = {}) ⇒ Types::DescribeContactFlowModuleAliasResponse
Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.
-
#describe_data_table(params = {}) ⇒ Types::DescribeDataTableResponse
Returns all properties for a data table except for attributes and values.
-
#describe_data_table_attribute(params = {}) ⇒ Types::DescribeDataTableAttributeResponse
Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata.
-
#describe_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse
Describe email address form the specified Connect Customer instance.
-
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Connect Customer instance.
-
#describe_extraction_definition(params = {}) ⇒ Types::DescribeExtractionDefinitionResponse
Describes an extraction definition in the specified Connect Customer 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 Connect Customer and is subject to change.
-
#describe_instance_attribute(params = {}) ⇒ Types::DescribeInstanceAttributeResponse
This API is in preview release for Connect Customer and is subject to change.
-
#describe_instance_storage_config(params = {}) ⇒ Types::DescribeInstanceStorageConfigResponse
This API is in preview release for Connect Customer and is subject to change.
-
#describe_metric(params = {}) ⇒ Types::DescribeMetricResponse
Retrieves the full definition of an existing metric from the specified Connect Customer instance.
-
#describe_notification(params = {}) ⇒ Types::DescribeNotificationResponse
Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
-
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Connect Customer instance or traffic distribution group.
-
#describe_predefined_attribute(params = {}) ⇒ Types::DescribePredefinedAttributeResponse
Describes a predefined attribute for the specified Connect Customer 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 Connect Customer instance.
-
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets basic information about the security profile.
-
#describe_test_case(params = {}) ⇒ Types::DescribeTestCaseResponse
Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.
-
#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 Connect Customer instance.
-
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
Retrieves the view for the specified Connect Customer instance and view identifier.
-
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
-
#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse
Retrieves details about a workspace, including its configuration and metadata.
-
#disassociate_analytics_data_set(params = {}) ⇒ Struct
Removes the dataset ID associated with a given Connect Customer instance.
-
#disassociate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#disassociate_bot(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#disassociate_email_address_alias(params = {}) ⇒ Struct
Removes the alias association between two email addresses in an Connect Customer instance.
-
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
-
#disassociate_hours_of_operations(params = {}) ⇒ Struct
Disassociates a set of hours of operations with another hours of operation.
-
#disassociate_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#disassociate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#disassociate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct
Removes the flow association from a phone number claimed to your Connect Customer instance.
-
#disassociate_queue_email_addresses(params = {}) ⇒ Struct
Removes the association between a set of email addresses and a queue.
-
#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 Connect Customer and is subject to change.
-
#disassociate_security_profiles(params = {}) ⇒ Struct
Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.
-
#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.
-
#disassociate_workspace(params = {}) ⇒ Types::DisassociateWorkspaceResponse
Removes the association between a workspace and one or more users or routing profiles.
-
#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.
-
#evaluate_data_table_values(params = {}) ⇒ Types::EvaluateDataTableValuesResponse
Evaluates values at the time of the request and returns them.
-
#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 contact metric data for a specified contact.
-
#get_cross_region_routing(params = {}) ⇒ Types::GetCrossRegionRoutingResponse
Retrieves the current cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing.
-
#get_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse
Gets the real-time metric data from the specified Connect Customer instance.
-
#get_current_user_data(params = {}) ⇒ Types::GetCurrentUserDataResponse
Gets the real-time active user data from the specified Connect Customer instance.
-
#get_effective_hours_of_operations(params = {}) ⇒ Types::GetEffectiveHoursOfOperationsResponse
Get the hours of operations with the effective override applied.
-
#get_evaluation_form_validation(params = {}) ⇒ Types::GetEvaluationFormValidationResponse
Retrieves the status and results of a validation process started by [StartEvaluationFormValidation][1].
-
#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse
Supports SAML sign-in for Connect Customer.
-
#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 Connect Customer instance.
-
#get_metric_data_v2(params = {}) ⇒ Types::GetMetricDataV2Response
Gets metric data from the specified Connect Customer 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 Connect Customer instance.
-
#get_test_case_execution_summary(params = {}) ⇒ Types::GetTestCaseExecutionSummaryResponse
Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.
-
#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 Connect Customer instance.
-
#import_workspace_media(params = {}) ⇒ Struct
Imports a media asset (such as a logo) for use in a workspace.
-
#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 Connect Customer instance.
-
#list_analytics_data_lake_data_sets(params = {}) ⇒ Types::ListAnalyticsDataLakeDataSetsResponse
Lists the data lake datasets available to associate with for a given Connect Customer instance.
-
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
This API is in preview release for Connect Customer 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_attached_files_configurations(params = {}) ⇒ Types::ListAttachedFilesConfigurationsResponse
Provides summary information about the attached files configurations for the specified Connect Customer instance.
-
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_bots(params = {}) ⇒ Types::ListBotsResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_child_hours_of_operations(params = {}) ⇒ Types::ListChildHoursOfOperationsResponse
Provides information about the child hours of operations for the specified parent hours of operation.
-
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Connect Customer instance.
-
#list_contact_flow_aliases(params = {}) ⇒ Types::ListContactFlowAliasesResponse
Lists the aliases associated with a flow, including the version that each alias points to.
-
#list_contact_flow_module_aliases(params = {}) ⇒ Types::ListContactFlowModuleAliasesResponse
Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.
-
#list_contact_flow_module_versions(params = {}) ⇒ Types::ListContactFlowModuleVersionsResponse
Retrieves a paginated list of all versions for a specific contact flow module.
-
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Connect Customer instance.
-
#list_contact_flow_versions(params = {}) ⇒ Types::ListContactFlowVersionsResponse
Returns all the available versions for the specified Connect Customer instance and flow identifier.
-
#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse
Provides information about the flows for the specified Connect Customer instance.
-
#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_data_table_attributes(params = {}) ⇒ Types::ListDataTableAttributesResponse
Returns all attributes for a specified data table.
-
#list_data_table_primary_values(params = {}) ⇒ Types::ListDataTablePrimaryValuesResponse
Lists all primary value combinations for a given data table.
-
#list_data_table_values(params = {}) ⇒ Types::ListDataTableValuesResponse
Lists values stored in a data table with optional filtering by record IDs or primary attribute values.
-
#list_data_tables(params = {}) ⇒ Types::ListDataTablesResponse
Lists all data tables for the specified Amazon Connect instance.
-
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Connect Customer instance.
-
#list_entity_security_profiles(params = {}) ⇒ Types::ListEntitySecurityProfilesResponse
Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.
-
#list_evaluation_form_ai_versions(params = {}) ⇒ Types::ListEvaluationFormAIVersionsResponse
Lists the available AI versions for evaluation forms in the specified Connect Customer instance.
-
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Connect Customer instance.
-
#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse
Lists evaluation forms in the specified Connect Customer instance.
-
#list_extraction_definitions(params = {}) ⇒ Types::ListExtractionDefinitionsResponse
Lists extraction definitions in the specified Connect Customer 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 Connect Customer instance.
-
#list_instance_attributes(params = {}) ⇒ Types::ListInstanceAttributesResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_instance_storage_configs(params = {}) ⇒ Types::ListInstanceStorageConfigsResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_integration_associations(params = {}) ⇒ Types::ListIntegrationAssociationsResponse
Provides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance.
-
#list_lambda_functions(params = {}) ⇒ Types::ListLambdaFunctionsResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_lex_bots(params = {}) ⇒ Types::ListLexBotsResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_metrics(params = {}) ⇒ Types::ListMetricsResponse
Retrieves a paginated list of metric summaries for the specified Connect Customer instance.
-
#list_notifications(params = {}) ⇒ Types::ListNotificationsResponse
Retrieves a paginated list of all notifications in the Amazon Connect instance.
-
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Provides information about the phone numbers for the specified Connect Customer instance.
-
#list_phone_numbers_v2(params = {}) ⇒ Types::ListPhoneNumbersV2Response
Lists phone numbers claimed to your Connect Customer instance or traffic distribution group.
-
#list_predefined_attributes(params = {}) ⇒ Types::ListPredefinedAttributesResponse
Lists predefined attributes for the specified Connect Customer instance.
-
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Provides information about the prompts for the specified Connect Customer instance.
-
#list_queue_email_addresses(params = {}) ⇒ Types::ListQueueEmailAddressesResponse
Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts.
-
#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 Connect Customer instance.
-
#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse
Provides information about the quick connects for the specified Connect Customer instance.
-
#list_realtime_contact_analysis_segments_v2(params = {}) ⇒ Types::ListRealtimeContactAnalysisSegmentsV2Response
Provides a list of analysis segments for a real-time chat analysis session.
-
#list_replication_findings(params = {}) ⇒ Types::ListReplicationFindingsResponse
Lists replication findings for resources of a specified resource type in a specified Connect Customer instance.
-
#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 Connect Customer instance.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
List all rules for the specified Connect Customer instance.
-
#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse
This API is in preview release for Connect Customer and is subject to change.
-
#list_security_profile_ai_agents(params = {}) ⇒ Types::ListSecurityProfileAIAgentsResponse
Returns a list of the allowed AI agents in a specific security profile.
-
#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse
Returns a list of third-party applications or MCP Servers in a specific security profile.
-
#list_security_profile_flow_modules(params = {}) ⇒ Types::ListSecurityProfileFlowModulesResponse
A list of Flow Modules an AI Agent can invoke as a tool.
-
#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 Connect Customer 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 Connect Customer instance.
-
#list_test_case_execution_records(params = {}) ⇒ Types::ListTestCaseExecutionRecordsResponse
Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.
-
#list_test_case_executions(params = {}) ⇒ Types::ListTestCaseExecutionsResponse
Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.
-
#list_test_cases(params = {}) ⇒ Types::ListTestCasesResponse
Lists the test cases present in the specific 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 Connect Customer instance.
-
#list_user_notifications(params = {}) ⇒ Types::ListUserNotificationsResponse
Retrieves a paginated list of notifications for a specific user, including the notification status for that user.
-
#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 Connect Customer instance.
-
#list_view_versions(params = {}) ⇒ Types::ListViewVersionsResponse
Returns all the available versions for the specified Connect Customer instance and view identifier.
-
#list_views(params = {}) ⇒ Types::ListViewsResponse
Returns views in the given instance.
-
#list_workspace_media(params = {}) ⇒ Types::ListWorkspaceMediaResponse
Lists media assets (such as logos) associated with a workspace.
-
#list_workspace_pages(params = {}) ⇒ Types::ListWorkspacePagesResponse
Lists the page configurations in a workspace, including the views assigned to each page.
-
#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse
Lists the workspaces in an Amazon Connect instance.
-
#monitor_contact(params = {}) ⇒ Types::MonitorContactResponse
Initiates silent monitoring of a contact.
-
#pause_contact(params = {}) ⇒ Struct
Pauses an ongoing task or email contact.
-
#put_user_status(params = {}) ⇒ Struct
Changes the current status of a user or agent in Connect Customer.
-
#release_phone_number(params = {}) ⇒ Struct
Releases a phone number previously claimed to an Connect Customer instance or traffic distribution group.
-
#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse
Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions.
-
#resume_contact(params = {}) ⇒ Struct
Resumes a task or email 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 Connect Customer instance, with optional filtering.
-
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
Searches for available phone numbers that you can claim to your Connect Customer instance or traffic distribution group.
-
#search_contact_evaluations(params = {}) ⇒ Types::SearchContactEvaluationsResponse
Searches contact evaluations in an Connect Customer instance, with optional filtering.
-
#search_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse
Searches the flow modules in an Connect Customer instance, with optional filtering.
-
#search_contact_flows(params = {}) ⇒ Types::SearchContactFlowsResponse
Searches the flows in an Connect Customer instance, with optional filtering.
-
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Connect Customer instance.
-
#search_data_tables(params = {}) ⇒ Types::SearchDataTablesResponse
Searches for data tables based on the table's ID, name, and description.
-
#search_email_addresses(params = {}) ⇒ Types::SearchEmailAddressesResponse
Searches email address in an instance, with optional filtering.
-
#search_evaluation_forms(params = {}) ⇒ Types::SearchEvaluationFormsResponse
Searches evaluation forms in an Connect Customer 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 Connect Customer instance, with optional filtering.
-
#search_metrics(params = {}) ⇒ Types::SearchMetricsResponse
Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters.
-
#search_notifications(params = {}) ⇒ Types::SearchNotificationsResponse
Searches for notifications based on specified criteria and filters.
-
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Searches predefined attributes that meet certain criteria.
-
#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse
Searches prompts in an Connect Customer instance, with optional filtering.
-
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Connect Customer instance, with optional filtering.
-
#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse
Searches quick connects in an Connect Customer instance, with optional filtering.
-
#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse
Searches tags used in an Connect Customer instance using optional search criteria.
-
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Connect Customer instance, with optional filtering.
-
#search_rules(params = {}) ⇒ Types::SearchRulesResponse
Searches rules in an Connect Customer instance, with optional filtering.
-
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Connect Customer instance, with optional filtering.
-
#search_test_cases(params = {}) ⇒ Types::SearchTestCasesResponse
Searches for test cases in the specified Amazon Connect instance, with optional filtering.
-
#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups in an Connect Customer instance, with optional filtering.
-
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users in an Connect Customer instance, with optional filtering.
-
#search_views(params = {}) ⇒ Types::SearchViewsResponse
Searches views based on name, description, or tags.
-
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Connect Customer instance using
State,NameStartsWith, andLanguageCode. -
#search_workspace_associations(params = {}) ⇒ Types::SearchWorkspaceAssociationsResponse
Searches for workspace associations with users or routing profiles based on various criteria.
-
#search_workspaces(params = {}) ⇒ Types::SearchWorkspacesResponse
Searches workspaces based on name, description, visibility, or tags.
-
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Connect Customer.
-
#send_outbound_email(params = {}) ⇒ Struct
Send outbound email for outbound campaigns.
-
#send_outbound_web_notification(params = {}) ⇒ Struct
Sends an outbound web notification to a customer's web browser for outbound campaigns.
-
#start_assistant_contact(params = {}) ⇒ Types::StartAssistantContactResponse
Starts a chat contact with an AI agent.
-
#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_conversational_analytics_job(params = {}) ⇒ Types::StartContactConversationalAnalyticsJobResponse
Starts a Contact Lens post-call analytics job for the specified contact.
-
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
Starts an empty evaluation in the specified Connect Customer instance, using the given evaluation form for the particular contact.
-
#start_contact_media_processing(params = {}) ⇒ Struct
Enables in-flight message processing for an ongoing chat session.
-
#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_evaluation_form_validation(params = {}) ⇒ Types::StartEvaluationFormValidationResponse
Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance.
-
#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse
Initiates a new outbound SMS or WhatsApp 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_test_case_execution(params = {}) ⇒ Types::StartTestCaseExecutionResponse
Starts executing a published test case.
-
#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_media_processing(params = {}) ⇒ Struct
Stops in-flight message processing for an ongoing chat session.
-
#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.
-
#stop_test_case_execution(params = {}) ⇒ Struct
Stops a running test execution.
-
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
Submits a contact evaluation in the specified Connect Customer 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
TASKorEMAILcontacts 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_attached_files_configuration(params = {}) ⇒ Types::UpdateAttachedFilesConfigurationResponse
Updates the attached files configuration for the specified Connect Customer instance and attachment scope.
-
#update_authentication_profile(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#update_contact(params = {}) ⇒ Struct
This API is in preview release for Connect Customer 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 Connect Customer instance.
-
#update_contact_flow_alias(params = {}) ⇒ Struct
Updates the name, description, or flow version associated with an alias.
-
#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_alias(params = {}) ⇒ Struct
Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
-
#update_contact_flow_module_content(params = {}) ⇒ Struct
Updates specified flow module for the specified Connect Customer 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_contact_task_template(params = {}) ⇒ Struct
Updates the task template association on an existing task contact.
-
#update_cross_region_routing(params = {}) ⇒ Struct
Updates the cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing.
-
#update_data_table_attribute(params = {}) ⇒ Types::UpdateDataTableAttributeResponse
Updates all properties for an attribute using all properties from CreateDataTableAttribute.
-
#update_data_table_metadata(params = {}) ⇒ Types::UpdateDataTableMetadataResponse
Updates the metadata properties of a data table.
-
#update_data_table_primary_values(params = {}) ⇒ Types::UpdateDataTablePrimaryValuesResponse
Updates the primary values for a record.
-
#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 Connect Customer instance.
-
#update_extraction_definition(params = {}) ⇒ Struct
Updates an extraction definition in the specified Connect Customer 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 Connect Customer and is subject to change.
-
#update_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
-
#update_metric_content(params = {}) ⇒ Struct
Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer instance.
-
#update_metric_metadata(params = {}) ⇒ Struct
Updates the name and/or description of an existing metric in the specified Connect Customer instance.
-
#update_notification_content(params = {}) ⇒ Struct
Updates the localized content of an existing notification.
-
#update_outbound_email_contact_message(params = {}) ⇒ Types::UpdateOutboundEmailContactMessageResponse
Updates the draft outbound email message for a contact.
-
#update_participant_authentication(params = {}) ⇒ Struct
Instructs Connect Customer 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 Connect Customer instance or traffic distribution group to another Connect Customer 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 Connect Customer 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 Connect Customer 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 Connect Customer instance.
-
#update_test_case(params = {}) ⇒ Struct
Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case.
-
#update_traffic_distribution(params = {}) ⇒ Struct
Updates the traffic distribution for a given traffic distribution group.
-
#update_user_config(params = {}) ⇒ Struct
Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.
-
#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_notification_status(params = {}) ⇒ Struct
Updates the status of a notification for a specific user, such as marking it as read or hidden.
-
#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 Connect Customer instance.
-
#update_view_metadata(params = {}) ⇒ Struct
Updates the view metadata.
-
#update_workspace_metadata(params = {}) ⇒ Struct
Updates the metadata of a workspace, such as its name and description.
-
#update_workspace_page(params = {}) ⇒ Struct
Updates the configuration of a page in a workspace, including the associated view and input data.
-
#update_workspace_theme(params = {}) ⇒ Struct
Updates the theme configuration for a workspace, including colors and styling.
-
#update_workspace_visibility(params = {}) ⇒ Struct
Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.
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.
479 480 481 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse
Activates an evaluation form in the specified Connect Customer instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
529 530 531 532 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 529 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 Connect Customer instance with the target account. You can associate only one dataset in a single call.
581 582 583 584 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 581 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 Connect Customer and is subject to change.
Associates an approved origin to an Connect Customer instance.
629 630 631 632 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 629 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 Connect Customer and is subject to change.
Allows the specified Connect Customer instance to access the specified Amazon Lex or Amazon Lex V2 bot.
687 688 689 690 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 687 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:PreferredUserArnto restrict contact association to specific preferred user.
Important things to know
Use this API with chat, email, task, and voice contacts. For voice callbacks, this API does not support customer-first mode.
This API can be used to offer a contact to an agent even if the agent is currently at maximum concurrency for the channel.
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:PreferredUserArnto prevent unauthorized contact associations.It respects the IAM context key
connect:PreferredUserArnto 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 Connect Customer quotas in the Connect Customer Administrator Guide.
Endpoints: See Connect Customer endpoints and quotas.
764 765 766 767 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 764 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 Connect Customer uses the vocabulary in post-call and real-time analysis sessions for the given language.
808 809 810 811 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 808 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 Connect Customer 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 Connect Customer 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 Connect Customer endpoints and quotas.
Related operations
DisassociateEmailAddressAlias: Removes the alias association between two email addresses in an Connect Customer 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).
936 937 938 939 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 936 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.
981 982 983 984 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 981 def associate_flow(params = {}, = {}) req = build_request(:associate_flow, params) req.send_request() end |
#associate_hours_of_operations(params = {}) ⇒ Struct
Associates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1028 def associate_hours_of_operations(params = {}, = {}) req = build_request(:associate_hours_of_operations, params) req.send_request() end |
#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse
This API is in preview release for Connect Customer 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.
1139 1140 1141 1142 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1139 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 Connect Customer and is subject to change.
Allows the specified Connect Customer instance to access the specified Lambda function.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1189 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 Connect Customer and is subject to change.
Allows the specified Connect Customer instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1242 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 Connect Customer 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.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1289 def associate_phone_number_contact_flow(params = {}, = {}) req = build_request(:associate_phone_number_contact_flow, params) req.send_request() end |
#associate_queue_email_addresses(params = {}) ⇒ Struct
Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue.
Important things to know
You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50.
The email addresses must already exist in the Connect Customer instance before they can be associated with a queue.
Agents will be able to select from these associated email addresses when handling email contacts in the queue.
For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted.
For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile.
1366 1367 1368 1369 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1366 def associate_queue_email_addresses(params = {}, = {}) req = build_request(:associate_queue_email_addresses, params) req.send_request() end |
#associate_queue_quick_connects(params = {}) ⇒ Struct
Associates a set of quick connects with a queue.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1401 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.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1461 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 Connect Customer and is subject to change.
Associates a security key to the instance.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1515 def associate_security_key(params = {}, = {}) req = build_request(:associate_security_key, params) req.send_request() end |
#associate_security_profiles(params = {}) ⇒ Struct
Associate security profiles with an Entity in an Amazon Connect instance.
1555 1556 1557 1558 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1555 def associate_security_profiles(params = {}, = {}) req = build_request(:associate_security_profiles, 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.
1594 1595 1596 1597 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1594 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.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1631 def associate_user_proficiencies(params = {}, = {}) req = build_request(:associate_user_proficiencies, params) req.send_request() end |
#associate_workspace(params = {}) ⇒ Types::AssociateWorkspaceResponse
Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
1680 1681 1682 1683 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1680 def associate_workspace(params = {}, = {}) req = build_request(:associate_workspace, params) req.send_request() end |
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
Associates a list of analytics datasets for a given Connect Customer instance to a target account. You can associate multiple datasets in a single call.
1735 1736 1737 1738 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1735 def batch_associate_analytics_data_set(params = {}, = {}) req = build_request(:batch_associate_analytics_data_set, params) req.send_request() end |
#batch_create_data_table_value(params = {}) ⇒ Types::BatchCreateDataTableValueResponse
Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.
1817 1818 1819 1820 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1817 def batch_create_data_table_value(params = {}, = {}) req = build_request(:batch_create_data_table_value, params) req.send_request() end |
#batch_delete_data_table_value(params = {}) ⇒ Types::BatchDeleteDataTableValueResponse
Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.
1890 1891 1892 1893 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1890 def batch_delete_data_table_value(params = {}, = {}) req = build_request(:batch_delete_data_table_value, params) req.send_request() end |
#batch_describe_data_table_value(params = {}) ⇒ Types::BatchDescribeDataTableValueResponse
Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
1963 1964 1965 1966 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1963 def batch_describe_data_table_value(params = {}, = {}) req = build_request(:batch_describe_data_table_value, params) req.send_request() end |
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
Removes a list of analytics datasets associated with a given Connect Customer instance. You can disassociate multiple datasets in a single call.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2014 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.
2080 2081 2082 2083 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2080 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.
2130 2131 2132 2133 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2130 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 Connect Customer. 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.
2235 2236 2237 2238 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2235 def batch_put_contact(params = {}, = {}) req = build_request(:batch_put_contact, params) req.send_request() end |
#batch_update_data_table_value(params = {}) ⇒ Types::BatchUpdateDataTableValueResponse
Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.
2310 2311 2312 2313 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2310 def batch_update_data_table_value(params = {}, = {}) req = build_request(:batch_update_data_table_value, params) req.send_request() end |
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Connect Customer instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Connect Customer 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 Connect Customer 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.
2425 2426 2427 2428 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2425 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.
2467 2468 2469 2470 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2467 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 Connect Customer instance.
2526 2527 2528 2529 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2526 def create_agent_status(params = {}, = {}) req = build_request(:create_agent_status, params) req.send_request() end |
#create_attached_file(params = {}) ⇒ Types::CreateAttachedFileResponse
Creates an attached file for a completed voice contact by copying a recording from a source S3 URI into Connect Customer managed storage. Use this API to attach voice recordings to contacts for downstream processing such as conversational analytics.
The AssociatedResourceArn must be the ARN of a completed voice
contact, FileUseCaseType must be set to VOICE_RECORDING, and
FileSourceUri must be a valid S3 URI.
CreateContact, then CreateAttachedFile,
then StartContactConversationalAnalyticsJob to create a contact,
attach a recording, and run post-call analytics.
2619 2620 2621 2622 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2619 def create_attached_file(params = {}, = {}) req = build_request(:create_attached_file, params) req.send_request() end |
#create_auth_code(params = {}) ⇒ Types::CreateAuthCodeResponse
Creates an authorization code for the specified Connect Customer instance. The authorization code can be used to establish a session with scoped permissions defined by the specified scope parameters.
2682 2683 2684 2685 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2682 def create_auth_code(params = {}, = {}) req = build_request(:create_auth_code, 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.
2877 2878 2879 2880 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2877 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 Connect Customer instance.
You can also create and update flows using the Connect Customer Flow language.
2959 2960 2961 2962 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2959 def create_contact_flow(params = {}, = {}) req = build_request(:create_contact_flow, params) req.send_request() end |
#create_contact_flow_alias(params = {}) ⇒ Types::CreateContactFlowAliasResponse
Creates a named alias that points to a specific version of a flow.
3010 3011 3012 3013 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3010 def create_contact_flow_alias(params = {}, = {}) req = build_request(:create_contact_flow_alias, params) req.send_request() end |
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Connect Customer instance.
3094 3095 3096 3097 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3094 def create_contact_flow_module(params = {}, = {}) req = build_request(:create_contact_flow_module, params) req.send_request() end |
#create_contact_flow_module_alias(params = {}) ⇒ Types::CreateContactFlowModuleAliasResponse
Creates a named alias that points to a specific version of a contact flow module.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3146 def create_contact_flow_module_alias(params = {}, = {}) req = build_request(:create_contact_flow_module_alias, params) req.send_request() end |
#create_contact_flow_module_version(params = {}) ⇒ Types::CreateContactFlowModuleVersionResponse
Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.
3195 3196 3197 3198 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3195 def create_contact_flow_module_version(params = {}, = {}) req = build_request(:create_contact_flow_module_version, 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.
3252 3253 3254 3255 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3252 def create_contact_flow_version(params = {}, = {}) req = build_request(:create_contact_flow_version, params) req.send_request() end |
#create_data_table(params = {}) ⇒ Types::CreateDataTableResponse
Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.
3332 3333 3334 3335 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3332 def create_data_table(params = {}, = {}) req = build_request(:create_data_table, params) req.send_request() end |
#create_data_table_attribute(params = {}) ⇒ Types::CreateDataTableAttributeResponse
Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.
3428 3429 3430 3431 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3428 def create_data_table_attribute(params = {}, = {}) req = build_request(:create_data_table_attribute, params) req.send_request() end |
#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse
Create new email address in the specified Connect Customer instance. For more information about email addresses, see Create email addresses in the Connect Customer Administrator Guide.
3500 3501 3502 3503 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3500 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 Connect Customer 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.
3886 3887 3888 3889 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3886 def create_evaluation_form(params = {}, = {}) req = build_request(:create_evaluation_form, params) req.send_request() end |
#create_extraction_definition(params = {}) ⇒ Types::CreateExtractionDefinitionResponse
Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found.
3962 3963 3964 3965 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3962 def create_extraction_definition(params = {}, = {}) req = build_request(:create_extraction_definition, params) req.send_request() end |
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
Creates hours of operation.
4050 4051 4052 4053 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4050 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 Connect Customer hours of operation resource.
4140 4141 4142 4143 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4140 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 Connect Customer and is subject to change.
Initiates an Connect Customer 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 Connect Customer.
For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide.
Connect Customer 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.
4220 4221 4222 4223 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4220 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 Connect Customer instance.
4293 4294 4295 4296 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4293 def create_integration_association(params = {}, = {}) req = build_request(:create_integration_association, params) req.send_request() end |
#create_metric(params = {}) ⇒ Types::CreateMetricResponse
Creates a new metric definition for the specified Connect Customer instance. You can create custom metrics that use formulas referencing existing Amazon Web Services-managed metrics, optionally with filters applied.
4407 4408 4409 4410 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4407 def create_metric(params = {}, = {}) req = build_request(:create_metric, params) req.send_request() end |
#create_notification(params = {}) ⇒ Types::CreateNotificationResponse
Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.
4496 4497 4498 4499 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4496 def create_notification(params = {}, = {}) req = build_request(:create_notification, 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.
4576 4577 4578 4579 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4576 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 Connect Customer Administrator Guide.
4699 4700 4701 4702 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4699 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 Connect Customer instance. A predefined attribute is made up of a name and a value.
For the predefined attributes per instance quota, see Connect Customer 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 Connect Customer endpoints and quotas.
4774 4775 4776 4777 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4774 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 Connect Customer Administrator Guide.
4841 4842 4843 4844 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4841 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 Connect Customer for mobile chat in the Connect Customer Administrator Guide.
4915 4916 4917 4918 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4915 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 Connect Customer instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer 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
instancein 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.
5031 5032 5033 5034 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5031 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 Connect Customer instance.
5102 5103 5104 5105 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5102 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.
5233 5234 5235 5236 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5233 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 Connect Customer instance.
Use the Rules Function language to code conditions for the rule.
5457 5458 5459 5460 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5457 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 Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
5602 5603 5604 5605 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5602 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 Connect Customer instance.
5747 5748 5749 5750 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5747 def create_task_template(params = {}, = {}) req = build_request(:create_task_template, params) req.send_request() end |
#create_test_case(params = {}) ⇒ Types::CreateTestCaseResponse
Creates a test case with its content and metadata for the specified Amazon Connect instance.
5833 5834 5835 5836 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5833 def create_test_case(params = {}, = {}) req = build_request(:create_test_case, params) req.send_request() end |
#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse
Creates a traffic distribution group given an Connect Customer 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 Connect Customer Administrator Guide.
5913 5914 5915 5916 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5913 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.
5965 5966 5967 5968 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5965 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 Connect Customer instance.
Certain UserIdentityInfo parameters are required in some
situations. For example, Email, FirstName and LastName are
required if you are using Connect Customer or SAML for identity
management.
PhoneConfig cannot be set simultaneously with their
corresponding channel-specific configuration parameters. Specifically:
PhoneConfig.AutoAcceptconflicts withAutoAcceptConfigsPhoneConfig.AfterContactWorkTimeLimitconflicts withAfterContactWorkConfigsPhoneConfig.PhoneTypeandPhoneConfig.PhoneNumberconflict withPhoneNumberConfigsPhoneConfig.PersistentConnectionconflicts withPersistentConnectionConfigs
We recommend using channel-specific parameters such as
AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs,
PersistentConnectionConfigs, and VoiceEnhancementConfigs for
per-channel configuration.
For information about how to create users using the Connect Customer admin website, see Add Users in the Connect Customer Administrator Guide.
6168 6169 6170 6171 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6168 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.
6221 6222 6223 6224 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6221 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.
6312 6313 6314 6315 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6312 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.
6376 6377 6378 6379 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6376 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 Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
6467 6468 6469 6470 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6467 def create_vocabulary(params = {}, = {}) req = build_request(:create_vocabulary, params) req.send_request() end |
#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse
Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.
6609 6610 6611 6612 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6609 def create_workspace(params = {}, = {}) req = build_request(:create_workspace, params) req.send_request() end |
#create_workspace_page(params = {}) ⇒ Struct
Associates a view with a page in a workspace, defining what users see when they navigate to that page.
6660 6661 6662 6663 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6660 def create_workspace_page(params = {}, = {}) req = build_request(:create_workspace_page, params) req.send_request() end |
#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse
Deactivates an evaluation form in the specified Connect Customer instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
6708 6709 6710 6711 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6708 def deactivate_evaluation_form(params = {}, = {}) req = build_request(:deactivate_evaluation_form, params) req.send_request() end |
#delete_all_entity_sessions(params = {}) ⇒ Struct
Deletes all active sessions for the specified entity in the specified
Connect Customer instance. The operation supports only the USER
entity type, so you can use it to sign out all of a user's active
sessions. Use it when you need to end a user's access right away, for
example when they leave your organization or you suspect that their
credentials are compromised.
6754 6755 6756 6757 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6754 def delete_all_entity_sessions(params = {}, = {}) req = build_request(:delete_all_entity_sessions, 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.
6798 6799 6800 6801 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6798 def delete_attached_file(params = {}, = {}) req = build_request(:delete_attached_file, params) req.send_request() end |
#delete_contact_data(params = {}) ⇒ Struct
Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII (such as customer endpoints, additional email recipients, and the email subject) from the contact and its associated contact trace record (CTR). The contact must be in a terminated state.
This deletion is permanent and cannot be undone. Performing this operation permanently deletes the specified PII. There is no retention period; you cannot recover the data after deletion. We remove only the fields that Connect Customer identifies and stores as PII. Any PII that you place in fields outside the scope of this operation remains your responsibility to remove.
6854 6855 6856 6857 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6854 def delete_contact_data(params = {}, = {}) req = build_request(:delete_contact_data, params) req.send_request() end |
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Connect Customer instance.
6886 6887 6888 6889 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6886 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 Connect Customer instance.
6917 6918 6919 6920 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6917 def delete_contact_flow(params = {}, = {}) req = build_request(:delete_contact_flow, params) req.send_request() end |
#delete_contact_flow_alias(params = {}) ⇒ Struct
Deletes an alias from a flow without deleting the version that the alias points to.
6953 6954 6955 6956 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6953 def delete_contact_flow_alias(params = {}, = {}) req = build_request(:delete_contact_flow_alias, params) req.send_request() end |
#delete_contact_flow_module(params = {}) ⇒ Struct
Deletes the specified flow module.
6984 6985 6986 6987 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6984 def delete_contact_flow_module(params = {}, = {}) req = build_request(:delete_contact_flow_module, params) req.send_request() end |
#delete_contact_flow_module_alias(params = {}) ⇒ Struct
Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.
7020 7021 7022 7023 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7020 def delete_contact_flow_module_alias(params = {}, = {}) req = build_request(:delete_contact_flow_module_alias, params) req.send_request() end |
#delete_contact_flow_module_version(params = {}) ⇒ Struct
Removes a specific version of a contact flow module.
7055 7056 7057 7058 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7055 def delete_contact_flow_module_version(params = {}, = {}) req = build_request(:delete_contact_flow_module_version, params) req.send_request() end |
#delete_contact_flow_version(params = {}) ⇒ Struct
Deletes the particular version specified in flow version identifier.
7090 7091 7092 7093 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7090 def delete_contact_flow_version(params = {}, = {}) req = build_request(:delete_contact_flow_version, params) req.send_request() end |
#delete_data_table(params = {}) ⇒ Struct
Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.
7124 7125 7126 7127 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7124 def delete_data_table(params = {}, = {}) req = build_request(:delete_data_table, params) req.send_request() end |
#delete_data_table_attribute(params = {}) ⇒ Types::DeleteDataTableAttributeResponse
Deletes an attribute and all its values from a data table.
7163 7164 7165 7166 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7163 def delete_data_table_attribute(params = {}, = {}) req = build_request(:delete_data_table_attribute, params) req.send_request() end |
#delete_email_address(params = {}) ⇒ Struct
Deletes email address from the specified Connect Customer instance.
7194 7195 7196 7197 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7194 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 Connect Customer 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.
7235 7236 7237 7238 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7235 def delete_evaluation_form(params = {}, = {}) req = build_request(:delete_evaluation_form, params) req.send_request() end |
#delete_extraction_definition(params = {}) ⇒ Struct
Deletes an extraction definition from the specified Connect Customer instance.
7267 7268 7269 7270 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7267 def delete_extraction_definition(params = {}, = {}) req = build_request(:delete_extraction_definition, params) req.send_request() end |
#delete_hours_of_operation(params = {}) ⇒ Struct
Deletes an hours of operation.
7298 7299 7300 7301 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7298 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 Connect Customer hours of operation resource.
7329 7330 7331 7332 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7329 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 Connect Customer and is subject to change.
Deletes the Connect Customer instance. For more information, see Delete your Connect Customer instance in the Connect Customer Administrator Guide.
Connect Customer 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.
7386 7387 7388 7389 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7386 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 Connect Customer instance. The association must not have any use cases associated with it.
7419 7420 7421 7422 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7419 def delete_integration_association(params = {}, = {}) req = build_request(:delete_integration_association, params) req.send_request() end |
#delete_metric(params = {}) ⇒ Struct
Deletes an existing metric from the specified Connect Customer
instance. This operation fails with ResourceConflictException if the
metric is currently in use in a dashboard.
7452 7453 7454 7455 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7452 def delete_metric(params = {}, = {}) req = build_request(:delete_metric, params) req.send_request() end |
#delete_notification(params = {}) ⇒ Struct
Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.
7485 7486 7487 7488 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7485 def delete_notification(params = {}, = {}) req = build_request(:delete_notification, params) req.send_request() end |
#delete_predefined_attribute(params = {}) ⇒ Struct
Deletes a predefined attribute from the specified Connect Customer instance.
7513 7514 7515 7516 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7513 def delete_predefined_attribute(params = {}, = {}) req = build_request(:delete_predefined_attribute, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
7544 7545 7546 7547 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7544 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.
7579 7580 7581 7582 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7579 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.
7610 7611 7612 7613 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7610 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 Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency.
7659 7660 7661 7662 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7659 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.
7690 7691 7692 7693 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7690 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 Connect Customer instance.
7721 7722 7723 7724 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7721 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
7752 7753 7754 7755 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7752 def delete_security_profile(params = {}, = {}) req = build_request(:delete_security_profile, params) req.send_request() end |
#delete_session(params = {}) ⇒ Struct
Deletes a session for the specified Connect Customer instance.
7783 7784 7785 7786 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7783 def delete_session(params = {}, = {}) req = build_request(:delete_session, params) req.send_request() end |
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
7814 7815 7816 7817 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7814 def delete_task_template(params = {}, = {}) req = build_request(:delete_task_template, params) req.send_request() end |
#delete_test_case(params = {}) ⇒ Struct
Deletes the test case that has already been created for the specified Amazon Connect instance.
7841 7842 7843 7844 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7841 def delete_test_case(params = {}, = {}) req = build_request(:delete_test_case, 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 Connect Customer Administrator Guide.
7873 7874 7875 7876 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7873 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.
7908 7909 7910 7911 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7908 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 Connect Customer instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Connect Customer Instance in the Connect Customer 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 Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency.
7961 7962 7963 7964 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7961 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.
7993 7994 7995 7996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7993 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).
8021 8022 8023 8024 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8021 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.
8052 8053 8054 8055 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8052 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.
8093 8094 8095 8096 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8093 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#delete_workspace(params = {}) ⇒ Struct
Deletes a workspace and removes all associated view and resource assignments.
8125 8126 8127 8128 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8125 def delete_workspace(params = {}, = {}) req = build_request(:delete_workspace, params) req.send_request() end |
#delete_workspace_media(params = {}) ⇒ Struct
Deletes a media asset (such as a logo) from a workspace.
8161 8162 8163 8164 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8161 def delete_workspace_media(params = {}, = {}) req = build_request(:delete_workspace_media, params) req.send_request() end |
#delete_workspace_page(params = {}) ⇒ Struct
Removes the association between a view and a page in a workspace. The page will display the default view after deletion.
8197 8198 8199 8200 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8197 def delete_workspace_page(params = {}, = {}) req = build_request(:delete_workspace_page, params) req.send_request() end |
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
Describes an agent status.
8244 8245 8246 8247 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8244 def describe_agent_status(params = {}, = {}) req = build_request(:describe_agent_status, params) req.send_request() end |
#describe_attached_files_configuration(params = {}) ⇒ Types::DescribeAttachedFilesConfigurationResponse
Describes the attached files configuration for the specified Connect Customer instance and attachment scope.
If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.
8293 8294 8295 8296 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8293 def describe_attached_files_configuration(params = {}, = {}) req = build_request(:describe_attached_files_configuration, params) req.send_request() end |
#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse
This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
8349 8350 8351 8352 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8349 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 Connect Customer 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
SystemEndpointis not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACKContact information remains available in Connect Customer for 24 months from the
InitiationTimestamp, and then it is deleted. Only contact information that is available in Connect Customer is returned by this API.
Endpoints: See Connect Customer endpoints and quotas.
8628 8629 8630 8631 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8628 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 Connect Customer instance.
8914 8915 8916 8917 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8914 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 Connect Customer 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
8980 8981 8982 8983 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8980 def describe_contact_flow(params = {}, = {}) req = build_request(:describe_contact_flow, params) req.send_request() end |
#describe_contact_flow_alias(params = {}) ⇒ Types::DescribeContactFlowAliasResponse
Returns information about a specific flow alias, including the version that it points to.
9029 9030 9031 9032 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9029 def describe_contact_flow_alias(params = {}, = {}) req = build_request(:describe_contact_flow_alias, 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.
9084 9085 9086 9087 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9084 def describe_contact_flow_module(params = {}, = {}) req = build_request(:describe_contact_flow_module, params) req.send_request() end |
#describe_contact_flow_module_alias(params = {}) ⇒ Types::DescribeContactFlowModuleAliasResponse
Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.
9133 9134 9135 9136 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9133 def describe_contact_flow_module_alias(params = {}, = {}) req = build_request(:describe_contact_flow_module_alias, params) req.send_request() end |
#describe_data_table(params = {}) ⇒ Types::DescribeDataTableResponse
Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
9188 9189 9190 9191 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9188 def describe_data_table(params = {}, = {}) req = build_request(:describe_data_table, params) req.send_request() end |
#describe_data_table_attribute(params = {}) ⇒ Types::DescribeDataTableAttributeResponse
Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
9254 9255 9256 9257 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9254 def describe_data_table_attribute(params = {}, = {}) req = build_request(:describe_data_table_attribute, params) req.send_request() end |
#describe_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse
Describe email address form the specified Connect Customer instance.
9309 9310 9311 9312 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9309 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 Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is described.
9511 9512 9513 9514 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9511 def describe_evaluation_form(params = {}, = {}) req = build_request(:describe_evaluation_form, params) req.send_request() end |
#describe_extraction_definition(params = {}) ⇒ Types::DescribeExtractionDefinitionResponse
Describes an extraction definition in the specified Connect Customer instance.
9560 9561 9562 9563 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9560 def describe_extraction_definition(params = {}, = {}) req = build_request(:describe_extraction_definition, params) req.send_request() end |
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
Describes the hours of operation.
9615 9616 9617 9618 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9615 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.
9672 9673 9674 9675 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9672 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 Connect Customer 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.
9734 9735 9736 9737 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9734 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 Connect Customer and is subject to change.
Describes the specified instance attribute.
9775 9776 9777 9778 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9775 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 Connect Customer and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
9832 9833 9834 9835 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9832 def describe_instance_storage_config(params = {}, = {}) req = build_request(:describe_instance_storage_config, params) req.send_request() end |
#describe_metric(params = {}) ⇒ Types::DescribeMetricResponse
Retrieves the full definition of an existing metric from the specified Connect Customer instance.
9919 9920 9921 9922 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9919 def describe_metric(params = {}, = {}) req = build_request(:describe_metric, params) req.send_request() end |
#describe_notification(params = {}) ⇒ Types::DescribeNotificationResponse
Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.
9969 9970 9971 9972 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9969 def describe_notification(params = {}, = {}) req = build_request(:describe_notification, params) req.send_request() end |
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Connect Customer 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.
10020 10021 10022 10023 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10020 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 Connect Customer 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 Connect Customer quotas.
Endpoints: See Connect Customer endpoints and quotas.
10084 10085 10086 10087 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10084 def describe_predefined_attribute(params = {}, = {}) req = build_request(:describe_predefined_attribute, params) req.send_request() end |
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
10128 10129 10130 10131 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10128 def describe_prompt(params = {}, = {}) req = build_request(:describe_prompt, params) req.send_request() end |
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
Describes the specified queue.
10179 10180 10181 10182 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10179 def describe_queue(params = {}, = {}) req = build_request(:describe_queue, params) req.send_request() end |
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
10230 10231 10232 10233 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10230 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.
10304 10305 10306 10307 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10304 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 Connect Customer instance.
10418 10419 10420 10421 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10418 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 Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
10486 10487 10488 10489 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10486 def describe_security_profile(params = {}, = {}) req = build_request(:describe_security_profile, params) req.send_request() end |
#describe_test_case(params = {}) ⇒ Types::DescribeTestCaseResponse
Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.
10542 10543 10544 10545 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10542 def describe_test_case(params = {}, = {}) req = build_request(:describe_test_case, params) req.send_request() end |
#describe_traffic_distribution_group(params = {}) ⇒ Types::DescribeTrafficDistributionGroupResponse
Gets details and status of a traffic distribution group.
10581 10582 10583 10584 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10581 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 Connect Customer 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.
10664 10665 10666 10667 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10664 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.
10733 10734 10735 10736 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10733 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 Connect Customer instance.
10791 10792 10793 10794 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10791 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 Connect Customer 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
Connect Customer 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.
10853 10854 10855 10856 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10853 def describe_view(params = {}, = {}) req = build_request(:describe_view, params) req.send_request() end |
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
10899 10900 10901 10902 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10899 def describe_vocabulary(params = {}, = {}) req = build_request(:describe_vocabulary, params) req.send_request() end |
#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse
Retrieves details about a workspace, including its configuration and metadata.
10986 10987 10988 10989 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10986 def describe_workspace(params = {}, = {}) req = build_request(:describe_workspace, params) req.send_request() end |
#disassociate_analytics_data_set(params = {}) ⇒ Struct
Removes the dataset ID associated with a given Connect Customer instance.
11025 11026 11027 11028 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11025 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 Connect Customer and is subject to change.
Revokes access to integrated applications from Connect Customer.
11073 11074 11075 11076 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11073 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 Connect Customer and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
11131 11132 11133 11134 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11131 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 Connect Customer 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 Connect Customer endpoints and quotas.
Related operations
AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Connect Customer 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).
11259 11260 11261 11262 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11259 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.
11300 11301 11302 11303 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11300 def disassociate_flow(params = {}, = {}) req = build_request(:disassociate_flow, params) req.send_request() end |
#disassociate_hours_of_operations(params = {}) ⇒ Struct
Disassociates a set of hours of operations with another hours of operation. For more information about inheriting overrides from parent hours of operation, see Hours of operation overrides in the Administrator Guide.
11343 11344 11345 11346 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11343 def disassociate_hours_of_operations(params = {}, = {}) req = build_request(:disassociate_hours_of_operations, params) req.send_request() end |
#disassociate_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
11397 11398 11399 11400 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11397 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 Connect Customer and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
11447 11448 11449 11450 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11447 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 Connect Customer and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
11501 11502 11503 11504 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11501 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 Connect Customer 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.
11544 11545 11546 11547 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11544 def disassociate_phone_number_contact_flow(params = {}, = {}) req = build_request(:disassociate_phone_number_contact_flow, params) req.send_request() end |
#disassociate_queue_email_addresses(params = {}) ⇒ Struct
Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue.
Important things to know
Agents will no longer see these email addresses in their "From" address selection options for this queue.
The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed.
Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).
11610 11611 11612 11613 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11610 def disassociate_queue_email_addresses(params = {}, = {}) req = build_request(:disassociate_queue_email_addresses, params) req.send_request() end |
#disassociate_queue_quick_connects(params = {}) ⇒ Struct
Disassociates a set of quick connects from a queue.
11645 11646 11647 11648 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11645 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.
11699 11700 11701 11702 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11699 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 Connect Customer and is subject to change.
Deletes the specified security key.
11748 11749 11750 11751 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11748 def disassociate_security_key(params = {}, = {}) req = build_request(:disassociate_security_key, params) req.send_request() end |
#disassociate_security_profiles(params = {}) ⇒ Struct
Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.
11788 11789 11790 11791 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11788 def disassociate_security_profiles(params = {}, = {}) req = build_request(:disassociate_security_profiles, 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.
11827 11828 11829 11830 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11827 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.
11863 11864 11865 11866 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11863 def disassociate_user_proficiencies(params = {}, = {}) req = build_request(:disassociate_user_proficiencies, params) req.send_request() end |
#disassociate_workspace(params = {}) ⇒ Types::DisassociateWorkspaceResponse
Removes the association between a workspace and one or more users or routing profiles.
11912 11913 11914 11915 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11912 def disassociate_workspace(params = {}, = {}) req = build_request(:disassociate_workspace, 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.
11950 11951 11952 11953 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11950 def dismiss_user_contact(params = {}, = {}) req = build_request(:dismiss_user_contact, params) req.send_request() end |
#evaluate_data_table_values(params = {}) ⇒ Types::EvaluateDataTableValuesResponse
Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12033 12034 12035 12036 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12033 def evaluate_data_table_values(params = {}, = {}) req = build_request(:evaluate_data_table_values, 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.
12123 12124 12125 12126 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12123 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.
12156 12157 12158 12159 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12156 def get_contact_attributes(params = {}, = {}) req = build_request(:get_contact_attributes, params) req.send_request() end |
#get_contact_metrics(params = {}) ⇒ Types::GetContactMetricsResponse
Retrieves contact metric data for a specified contact.
Use cases
Following are common use cases for position in queue and estimated wait time:
Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience.
Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold.
Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues.
Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable.
Important things to know
Metrics are only available while the contact is actively in queue.
For more information, see the Position in queue metric in the Connect Customer Administrator Guide.
Endpoints: See Connect Customer endpoints and quotas.
12245 12246 12247 12248 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12245 def get_contact_metrics(params = {}, = {}) req = build_request(:get_contact_metrics, params) req.send_request() end |
#get_cross_region_routing(params = {}) ⇒ Types::GetCrossRegionRoutingResponse
Retrieves the current cross-region routing configuration for an Amazon Connect Global Resiliency instance enabled for global routing. This operation returns whether cross-region routing is currently enabled or disabled (isolated) for the instance.
12287 12288 12289 12290 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12287 def get_cross_region_routing(params = {}, = {}) req = build_request(:get_cross_region_routing, params) req.send_request() end |
#get_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse
Gets the real-time metric data from the specified Connect Customer instance.
For a description of each metric, see Metrics definitions in the Connect Customer 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.
12636 12637 12638 12639 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12636 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12749 12750 12751 12752 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12749 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.
12807 12808 12809 12810 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12807 def get_effective_hours_of_operations(params = {}, = {}) req = build_request(:get_effective_hours_of_operations, params) req.send_request() end |
#get_evaluation_form_validation(params = {}) ⇒ Types::GetEvaluationFormValidationResponse
Retrieves the status and results of a validation process started by
StartEvaluationFormValidation. Returns the current execution
status (IN_PROGRESS, COMPLETED, or FAILED), the validated form
version, and when completed, a list of findings that identify
structural issues and quality improvements for the evaluation form,
and may include suggested fixes. If the validation failed, a reason is
provided indicating the cause of the failure.
12875 12876 12877 12878 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12875 def get_evaluation_form_validation(params = {}, = {}) req = build_request(:get_evaluation_form_validation, params) req.send_request() end |
#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse
Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer Administrator Guide.
Provided identity: Principal: .... User: .... cannot be used for
federation with Connect Customer
12937 12938 12939 12940 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12937 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.
12988 12989 12990 12991 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12988 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 Connect Customer instance.
For a description of each historical metric, see Metrics definitions in the Connect Customer 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.
13384 13385 13386 13387 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13384 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 Connect Customer 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 Connect Customer 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.
15990 15991 15992 15993 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15990 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.
16031 16032 16033 16034 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16031 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 Connect Customer instance.
16115 16116 16117 16118 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16115 def get_task_template(params = {}, = {}) req = build_request(:get_task_template, params) req.send_request() end |
#get_test_case_execution_summary(params = {}) ⇒ Types::GetTestCaseExecutionSummaryResponse
Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.
16160 16161 16162 16163 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16160 def get_test_case_execution_summary(params = {}, = {}) req = build_request(:get_test_case_execution_summary, params) req.send_request() end |
#get_traffic_distribution(params = {}) ⇒ Types::GetTrafficDistributionResponse
Retrieves the current traffic distribution for a given traffic distribution group.
16208 16209 16210 16211 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16208 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 Connect Customer instance. You can call this API only in the same Amazon Web Services Region where the Connect Customer instance was created.
Call the DescribePhoneNumber API to verify the status of a
previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
16305 16306 16307 16308 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16305 def import_phone_number(params = {}, = {}) req = build_request(:import_phone_number, params) req.send_request() end |
#import_workspace_media(params = {}) ⇒ Struct
Imports a media asset (such as a logo) for use in a workspace.
16346 16347 16348 16349 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16346 def import_workspace_media(params = {}, = {}) req = build_request(:import_workspace_media, 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.
16403 16404 16405 16406 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16403 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 Connect Customer instance.
16458 16459 16460 16461 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16458 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 Connect Customer instance.
16506 16507 16508 16509 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16506 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 Connect Customer 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.
16558 16559 16560 16561 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16558 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.
16617 16618 16619 16620 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16617 def list_associated_contacts(params = {}, = {}) req = build_request(:list_associated_contacts, params) req.send_request() end |
#list_attached_files_configurations(params = {}) ⇒ Types::ListAttachedFilesConfigurationsResponse
Provides summary information about the attached files configurations for the specified Connect Customer instance.
This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16675 16676 16677 16678 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16675 def list_attached_files_configurations(params = {}, = {}) req = build_request(:list_attached_files_configurations, params) req.send_request() end |
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16733 16734 16735 16736 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16733 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 Connect Customer 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.
16792 16793 16794 16795 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16792 def list_bots(params = {}, = {}) req = build_request(:list_bots, params) req.send_request() end |
#list_child_hours_of_operations(params = {}) ⇒ Types::ListChildHoursOfOperationsResponse
Provides information about the child hours of operations for the specified parent hours of operation.
For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16860 16861 16862 16863 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16860 def list_child_hours_of_operations(params = {}, = {}) req = build_request(:list_child_hours_of_operations, params) req.send_request() end |
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16934 16935 16936 16937 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16934 def list_contact_evaluations(params = {}, = {}) req = build_request(:list_contact_evaluations, params) req.send_request() end |
#list_contact_flow_aliases(params = {}) ⇒ Types::ListContactFlowAliasesResponse
Lists the aliases associated with a flow, including the version that each alias points to.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16993 16994 16995 16996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16993 def list_contact_flow_aliases(params = {}, = {}) req = build_request(:list_contact_flow_aliases, params) req.send_request() end |
#list_contact_flow_module_aliases(params = {}) ⇒ Types::ListContactFlowModuleAliasesResponse
Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17051 17052 17053 17054 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17051 def list_contact_flow_module_aliases(params = {}, = {}) req = build_request(:list_contact_flow_module_aliases, params) req.send_request() end |
#list_contact_flow_module_versions(params = {}) ⇒ Types::ListContactFlowModuleVersionsResponse
Retrieves a paginated list of all versions for a specific contact flow module.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17106 17107 17108 17109 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17106 def list_contact_flow_module_versions(params = {}, = {}) req = build_request(:list_contact_flow_module_versions, params) req.send_request() end |
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17162 17163 17164 17165 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17162 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 Connect Customer instance and flow identifier.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17215 17216 17217 17218 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17215 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 Connect Customer instance.
You can also create and update flows using the Connect Customer Flow language.
For more information about flows, see Flows in the Connect Customer Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17285 17286 17287 17288 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17285 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 Connect Customer 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.
17372 17373 17374 17375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17372 def list_contact_references(params = {}, = {}) req = build_request(:list_contact_references, params) req.send_request() end |
#list_data_table_attributes(params = {}) ⇒ Types::ListDataTableAttributesResponse
Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17455 17456 17457 17458 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17455 def list_data_table_attributes(params = {}, = {}) req = build_request(:list_data_table_attributes, params) req.send_request() end |
#list_data_table_primary_values(params = {}) ⇒ Types::ListDataTablePrimaryValuesResponse
Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17526 17527 17528 17529 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17526 def list_data_table_primary_values(params = {}, = {}) req = build_request(:list_data_table_primary_values, params) req.send_request() end |
#list_data_table_values(params = {}) ⇒ Types::ListDataTableValuesResponse
Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17604 17605 17606 17607 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17604 def list_data_table_values(params = {}, = {}) req = build_request(:list_data_table_values, params) req.send_request() end |
#list_data_tables(params = {}) ⇒ Types::ListDataTablesResponse
Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17653 17654 17655 17656 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17653 def list_data_tables(params = {}, = {}) req = build_request(:list_data_tables, params) req.send_request() end |
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17715 17716 17717 17718 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17715 def list_default_vocabularies(params = {}, = {}) req = build_request(:list_default_vocabularies, params) req.send_request() end |
#list_entity_security_profiles(params = {}) ⇒ Types::ListEntitySecurityProfilesResponse
Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17769 17770 17771 17772 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17769 def list_entity_security_profiles(params = {}, = {}) req = build_request(:list_entity_security_profiles, params) req.send_request() end |
#list_evaluation_form_ai_versions(params = {}) ⇒ Types::ListEvaluationFormAIVersionsResponse
Lists the available AI versions for evaluation forms in the specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17825 17826 17827 17828 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17825 def list_evaluation_form_ai_versions(params = {}, = {}) req = build_request(:list_evaluation_form_ai_versions, params) req.send_request() end |
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17886 17887 17888 17889 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17886 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17944 17945 17946 17947 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17944 def list_evaluation_forms(params = {}, = {}) req = build_request(:list_evaluation_forms, params) req.send_request() end |
#list_extraction_definitions(params = {}) ⇒ Types::ListExtractionDefinitionsResponse
Lists extraction definitions in the specified Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17999 18000 18001 18002 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17999 def list_extraction_definitions(params = {}, = {}) req = build_request(:list_extraction_definitions, 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.
18053 18054 18055 18056 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18053 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.
18125 18126 18127 18128 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18125 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 Connect Customer instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Connect Customer Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18187 18188 18189 18190 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18187 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 Connect Customer 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.
18240 18241 18242 18243 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18240 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 Connect Customer 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.
18307 18308 18309 18310 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18307 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 Connect Customer 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.
18361 18362 18363 18364 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18361 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18427 18428 18429 18430 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18427 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 Connect Customer 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.
18479 18480 18481 18482 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18479 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 Connect Customer 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.
18538 18539 18540 18541 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18538 def list_lex_bots(params = {}, = {}) req = build_request(:list_lex_bots, params) req.send_request() end |
#list_metrics(params = {}) ⇒ Types::ListMetricsResponse
Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18599 18600 18601 18602 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18599 def list_metrics(params = {}, = {}) req = build_request(:list_metrics, params) req.send_request() end |
#list_notifications(params = {}) ⇒ Types::ListNotificationsResponse
Retrieves a paginated list of all notifications in the Amazon Connect instance.
18658 18659 18660 18661 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18658 def list_notifications(params = {}, = {}) req = build_request(:list_notifications, params) req.send_request() end |
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Provides information about the phone numbers for the specified Connect Customer instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Connect Customer 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_FREEorDID.The phone number
Arnvalue 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.
18753 18754 18755 18756 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18753 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 Connect Customer 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 Connect Customer Administrator Guide.
ListPhoneNumbersV2 returns only the
phone numbers claimed to the instance.
- When given a traffic distribution group ARN
ListPhoneNumbersV2returns 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.
18855 18856 18857 18858 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18855 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 Connect Customer 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 Connect Customer quotas.
Endpoints: See Connect Customer endpoints and quotas.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18924 18925 18926 18927 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18924 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18973 18974 18975 18976 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18973 def list_prompts(params = {}, = {}) req = build_request(:list_prompts, params) req.send_request() end |
#list_queue_email_addresses(params = {}) ⇒ Types::ListQueueEmailAddressesResponse
Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units.
Important things to know
The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email.
Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue.
The list includes both explicitly associated email addresses and any default outbound email address configured for the queue.
Results are paginated to handle queues with many associated email addresses (up to 50 per queue).
19048 19049 19050 19051 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19048 def list_queue_email_addresses(params = {}, = {}) req = build_request(:list_queue_email_addresses, 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.
19110 19111 19112 19113 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19110 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 Connect Customer 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 Connect Customer Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19181 19182 19183 19184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19181 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19244 19245 19246 19247 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19244 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.
19400 19401 19402 19403 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19400 def list_realtime_contact_analysis_segments_v2(params = {}, = {}) req = build_request(:list_realtime_contact_analysis_segments_v2, params) req.send_request() end |
#list_replication_findings(params = {}) ⇒ Types::ListReplicationFindingsResponse
Lists replication findings for resources of a specified resource type in a specified Connect Customer instance. A replication finding describes a single resource whose replication to one or more Regions is incomplete or has encountered an error. Results are returned in pages. This operation is available only for instances that are set up for Global Resiliency.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19484 19485 19486 19487 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19484 def list_replication_findings(params = {}, = {}) req = build_request(:list_replication_findings, 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 Connect Customer agent workspace in the Connect Customer 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 Connect Customer endpoints and quotas.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19572 19573 19574 19575 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19572 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.
19634 19635 19636 19637 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19634 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 Connect Customer instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Connect Customer Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19697 19698 19699 19700 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19697 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19763 19764 19765 19766 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19763 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 Connect Customer 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.
19817 19818 19819 19820 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19817 def list_security_keys(params = {}, = {}) req = build_request(:list_security_keys, params) req.send_request() end |
#list_security_profile_ai_agents(params = {}) ⇒ Types::ListSecurityProfileAIAgentsResponse
Returns a list of the allowed AI agents in a specific security profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19875 19876 19877 19878 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19875 def list_security_profile_ai_agents(params = {}, = {}) req = build_request(:list_security_profile_ai_agents, params) req.send_request() end |
#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse
Returns a list of third-party applications or MCP Servers in a specific security profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19935 19936 19937 19938 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19935 def list_security_profile_applications(params = {}, = {}) req = build_request(:list_security_profile_applications, params) req.send_request() end |
#list_security_profile_flow_modules(params = {}) ⇒ Types::ListSecurityProfileFlowModulesResponse
A list of Flow Modules an AI Agent can invoke as a tool
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19993 19994 19995 19996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 19993 def list_security_profile_flow_modules(params = {}, = {}) req = build_request(:list_security_profile_flow_modules, 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 Connect Customer 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.
20059 20060 20061 20062 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20059 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 Connect Customer instance.
For more information about security profiles, see Security Profiles in the Connect Customer 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.
20124 20125 20126 20127 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20124 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 Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.
20168 20169 20170 20171 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20168 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20238 20239 20240 20241 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20238 def list_task_templates(params = {}, = {}) req = build_request(:list_task_templates, params) req.send_request() end |
#list_test_case_execution_records(params = {}) ⇒ Types::ListTestCaseExecutionRecordsResponse
Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.
20296 20297 20298 20299 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20296 def list_test_case_execution_records(params = {}, = {}) req = build_request(:list_test_case_execution_records, params) req.send_request() end |
#list_test_case_executions(params = {}) ⇒ Types::ListTestCaseExecutionsResponse
Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.
20365 20366 20367 20368 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20365 def list_test_case_executions(params = {}, = {}) req = build_request(:list_test_case_executions, params) req.send_request() end |
#list_test_cases(params = {}) ⇒ Types::ListTestCasesResponse
Lists the test cases present in the specific Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20413 20414 20415 20416 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20413 def list_test_cases(params = {}, = {}) req = build_request(:list_test_cases, 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.
20459 20460 20461 20462 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20459 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.
20512 20513 20514 20515 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20512 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.
20566 20567 20568 20569 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20566 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 Connect Customer instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20627 20628 20629 20630 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20627 def list_user_hierarchy_groups(params = {}, = {}) req = build_request(:list_user_hierarchy_groups, params) req.send_request() end |
#list_user_notifications(params = {}) ⇒ Types::ListUserNotificationsResponse
Retrieves a paginated list of notifications for a specific user, including the notification status for that user.
20687 20688 20689 20690 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20687 def list_user_notifications(params = {}, = {}) req = build_request(:list_user_notifications, 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.
20741 20742 20743 20744 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20741 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20795 20796 20797 20798 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20795 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 Connect Customer 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.
20853 20854 20855 20856 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20853 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.
20909 20910 20911 20912 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20909 def list_views(params = {}, = {}) req = build_request(:list_views, params) req.send_request() end |
#list_workspace_media(params = {}) ⇒ Types::ListWorkspaceMediaResponse
Lists media assets (such as logos) associated with a workspace.
20948 20949 20950 20951 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 20948 def list_workspace_media(params = {}, = {}) req = build_request(:list_workspace_media, params) req.send_request() end |
#list_workspace_pages(params = {}) ⇒ Types::ListWorkspacePagesResponse
Lists the page configurations in a workspace, including the views assigned to each page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21004 21005 21006 21007 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21004 def list_workspace_pages(params = {}, = {}) req = build_request(:list_workspace_pages, params) req.send_request() end |
#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse
Lists the workspaces in an Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21056 21057 21058 21059 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21056 def list_workspaces(params = {}, = {}) req = build_request(:list_workspaces, 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.
21118 21119 21120 21121 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21118 def monitor_contact(params = {}, = {}) req = build_request(:monitor_contact, params) req.send_request() end |
#pause_contact(params = {}) ⇒ Struct
Pauses an ongoing task or email contact.
21149 21150 21151 21152 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21149 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 Connect Customer. 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 Connect Customer Administrator Guide.
21194 21195 21196 21197 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21194 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 Connect Customer 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 Connect Customer admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
21258 21259 21260 21261 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21258 def release_phone_number(params = {}, = {}) req = build_request(:release_phone_number, params) req.send_request() end |
#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse
Replicates an Connect Customer instance in the specified Amazon Web Services Region and copies configuration information for Connect Customer resources across Amazon Web Services Regions.
For more information about replicating an Connect Customer instance, see Create a replica of your existing Connect Customer instance in the Connect Customer Administrator Guide.
21328 21329 21330 21331 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21328 def replicate_instance(params = {}, = {}) req = build_request(:replicate_instance, params) req.send_request() end |
#resume_contact(params = {}) ⇒ Struct
Resumes a task or email contact in a paused state.
21359 21360 21361 21362 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21359 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.
21405 21406 21407 21408 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21405 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 Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21511 21512 21513 21514 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21511 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
Connect Customer 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.
21586 21587 21588 21589 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21586 def search_available_phone_numbers(params = {}, = {}) req = build_request(:search_available_phone_numbers, params) req.send_request() end |
#search_contact_evaluations(params = {}) ⇒ Types::SearchContactEvaluationsResponse
Searches contact evaluations in an Connect Customer instance, with optional filtering.
Use cases
Following are common uses cases for this API:
Find contact evaluations by using specific search criteria.
Find contact evaluations that are tagged with a specific set of tags.
Important things to know
- A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.
^
Endpoints: See Connect Customer endpoints and quotas.
21808 21809 21810 21811 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21808 def search_contact_evaluations(params = {}, = {}) req = build_request(:search_contact_evaluations, params) req.send_request() end |
#search_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse
Searches the flow modules in an Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21922 21923 21924 21925 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 21922 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 Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22071 22072 22073 22074 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22071 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 Connect Customer instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22296 22297 22298 22299 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22296 def search_contacts(params = {}, = {}) req = build_request(:search_contacts, params) req.send_request() end |
#search_data_tables(params = {}) ⇒ Types::SearchDataTablesResponse
Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22413 22414 22415 22416 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22413 def search_data_tables(params = {}, = {}) req = build_request(:search_data_tables, params) req.send_request() end |
#search_email_addresses(params = {}) ⇒ Types::SearchEmailAddressesResponse
Searches email address in an instance, with optional filtering.
22512 22513 22514 22515 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22512 def search_email_addresses(params = {}, = {}) req = build_request(:search_email_addresses, params) req.send_request() end |
#search_evaluation_forms(params = {}) ⇒ Types::SearchEvaluationFormsResponse
Searches evaluation forms in an Connect Customer instance, with optional filtering.
Use cases
Following are common uses cases for this API:
List all evaluation forms in an instance.
Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.
Find all evaluation forms that are tagged with a specific set of tags.
Important things to know
- A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.
^
Endpoints: See Connect Customer endpoints and quotas.
22671 22672 22673 22674 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22671 def search_evaluation_forms(params = {}, = {}) req = build_request(:search_evaluation_forms, 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.
22788 22789 22790 22791 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22788 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 Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22902 22903 22904 22905 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 22902 def search_hours_of_operations(params = {}, = {}) req = build_request(:search_hours_of_operations, params) req.send_request() end |
#search_metrics(params = {}) ⇒ Types::SearchMetricsResponse
Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters. Use pagination to ensure that the operation returns quickly and successfully.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23050 23051 23052 23053 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23050 def search_metrics(params = {}, = {}) req = build_request(:search_metrics, params) req.send_request() end |
#search_notifications(params = {}) ⇒ Types::SearchNotificationsResponse
Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.
23165 23166 23167 23168 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23165 def search_notifications(params = {}, = {}) req = build_request(:search_notifications, 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 Connect Customer quotas.
Endpoints: See Connect Customer endpoints and quotas.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23262 23263 23264 23265 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23262 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 Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23365 23366 23367 23368 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23365 def search_prompts(params = {}, = {}) req = build_request(:search_prompts, params) req.send_request() end |
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23483 23484 23485 23486 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23483 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 Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23593 23594 23595 23596 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23593 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 Connect Customer instance using optional search criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23680 23681 23682 23683 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23680 def (params = {}, = {}) req = build_request(:search_resource_tags, params) req.send_request() end |
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Connect Customer 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.
23820 23821 23822 23823 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23820 def search_routing_profiles(params = {}, = {}) req = build_request(:search_routing_profiles, params) req.send_request() end |
#search_rules(params = {}) ⇒ Types::SearchRulesResponse
Searches rules in an Connect Customer instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23983 23984 23985 23986 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 23983 def search_rules(params = {}, = {}) req = build_request(:search_rules, params) req.send_request() end |
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Connect Customer instance, with optional filtering.
For information about security profiles, see Security Profiles in the Connect Customer 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.
24106 24107 24108 24109 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24106 def search_security_profiles(params = {}, = {}) req = build_request(:search_security_profiles, params) req.send_request() end |
#search_test_cases(params = {}) ⇒ Types::SearchTestCasesResponse
Searches for test cases in the specified Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24215 24216 24217 24218 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24215 def search_test_cases(params = {}, = {}) req = build_request(:search_test_cases, params) req.send_request() end |
#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups in an Connect Customer 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.
24347 24348 24349 24350 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24347 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 Connect Customer 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.
24546 24547 24548 24549 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24546 def search_users(params = {}, = {}) req = build_request(:search_users, params) req.send_request() end |
#search_views(params = {}) ⇒ Types::SearchViewsResponse
Searches views based on name, description, or tags.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24663 24664 24665 24666 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24663 def search_views(params = {}, = {}) req = build_request(:search_views, params) req.send_request() end |
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Connect Customer instance
using State, NameStartsWith, and LanguageCode.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24736 24737 24738 24739 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24736 def search_vocabularies(params = {}, = {}) req = build_request(:search_vocabularies, params) req.send_request() end |
#search_workspace_associations(params = {}) ⇒ Types::SearchWorkspaceAssociationsResponse
Searches for workspace associations with users or routing profiles based on various criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24842 24843 24844 24845 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24842 def search_workspace_associations(params = {}, = {}) req = build_request(:search_workspace_associations, params) req.send_request() end |
#search_workspaces(params = {}) ⇒ Types::SearchWorkspacesResponse
Searches workspaces based on name, description, visibility, or tags.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24949 24950 24951 24952 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 24949 def search_workspaces(params = {}, = {}) req = build_request(:search_workspaces, params) req.send_request() end |
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Connect Customer. 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.
25034 25035 25036 25037 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25034 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 Connect Customer outbound campaigns.
25147 25148 25149 25150 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25147 def send_outbound_email(params = {}, = {}) req = build_request(:send_outbound_email, params) req.send_request() end |
#send_outbound_web_notification(params = {}) ⇒ Struct
Sends an outbound web notification to a customer's web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns.
25252 25253 25254 25255 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25252 def send_outbound_web_notification(params = {}, = {}) req = build_request(:send_outbound_web_notification, params) req.send_request() end |
#start_assistant_contact(params = {}) ⇒ Types::StartAssistantContactResponse
Starts a chat contact with an AI agent.
Use the returned ParticipantToken with the
CreateParticipantConnection operation.
For more information about chat, see the following topics in the Connect Customer Administrator Guide:
25373 25374 25375 25376 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25373 def start_assistant_contact(params = {}, = {}) req = build_request(:start_assistant_contact, 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 a Connect Customer Case, Connect Customer Email, or Connect Customer Task.
25487 25488 25489 25490 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25487 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 Connect Customer 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.
To receive connection information directly in the response, set
ConnectionTypes on the request. To initiate real-time message
streaming when the chat is created, set ChatStreamingConfiguration
on the request. Both parameters are optional.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a
TooManyRequestsexception.The quota for concurrent active chats is exceeded. Active chat throttling returns a
LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400
error, your account may not support the ability to configure custom
chat durations. For more information, contact Amazon Web Services
Support.
For more information about chat, see the following topics in the Connect Customer Administrator Guide:
25787 25788 25789 25790 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25787 def start_chat_contact(params = {}, = {}) req = build_request(:start_chat_contact, params) req.send_request() end |
#start_contact_conversational_analytics_job(params = {}) ⇒ Types::StartContactConversationalAnalyticsJobResponse
Starts a Contact Lens post-call analytics job for the specified contact. This API runs Conversational Analytics post-contact analysis on a voice recording that is already attached to the contact, generating transcription, sentiment analysis, redaction, and summarization results based on the provided configuration.
A voice recording must already be attached to the contact before
calling this API. Use CreateAttachedFile to attach a recording from
an S3 source URI.
CreateContact, then CreateAttachedFile,
then StartContactConversationalAnalyticsJob to create a contact,
attach a recording, and run post-call analytics.
25879 25880 25881 25882 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25879 def start_contact_conversational_analytics_job(params = {}, = {}) req = build_request(:start_contact_conversational_analytics_job, params) req.send_request() end |
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
Starts an empty evaluation in the specified Connect Customer 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.
25954 25955 25956 25957 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25954 def start_contact_evaluation(params = {}, = {}) req = build_request(:start_contact_evaluation, params) req.send_request() end |
#start_contact_media_processing(params = {}) ⇒ Struct
Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.
25996 25997 25998 25999 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 25996 def start_contact_media_processing(params = {}, = {}) req = build_request(:start_contact_media_processing, 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.
26061 26062 26063 26064 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26061 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 Connect Customer Administrator Guide.
For more information about chat, see the following topics in the Connect Customer Administrator Guide:
26138 26139 26140 26141 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26138 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.
26329 26330 26331 26332 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26329 def start_email_contact(params = {}, = {}) req = build_request(:start_email_contact, params) req.send_request() end |
#start_evaluation_form_validation(params = {}) ⇒ Types::StartEvaluationFormValidationResponse
Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes.
26385 26386 26387 26388 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26385 def start_evaluation_form_validation(params = {}, = {}) req = build_request(:start_evaluation_form_validation, params) req.send_request() end |
#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse
Initiates a new outbound SMS or WhatsApp contact to a customer.
Response of this API provides the ContactId of the outbound SMS or
WhatsApp 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 contact created.
This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action.
For more information about using SMS or WhatsApp in Connect Customer, see the following topics in the Connect Customer Administrator Guide:
26584 26585 26586 26587 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26584 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.
26682 26683 26684 26685 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26682 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.
Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails.
TrafficType = CAMPAIGN, you must submit a service quota
increase request to the quota Connect Customer campaigns.
26888 26889 26890 26891 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26888 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 Connect Customer Administrator Guide.
26939 26940 26941 26942 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 26939 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 Connect Customer in the Connect Customer Administrator Guide.
When using PreviousContactId and RelatedContactId input
parameters, note the following:
PreviousContactIdAny updates to user-defined task contact attributes on any contact linked through the same
PreviousContactIdwill 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.
RelatedContactIdCopies 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 Connect Customer
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 Connect Customer service
quotas in the Connect Customer Administrator Guide.
27176 27177 27178 27179 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27176 def start_task_contact(params = {}, = {}) req = build_request(:start_task_contact, params) req.send_request() end |
#start_test_case_execution(params = {}) ⇒ Types::StartTestCaseExecutionResponse
Starts executing a published test case.
27226 27227 27228 27229 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27226 def start_test_case_execution(params = {}, = {}) req = build_request(:start_test_case_execution, 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 Connect Customer instance (specified as InstanceId).
27383 27384 27385 27386 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27383 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.
27443 27444 27445 27446 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27443 def stop_contact(params = {}, = {}) req = build_request(:stop_contact, params) req.send_request() end |
#stop_contact_media_processing(params = {}) ⇒ Struct
Stops in-flight message processing for an ongoing chat session.
27474 27475 27476 27477 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27474 def stop_contact_media_processing(params = {}, = {}) req = build_request(:stop_contact_media_processing, 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.
27522 27523 27524 27525 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27522 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.
27563 27564 27565 27566 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27563 def stop_contact_streaming(params = {}, = {}) req = build_request(:stop_contact_streaming, params) req.send_request() end |
#stop_test_case_execution(params = {}) ⇒ Struct
Stops a running test execution.
27607 27608 27609 27610 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27607 def stop_test_case_execution(params = {}, = {}) req = build_request(:stop_test_case_execution, params) req.send_request() end |
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
Submits a contact evaluation in the specified Connect Customer
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.
27682 27683 27684 27685 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27682 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.
27737 27738 27739 27740 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27737 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 Connect Customer usage.
27785 27786 27787 27788 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27785 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, task templates, and custom metrics. For a complete list, see Tagging resources in Connect Customer.
For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.
27829 27830 27831 27832 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27829 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
TASKandEMAILcontacts.Do not use both
QueueIdandUserIdin the same call.The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The
TransferContactAPI can be called only on active contacts.A contact cannot be transferred more than 11 times.
27913 27914 27915 27916 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27913 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 Connect Customer usage.
27955 27956 27957 27958 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27955 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.
27981 27982 27983 27984 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 27981 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent_status(params = {}) ⇒ Struct
Updates agent status.
28032 28033 28034 28035 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28032 def update_agent_status(params = {}, = {}) req = build_request(:update_agent_status, params) req.send_request() end |
#update_attached_files_configuration(params = {}) ⇒ Types::UpdateAttachedFilesConfigurationResponse
Updates the attached files configuration for the specified Connect Customer instance and attachment scope.
If no instance-specific configuration exists, this operation creates one. Partial updates are supported—only specified fields are updated, while unspecified fields retain their current values.
28099 28100 28101 28102 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28099 def update_attached_files_configuration(params = {}, = {}) req = build_request(:update_attached_files_configuration, params) req.send_request() end |
#update_authentication_profile(params = {}) ⇒ Struct
This API is in preview release for Connect Customer and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
28186 28187 28188 28189 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28186 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 Connect Customer 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.
28356 28357 28358 28359 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28356 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 Connect Customer. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Connect Customer 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 Connect Customer Administrator Guide.
28437 28438 28439 28440 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28437 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 Connect
Customer 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.
28508 28509 28510 28511 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28508 def update_contact_evaluation(params = {}, = {}) req = build_request(:update_contact_evaluation, params) req.send_request() end |
#update_contact_flow_alias(params = {}) ⇒ Struct
Updates the name, description, or flow version associated with an alias.
28556 28557 28558 28559 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28556 def update_contact_flow_alias(params = {}, = {}) req = build_request(:update_contact_flow_alias, params) req.send_request() end |
#update_contact_flow_content(params = {}) ⇒ Struct
Updates the specified flow.
You can also create and update flows using the Connect Customer 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.
28605 28606 28607 28608 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28605 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.
28648 28649 28650 28651 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28648 def (params = {}, = {}) req = build_request(:update_contact_flow_metadata, params) req.send_request() end |
#update_contact_flow_module_alias(params = {}) ⇒ Struct
Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
28696 28697 28698 28699 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28696 def update_contact_flow_module_alias(params = {}, = {}) req = build_request(:update_contact_flow_module_alias, params) req.send_request() end |
#update_contact_flow_module_content(params = {}) ⇒ Struct
Updates specified flow module for the specified Connect Customer 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.
28746 28747 28748 28749 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28746 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.
28789 28790 28791 28792 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28789 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 Connect Customer Flow language.
28830 28831 28832 28833 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28830 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.
28949 28950 28951 28952 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28949 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.
28987 28988 28989 28990 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 28987 def update_contact_schedule(params = {}, = {}) req = build_request(:update_contact_schedule, params) req.send_request() end |
#update_contact_task_template(params = {}) ⇒ Struct
Updates the task template association on an existing task contact. You can update the task template on a contact before assignment to support tasks that are created without a template (for example Rules or disconnect flows) or change the agent interaction form to represent the latest task data (for example an initial request that was submitted as a refund gets updated to an account cancellation and requires a new template).
This operation can only be used with task contacts that are in progress and not connected to an agent. A task template can be updated a maximum of 5 times per contact.
The task's references must be compatible with the fields of the target task template. If the target template has a required field, the task must have a corresponding reference with a matching name and compatible type. The following task template field types map to reference types:
TEXT,TEXT_AREA,BOOLEAN, andSINGLE_SELECTmap to references of typeSTRING.NUMBERmaps to references of typeNUMBER.DATE_TIMEmaps to references of typeDATE.URLmaps to references of typeURL.EMAILmaps to references of typeEMAIL.
References corresponding to TEXT fields must be fewer than 512
characters. TEXT_AREA fields must be fewer than 4,096 characters.
BOOLEAN fields must have a value of true or false.
An InvalidRequestException occurs when UpdateContactTaskTemplate
is called on a connected or terminated task, when it is called on
non-task contacts, and when the task contact already uses the provided
task template. A PropertyValidationException occurs when the task's
references conflict with the task template's fields, for example if
the task is missing a reference that matches a required field, or if
the task has a reference that matches a required field's name but not
its datatype.
29073 29074 29075 29076 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29073 def update_contact_task_template(params = {}, = {}) req = build_request(:update_contact_task_template, params) req.send_request() end |
#update_cross_region_routing(params = {}) ⇒ Struct
Updates the cross-region routing configuration for an Amazon Connect
Global Resiliency instance enabled for global routing. When invoked
with IsolatedAll set to true, this operation disables cross-region
routing, meaning contacts originating in one Region will no longer be
routed to agents in another Region.
29116 29117 29118 29119 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29116 def update_cross_region_routing(params = {}, = {}) req = build_request(:update_cross_region_routing, params) req.send_request() end |
#update_data_table_attribute(params = {}) ⇒ Types::UpdateDataTableAttributeResponse
Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.
29204 29205 29206 29207 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29204 def update_data_table_attribute(params = {}, = {}) req = build_request(:update_data_table_attribute, params) req.send_request() end |
#update_data_table_metadata(params = {}) ⇒ Types::UpdateDataTableMetadataResponse
Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.
29267 29268 29269 29270 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29267 def (params = {}, = {}) req = build_request(:update_data_table_metadata, params) req.send_request() end |
#update_data_table_primary_values(params = {}) ⇒ Types::UpdateDataTablePrimaryValuesResponse
Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.
29341 29342 29343 29344 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29341 def update_data_table_primary_values(params = {}, = {}) req = build_request(:update_data_table_primary_values, 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 Connect Customer Administrator Guide.
29405 29406 29407 29408 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29405 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 Connect Customer 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.
29799 29800 29801 29802 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29799 def update_evaluation_form(params = {}, = {}) req = build_request(:update_evaluation_form, params) req.send_request() end |
#update_extraction_definition(params = {}) ⇒ Struct
Updates an extraction definition in the specified Connect Customer instance.
29861 29862 29863 29864 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29861 def update_extraction_definition(params = {}, = {}) req = build_request(:update_extraction_definition, params) req.send_request() end |
#update_hours_of_operation(params = {}) ⇒ Struct
Updates the hours of operation.
29920 29921 29922 29923 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 29920 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.
30007 30008 30009 30010 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30007 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 Connect Customer and is subject to change.
Updates the value for the specified attribute type.
30079 30080 30081 30082 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30079 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 Connect Customer and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
30162 30163 30164 30165 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30162 def update_instance_storage_config(params = {}, = {}) req = build_request(:update_instance_storage_config, params) req.send_request() end |
#update_metric_content(params = {}) ⇒ Struct
Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer instance.
30235 30236 30237 30238 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30235 def update_metric_content(params = {}, = {}) req = build_request(:update_metric_content, params) req.send_request() end |
#update_metric_metadata(params = {}) ⇒ Struct
Updates the name and/or description of an existing metric in the specified Connect Customer instance.
30277 30278 30279 30280 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30277 def (params = {}, = {}) req = build_request(:update_metric_metadata, params) req.send_request() end |
#update_notification_content(params = {}) ⇒ Struct
Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.
30316 30317 30318 30319 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30316 def update_notification_content(params = {}, = {}) req = build_request(:update_notification_content, params) req.send_request() end |
#update_outbound_email_contact_message(params = {}) ⇒ Types::UpdateOutboundEmailContactMessageResponse
Updates the draft outbound email message for a contact. Use this
operation to save changes to an in-progress outbound email reply
before you send it. This operation applies only to contacts with an
OUTBOUND or AGENT_REPLY initiation method; it isn't supported for
flow-initiated emails.
30367 30368 30369 30370 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30367 def (params = {}, = {}) req = build_request(:update_outbound_email_contact_message, params) req.send_request() end |
#update_participant_authentication(params = {}) ⇒ Struct
Instructs Connect Customer 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.
30431 30432 30433 30434 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30431 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.
30496 30497 30498 30499 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30496 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 Connect Customer instance or traffic distribution group to another Connect Customer 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.
30574 30575 30576 30577 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30574 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.
30621 30622 30623 30624 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30621 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 Connect Customer instance. A predefined attribute is made up of a name and a value.
For the predefined attributes per instance quota, see Connect Customer 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 Connect Customer endpoints and quotas.
30696 30697 30698 30699 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30696 def update_predefined_attribute(params = {}, = {}) req = build_request(:update_predefined_attribute, params) req.send_request() end |
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
30753 30754 30755 30756 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30753 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.
30788 30789 30790 30791 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30788 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.
30825 30826 30827 30828 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30825 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.
30865 30866 30867 30868 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30865 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 Connect Customer 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
instancein 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.
30932 30933 30934 30935 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30932 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.
30969 30970 30971 30972 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 30969 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.
31004 31005 31006 31007 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31004 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.
31055 31056 31057 31058 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31055 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.
31096 31097 31098 31099 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31096 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.
31135 31136 31137 31138 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31135 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.
31189 31190 31191 31192 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31189 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.
31224 31225 31226 31227 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31224 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.
31266 31267 31268 31269 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31266 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.
31313 31314 31315 31316 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31313 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 Connect Customer instance.
Use the Rules Function language to code conditions for the rule.
31507 31508 31509 31510 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31507 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 Connect Customer Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
31629 31630 31631 31632 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31629 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 Connect Customer instance. This operation does not support partial updates. Instead it does a full update of template content.
31804 31805 31806 31807 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31804 def update_task_template(params = {}, = {}) req = build_request(:update_task_template, params) req.send_request() end |
#update_test_case(params = {}) ⇒ Struct
Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.
31877 31878 31879 31880 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31877 def update_test_case(params = {}, = {}) req = build_request(:update_test_case, 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 Connect Customer Administrator Guide.
Important things to know
- Invoke the UpdateTrafficDistribution API in the region that should handle traffic.
^
31968 31969 31970 31971 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 31968 def update_traffic_distribution(params = {}, = {}) req = build_request(:update_traffic_distribution, params) req.send_request() end |
#update_user_config(params = {}) ⇒ Struct
Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.
32071 32072 32073 32074 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32071 def update_user_config(params = {}, = {}) req = build_request(:update_user_config, params) req.send_request() end |
#update_user_hierarchy(params = {}) ⇒ Struct
Assigns the specified hierarchy group to the specified user.
32106 32107 32108 32109 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32106 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.
32141 32142 32143 32144 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32141 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.
32189 32190 32191 32192 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32189 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 Connect Customer Administrator Guide.
32242 32243 32244 32245 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32242 def update_user_identity_info(params = {}, = {}) req = build_request(:update_user_identity_info, params) req.send_request() end |
#update_user_notification_status(params = {}) ⇒ Struct
Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.
32296 32297 32298 32299 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32296 def update_user_notification_status(params = {}, = {}) req = build_request(:update_user_notification_status, params) req.send_request() end |
#update_user_phone_config(params = {}) ⇒ Struct
Updates the phone configuration settings for the specified user.
32350 32351 32352 32353 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32350 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.
32389 32390 32391 32392 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32389 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.
32424 32425 32426 32427 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32424 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.
32459 32460 32461 32462 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32459 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 Connect Customer 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.
32530 32531 32532 32533 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32530 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.
32566 32567 32568 32569 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32566 def (params = {}, = {}) req = build_request(:update_view_metadata, params) req.send_request() end |
#update_workspace_metadata(params = {}) ⇒ Struct
Updates the metadata of a workspace, such as its name and description.
32609 32610 32611 32612 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32609 def (params = {}, = {}) req = build_request(:update_workspace_metadata, params) req.send_request() end |
#update_workspace_page(params = {}) ⇒ Struct
Updates the configuration of a page in a workspace, including the associated view and input data.
32661 32662 32663 32664 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32661 def update_workspace_page(params = {}, = {}) req = build_request(:update_workspace_page, params) req.send_request() end |
#update_workspace_theme(params = {}) ⇒ Struct
Updates the theme configuration for a workspace, including colors and styling.
32778 32779 32780 32781 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32778 def update_workspace_theme(params = {}, = {}) req = build_request(:update_workspace_theme, params) req.send_request() end |
#update_workspace_visibility(params = {}) ⇒ Struct
Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.
32816 32817 32818 32819 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 32816 def update_workspace_visibility(params = {}, = {}) req = build_request(:update_workspace_visibility, params) req.send_request() end |