Class: Aws::Connect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Connect::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb
Overview
An API client for Connect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Connect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse
Activates an evaluation form in the specified Amazon Connect instance.
-
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_default_vocabulary(params = {}) ⇒ Struct
Associates an existing vocabulary as the default.
-
#associate_flow(params = {}) ⇒ Struct
Associates a connect resource to a flow.
-
#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_phone_number_contact_flow(params = {}) ⇒ Struct
Associates a flow with a phone number claimed to your Amazon Connect instance.
-
#associate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_routing_profile_queues(params = {}) ⇒ Struct
Associates a set of queues with a routing profile.
-
#associate_security_key(params = {}) ⇒ Types::AssociateSecurityKeyResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_traffic_distribution_group_user(params = {}) ⇒ Struct
Associates an agent with a traffic distribution group.
-
#associate_user_proficiencies(params = {}) ⇒ Struct
>Associates a set of proficiencies with a user.
-
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#batch_get_attached_file_metadata(params = {}) ⇒ Types::BatchGetAttachedFileMetadataResponse
Allows you to retrieve metadata about multiple attached files on an associated resource.
-
#batch_get_flow_association(params = {}) ⇒ Types::BatchGetFlowAssociationResponse
Retrieve the flow associations for the given resources.
-
#batch_put_contact(params = {}) ⇒ Types::BatchPutContactResponse
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. -
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
-
#complete_attached_file_upload(params = {}) ⇒ Struct
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
-
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse
Creates a flow for the specified Amazon Connect instance.
-
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Amazon Connect instance.
-
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
Creates an evaluation form in the specified Amazon Connect instance.
-
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_integration_association(params = {}) ⇒ Types::CreateIntegrationAssociationResponse
Creates an Amazon Web Services resource association with an Amazon Connect instance.
-
#create_participant(params = {}) ⇒ Types::CreateParticipantResponse
Adds a new participant into an on-going chat contact.
-
#create_persistent_contact_association(params = {}) ⇒ Types::CreatePersistentContactAssociationResponse
Enables rehydration of chats for the lifespan of a contact.
-
#create_predefined_attribute(params = {}) ⇒ Struct
Creates a new predefined attribute for the specified Amazon Connect instance.
-
#create_prompt(params = {}) ⇒ Types::CreatePromptResponse
Creates a prompt.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_quick_connect(params = {}) ⇒ Types::CreateQuickConnectResponse
Creates a quick connect for the specified Amazon Connect instance.
-
#create_routing_profile(params = {}) ⇒ Types::CreateRoutingProfileResponse
Creates a new routing profile.
-
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a rule for the specified Amazon Connect instance.
-
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a security profile.
-
#create_task_template(params = {}) ⇒ Types::CreateTaskTemplateResponse
Creates a new task template in the specified Amazon Connect instance.
-
#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
-
#create_use_case(params = {}) ⇒ Types::CreateUseCaseResponse
Creates a use case for an integration association.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user account for the specified Amazon Connect instance.
-
#create_user_hierarchy_group(params = {}) ⇒ Types::CreateUserHierarchyGroupResponse
Creates a new user hierarchy group.
-
#create_view(params = {}) ⇒ Types::CreateViewResponse
Creates a new view with the possible status of
SAVED
orPUBLISHED
. -
#create_view_version(params = {}) ⇒ Types::CreateViewVersionResponse
Publishes a new version of the view identifier.
-
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
Creates a custom vocabulary associated with your Amazon Connect instance.
-
#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse
Deactivates an evaluation form in the specified Amazon Connect instance.
-
#delete_attached_file(params = {}) ⇒ Struct
Deletes an attached file along with the underlying S3 Object.
-
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Amazon Connect instance.
-
#delete_contact_flow(params = {}) ⇒ Struct
Deletes a flow for the specified Amazon Connect instance.
-
#delete_contact_flow_module(params = {}) ⇒ Struct
Deletes the specified flow module.
-
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Amazon Connect instance.
-
#delete_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#delete_instance(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#delete_integration_association(params = {}) ⇒ Struct
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
-
#delete_predefined_attribute(params = {}) ⇒ Struct
Deletes a predefined attribute from the specified Amazon Connect instance.
-
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
-
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
-
#delete_quick_connect(params = {}) ⇒ Struct
Deletes a quick connect.
-
#delete_routing_profile(params = {}) ⇒ Struct
Deletes a routing profile.
-
#delete_rule(params = {}) ⇒ Struct
Deletes a rule for the specified Amazon Connect instance.
-
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
-
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
-
#delete_traffic_distribution_group(params = {}) ⇒ Struct
Deletes a traffic distribution group.
-
#delete_use_case(params = {}) ⇒ Struct
Deletes a use case from an integration association.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user account from the specified Amazon Connect instance.
-
#delete_user_hierarchy_group(params = {}) ⇒ Struct
Deletes an existing user hierarchy group.
-
#delete_view(params = {}) ⇒ Struct
Deletes the view entirely.
-
#delete_view_version(params = {}) ⇒ Struct
Deletes the particular version specified in
ViewVersion
identifier. -
#delete_vocabulary(params = {}) ⇒ Types::DeleteVocabularyResponse
Deletes the vocabulary that has the given identifier.
-
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_contact_evaluation(params = {}) ⇒ Types::DescribeContactEvaluationResponse
Describes a contact evaluation in the specified Amazon Connect instance.
-
#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse
Describes the specified flow.
-
#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse
Describes the specified flow module.
-
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Amazon Connect instance.
-
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_instance_attribute(params = {}) ⇒ Types::DescribeInstanceAttributeResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_instance_storage_config(params = {}) ⇒ Types::DescribeInstanceStorageConfigResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
-
#describe_predefined_attribute(params = {}) ⇒ Types::DescribePredefinedAttributeResponse
Describes a predefined attribute for the specified Amazon Connect instance.
-
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
-
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
-
#describe_routing_profile(params = {}) ⇒ Types::DescribeRoutingProfileResponse
Describes the specified routing profile.
-
#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse
Describes a rule for the specified Amazon Connect instance.
-
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets basic information about the security profile.
-
#describe_traffic_distribution_group(params = {}) ⇒ Types::DescribeTrafficDistributionGroupResponse
Gets details and status of a traffic distribution group.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Describes the specified user.
-
#describe_user_hierarchy_group(params = {}) ⇒ Types::DescribeUserHierarchyGroupResponse
Describes the specified hierarchy group.
-
#describe_user_hierarchy_structure(params = {}) ⇒ Types::DescribeUserHierarchyStructureResponse
Describes the hierarchy structure of the specified Amazon Connect instance.
-
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
Retrieves the view for the specified Amazon Connect instance and view identifier.
-
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
-
#disassociate_analytics_data_set(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
-
#disassociate_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct
Removes the flow association from a phone number claimed to your Amazon Connect instance.
-
#disassociate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_routing_profile_queues(params = {}) ⇒ Struct
Disassociates a set of queues from a routing profile.
-
#disassociate_security_key(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_traffic_distribution_group_user(params = {}) ⇒ Struct
Disassociates an agent from a traffic distribution group.
-
#disassociate_user_proficiencies(params = {}) ⇒ Struct
Disassociates a set of proficiencies from a user.
-
#dismiss_user_contact(params = {}) ⇒ Struct
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact.
-
#get_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_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse
Gets the real-time metric data from the specified Amazon Connect instance.
-
#get_current_user_data(params = {}) ⇒ Types::GetCurrentUserDataResponse
Gets the real-time active user data from the specified Amazon Connect instance.
-
#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse
Supports SAML sign-in for Amazon Connect.
-
#get_flow_association(params = {}) ⇒ Types::GetFlowAssociationResponse
Retrieves the flow associated for a given resource.
-
#get_metric_data(params = {}) ⇒ Types::GetMetricDataResponse
Gets historical metric data from the specified Amazon Connect instance.
-
#get_metric_data_v2(params = {}) ⇒ Types::GetMetricDataV2Response
Gets metric data from the specified Amazon Connect instance.
-
#get_prompt_file(params = {}) ⇒ Types::GetPromptFileResponse
Gets the prompt file.
-
#get_task_template(params = {}) ⇒ Types::GetTaskTemplateResponse
Gets details about a specific task template in the specified Amazon Connect instance.
-
#get_traffic_distribution(params = {}) ⇒ Types::GetTrafficDistributionResponse
Retrieves the current traffic distribution for a given traffic distribution group.
-
#import_phone_number(params = {}) ⇒ Types::ImportPhoneNumberResponse
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.
-
#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_bots(params = {}) ⇒ Types::ListBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Amazon Connect instance.
-
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Amazon Connect instance.
-
#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse
Provides information about the flows for the specified Amazon Connect instance.
-
#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Amazon Connect instance.
-
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Amazon Connect instance.
-
#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse
Lists evaluation forms in the specified Amazon Connect instance.
-
#list_flow_associations(params = {}) ⇒ Types::ListFlowAssociationsResponse
List the flow association based on the filters.
-
#list_hours_of_operations(params = {}) ⇒ Types::ListHoursOfOperationsResponse
Provides information about the hours of operation for the specified Amazon Connect instance.
-
#list_instance_attributes(params = {}) ⇒ Types::ListInstanceAttributesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_instance_storage_configs(params = {}) ⇒ Types::ListInstanceStorageConfigsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_integration_associations(params = {}) ⇒ Types::ListIntegrationAssociationsResponse
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
-
#list_lambda_functions(params = {}) ⇒ Types::ListLambdaFunctionsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_lex_bots(params = {}) ⇒ Types::ListLexBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Provides information about the phone numbers for the specified Amazon Connect instance.
-
#list_phone_numbers_v2(params = {}) ⇒ Types::ListPhoneNumbersV2Response
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
-
#list_predefined_attributes(params = {}) ⇒ Types::ListPredefinedAttributesResponse
Lists predefined attributes for the specified Amazon Connect instance.
-
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Provides information about the prompts for the specified Amazon Connect instance.
-
#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Provides information about the queues for the specified Amazon Connect instance.
-
#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse
Provides information about the quick connects for the specified Amazon Connect instance.
-
#list_realtime_contact_analysis_segments_v2(params = {}) ⇒ Types::ListRealtimeContactAnalysisSegmentsV2Response
Provides a list of analysis segments for a real-time analysis session.
-
#list_routing_profile_queues(params = {}) ⇒ Types::ListRoutingProfileQueuesResponse
Lists the queues associated with a routing profile.
-
#list_routing_profiles(params = {}) ⇒ Types::ListRoutingProfilesResponse
Provides summary information about the routing profiles for the specified Amazon Connect instance.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
List all rules for the specified Amazon Connect instance.
-
#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse
Returns a list of third-party applications in a specific security profile.
-
#list_security_profile_permissions(params = {}) ⇒ Types::ListSecurityProfilePermissionsResponse
Lists the permissions granted to a security profile.
-
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
Provides summary information about the security profiles for the specified Amazon Connect instance.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#list_task_templates(params = {}) ⇒ Types::ListTaskTemplatesResponse
Lists task templates for the specified Amazon Connect instance.
-
#list_traffic_distribution_group_users(params = {}) ⇒ Types::ListTrafficDistributionGroupUsersResponse
Lists traffic distribution group users.
-
#list_traffic_distribution_groups(params = {}) ⇒ Types::ListTrafficDistributionGroupsResponse
Lists traffic distribution groups.
-
#list_use_cases(params = {}) ⇒ Types::ListUseCasesResponse
Lists the use cases for the integration association.
-
#list_user_hierarchy_groups(params = {}) ⇒ Types::ListUserHierarchyGroupsResponse
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
-
#list_user_proficiencies(params = {}) ⇒ Types::ListUserProficienciesResponse
Lists proficiencies associated with a user.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Provides summary information about the users for the specified Amazon Connect instance.
-
#list_view_versions(params = {}) ⇒ Types::ListViewVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and view identifier.
-
#list_views(params = {}) ⇒ Types::ListViewsResponse
Returns views in the given instance.
-
#monitor_contact(params = {}) ⇒ Types::MonitorContactResponse
Initiates silent monitoring of a contact.
-
#pause_contact(params = {}) ⇒ Struct
Allows pausing an ongoing task contact.
-
#put_user_status(params = {}) ⇒ Struct
Changes the current status of a user or agent in Amazon Connect.
-
#release_phone_number(params = {}) ⇒ Struct
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
-
#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
-
#resume_contact(params = {}) ⇒ Struct
Allows resuming a task contact in a paused state.
-
#resume_contact_recording(params = {}) ⇒ Struct
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both.
-
#search_agent_statuses(params = {}) ⇒ Types::SearchAgentStatusesResponse
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
-
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
-
#search_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse
Searches the flow modules in an Amazon Connect instance, with optional filtering.
-
#search_contact_flows(params = {}) ⇒ Types::SearchContactFlowsResponse
Searches the contact flows in an Amazon Connect instance, with optional filtering.
-
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Amazon Connect instance.
-
#search_hours_of_operations(params = {}) ⇒ Types::SearchHoursOfOperationsResponse
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
-
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Searches predefined attributes that meet certain criteria.
-
#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse
Searches prompts in an Amazon Connect instance, with optional filtering.
-
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Amazon Connect instance, with optional filtering.
-
#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse
Searches quick connects in an Amazon Connect instance, with optional filtering.
-
#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse
Searches tags used in an Amazon Connect instance using optional search criteria.
-
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Amazon Connect instance, with optional filtering.
-
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Amazon Connect instance, with optional filtering.
-
#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
-
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users in an Amazon Connect instance, with optional filtering.
-
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Amazon Connect instance using
State
,NameStartsWith
, andLanguageCode
. -
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
-
#start_attached_file_upload(params = {}) ⇒ Types::StartAttachedFileUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading your content.
-
#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse
Initiates a flow to start a new chat for the customer.
-
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
-
#start_contact_recording(params = {}) ⇒ Struct
Starts recording the contact:.
-
#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse
Initiates real-time message streaming for a new chat contact.
-
#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse
Places an outbound call to a contact, and then initiates the flow.
-
#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse
Initiates a flow to start a new task contact.
-
#start_web_rtc_contact(params = {}) ⇒ Types::StartWebRTCContactResponse
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
-
#stop_contact(params = {}) ⇒ Struct
Ends the specified contact.
-
#stop_contact_recording(params = {}) ⇒ Struct
Stops recording a call when a contact is being recorded.
-
#stop_contact_streaming(params = {}) ⇒ Struct
Ends message streaming on a specified contact.
-
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
Submits a contact evaluation in the specified Amazon Connect instance.
-
#suspend_contact_recording(params = {}) ⇒ Struct
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.
-
#tag_contact(params = {}) ⇒ Struct
Adds the specified tags to the contact resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#transfer_contact(params = {}) ⇒ Types::TransferContactResponse
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
-
#untag_contact(params = {}) ⇒ Struct
Removes the specified tags from the contact resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_agent_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_authentication_profile(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_contact(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_contact_attributes(params = {}) ⇒ Struct
Creates or updates user-defined contact attributes associated with the specified contact.
-
#update_contact_evaluation(params = {}) ⇒ Types::UpdateContactEvaluationResponse
Updates details about a contact evaluation in the specified Amazon Connect instance.
-
#update_contact_flow_content(params = {}) ⇒ Struct
Updates the specified flow.
-
#update_contact_flow_metadata(params = {}) ⇒ Struct
Updates metadata about specified flow.
-
#update_contact_flow_module_content(params = {}) ⇒ Struct
Updates specified flow module for the specified Amazon Connect instance.
-
#update_contact_flow_module_metadata(params = {}) ⇒ Struct
Updates metadata about specified flow module.
-
#update_contact_flow_name(params = {}) ⇒ Struct
The name of the flow.
-
#update_contact_routing_data(params = {}) ⇒ Struct
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).
-
#update_contact_schedule(params = {}) ⇒ Struct
Updates the scheduled time of a task contact that is already scheduled.
-
#update_evaluation_form(params = {}) ⇒ Types::UpdateEvaluationFormResponse
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
-
#update_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_instance_attribute(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_participant_role_config(params = {}) ⇒ Struct
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
-
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
-
#update_phone_number_metadata(params = {}) ⇒ Struct
Updates a phone number’s metadata.
-
#update_predefined_attribute(params = {}) ⇒ Struct
Updates a predefined attribute for the specified Amazon Connect instance.
-
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
-
#update_queue_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_max_contacts(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_name(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_outbound_caller_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_queue_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#update_quick_connect_config(params = {}) ⇒ Struct
Updates the configuration settings for the specified quick connect.
-
#update_quick_connect_name(params = {}) ⇒ Struct
Updates the name and description of a quick connect.
-
#update_routing_profile_agent_availability_timer(params = {}) ⇒ Struct
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
-
#update_routing_profile_concurrency(params = {}) ⇒ Struct
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
-
#update_routing_profile_default_outbound_queue(params = {}) ⇒ Struct
Updates the default outbound queue of a routing profile.
-
#update_routing_profile_name(params = {}) ⇒ Struct
Updates the name and description of a routing profile.
-
#update_routing_profile_queues(params = {}) ⇒ Struct
Updates the properties associated with a set of queues for a routing profile.
-
#update_rule(params = {}) ⇒ Struct
Updates a rule for the specified Amazon Connect instance.
-
#update_security_profile(params = {}) ⇒ Struct
Updates a security profile.
-
#update_task_template(params = {}) ⇒ Types::UpdateTaskTemplateResponse
Updates details about a specific task template in the specified Amazon Connect instance.
-
#update_traffic_distribution(params = {}) ⇒ Struct
Updates the traffic distribution for a given traffic distribution group.
-
#update_user_hierarchy(params = {}) ⇒ Struct
Assigns the specified hierarchy group to the specified user.
-
#update_user_hierarchy_group_name(params = {}) ⇒ Struct
Updates the name of the user hierarchy group.
-
#update_user_hierarchy_structure(params = {}) ⇒ Struct
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
-
#update_user_identity_info(params = {}) ⇒ Struct
Updates the identity information for the specified user.
-
#update_user_phone_config(params = {}) ⇒ Struct
Updates the phone configuration settings for the specified user.
-
#update_user_proficiencies(params = {}) ⇒ Struct
Updates the properties associated with the proficiencies of a user.
-
#update_user_routing_profile(params = {}) ⇒ Struct
Assigns the specified routing profile to the specified user.
-
#update_user_security_profiles(params = {}) ⇒ Struct
Assigns the specified security profiles to the specified user.
-
#update_view_content(params = {}) ⇒ Types::UpdateViewContentResponse
Updates the view content of the given view identifier in the specified Amazon Connect instance.
-
#update_view_metadata(params = {}) ⇒ Struct
Updates the view metadata.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse
Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.
496 497 498 499 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 496 def activate_evaluation_form(params = {}, = {}) req = build_request(:activate_evaluation_form, params) req.send_request() end |
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
551 552 553 554 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 551 def associate_analytics_data_set(params = {}, = {}) req = build_request(:associate_analytics_data_set, params) req.send_request() end |
#associate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
585 586 587 588 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 585 def associate_approved_origin(params = {}, = {}) req = build_request(:associate_approved_origin, params) req.send_request() end |
#associate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
629 630 631 632 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 629 def associate_bot(params = {}, = {}) req = build_request(:associate_bot, params) req.send_request() end |
#associate_default_vocabulary(params = {}) ⇒ Struct
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
673 674 675 676 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 673 def associate_default_vocabulary(params = {}, = {}) req = build_request(:associate_default_vocabulary, params) req.send_request() end |
#associate_flow(params = {}) ⇒ Struct
Associates a connect resource to a flow.
712 713 714 715 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 712 def associate_flow(params = {}, = {}) req = build_request(:associate_flow, params) req.send_request() end |
#associate_instance_storage_config(params = {}) ⇒ Types::AssociateInstanceStorageConfigResponse
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
809 810 811 812 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 809 def associate_instance_storage_config(params = {}, = {}) req = build_request(:associate_instance_storage_config, params) req.send_request() end |
#associate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
845 846 847 848 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 845 def associate_lambda_function(params = {}, = {}) req = build_request(:associate_lambda_function, params) req.send_request() end |
#associate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
884 885 886 887 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 884 def associate_lex_bot(params = {}, = {}) req = build_request(:associate_lex_bot, params) req.send_request() end |
#associate_phone_number_contact_flow(params = {}) ⇒ Struct
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are
calling this API using an instance in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a
full phone number ARN or UUID value for the PhoneNumberId
URI
request parameter. However, if the number is claimed to a traffic
distribution group and you are calling this API using an instance in
the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a
UUID is provided in this scenario, you will receive a
ResourceNotFoundException
.
931 932 933 934 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 931 def associate_phone_number_contact_flow(params = {}, = {}) req = build_request(:associate_phone_number_contact_flow, params) req.send_request() end |
#associate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
969 970 971 972 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 969 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.
1013 1014 1015 1016 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1013 def associate_routing_profile_queues(params = {}, = {}) req = build_request(:associate_routing_profile_queues, params) req.send_request() end |
#associate_security_key(params = {}) ⇒ Types::AssociateSecurityKeyResponse
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1053 def associate_security_key(params = {}, = {}) req = build_request(:associate_security_key, params) req.send_request() end |
#associate_traffic_distribution_group_user(params = {}) ⇒ Struct
Associates an agent with a traffic distribution group.
1092 1093 1094 1095 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1092 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.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1129 def associate_user_proficiencies(params = {}, = {}) req = build_request(:associate_user_proficiencies, params) req.send_request() end |
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
1186 1187 1188 1189 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1186 def batch_associate_analytics_data_set(params = {}, = {}) req = build_request(:batch_associate_analytics_data_set, params) req.send_request() end |
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1240 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.
1304 1305 1306 1307 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1304 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.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1348 def batch_get_flow_association(params = {}, = {}) req = build_request(:batch_get_flow_association, params) req.send_request() end |
#batch_put_contact(params = {}) ⇒ Types::BatchPutContactResponse
Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1440 def batch_put_contact(params = {}, = {}) req = build_request(:batch_put_contact, params) req.send_request() end |
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
1555 1556 1557 1558 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1555 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1595 def complete_attached_file_upload(params = {}, = {}) req = build_request(:complete_attached_file_upload, params) req.send_request() end |
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1657 def create_agent_status(params = {}, = {}) req = build_request(:create_agent_status, params) req.send_request() end |
#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
1737 1738 1739 1740 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1737 def create_contact_flow(params = {}, = {}) req = build_request(:create_contact_flow, params) req.send_request() end |
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Amazon Connect instance.
1811 1812 1813 1814 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1811 def create_contact_flow_module(params = {}, = {}) req = build_request(:create_contact_flow_module, params) req.send_request() end |
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1946 def create_evaluation_form(params = {}, = {}) req = build_request(:create_evaluation_form, params) req.send_request() end |
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
2021 2022 2023 2024 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2021 def create_hours_of_operation(params = {}, = {}) req = build_request(:create_hours_of_operation, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::CreateInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
2098 2099 2100 2101 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2098 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#create_integration_association(params = {}) ⇒ Types::CreateIntegrationAssociationResponse
Creates an Amazon Web Services resource association with an Amazon Connect instance.
2170 2171 2172 2173 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2170 def create_integration_association(params = {}, = {}) req = build_request(:create_integration_association, params) req.send_request() end |
#create_participant(params = {}) ⇒ Types::CreateParticipantResponse
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
2242 2243 2244 2245 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2242 def create_participant(params = {}, = {}) req = build_request(:create_participant, params) req.send_request() end |
#create_persistent_contact_association(params = {}) ⇒ Types::CreatePersistentContactAssociationResponse
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
2367 2368 2369 2370 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2367 def create_persistent_contact_association(params = {}, = {}) req = build_request(:create_persistent_contact_association, params) req.send_request() end |
#create_predefined_attribute(params = {}) ⇒ Struct
Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2408 def create_predefined_attribute(params = {}, = {}) req = build_request(:create_predefined_attribute, params) req.send_request() end |
#create_prompt(params = {}) ⇒ Types::CreatePromptResponse
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
2475 2476 2477 2478 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2475 def create_prompt(params = {}, = {}) req = build_request(:create_prompt, params) req.send_request() end |
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive aResourceNotFoundException
.Only use the phone number ARN format that doesn't contain
instance
in the path, for example,arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
2577 2578 2579 2580 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2577 def create_queue(params = {}, = {}) req = build_request(:create_queue, params) req.send_request() end |
#create_quick_connect(params = {}) ⇒ Types::CreateQuickConnectResponse
Creates a quick connect for the specified Amazon Connect instance.
2645 2646 2647 2648 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2645 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.
2744 2745 2746 2747 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2744 def create_routing_profile(params = {}, = {}) req = build_request(:create_routing_profile, params) req.send_request() end |
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
2888 2889 2890 2891 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2888 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_security_profile(params = {}) ⇒ Types::CreateSecurityProfileResponse
Creates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
2992 2993 2994 2995 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2992 def create_security_profile(params = {}, = {}) req = build_request(:create_security_profile, params) req.send_request() end |
#create_task_template(params = {}) ⇒ Types::CreateTaskTemplateResponse
Creates a new task template in the specified Amazon Connect instance.
3114 3115 3116 3117 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3114 def create_task_template(params = {}, = {}) req = build_request(:create_task_template, params) req.send_request() end |
#create_traffic_distribution_group(params = {}) ⇒ Types::CreateTrafficDistributionGroupResponse
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
SignInConfig
distribution is available only on a default
TrafficDistributionGroup
(see the IsDefault
parameter in the
TrafficDistributionGroup data type). If you call
UpdateTrafficDistribution
with a modified SignInConfig
and a
non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.
3194 3195 3196 3197 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3194 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.
3246 3247 3248 3249 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3246 def create_use_case(params = {}, = {}) req = build_request(:create_use_case, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some
situations. For example, Email
is required if you are using SAML for
identity management. FirstName
and LastName
are required if you
are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
3369 3370 3371 3372 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3369 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.
3422 3423 3424 3425 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3422 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.
3513 3514 3515 3516 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3513 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.
3577 3578 3579 3580 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3577 def create_view_version(params = {}, = {}) req = build_request(:create_view_version, params) req.send_request() end |
#create_vocabulary(params = {}) ⇒ Types::CreateVocabularyResponse
Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.
3668 3669 3670 3671 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3668 def create_vocabulary(params = {}, = {}) req = build_request(:create_vocabulary, params) req.send_request() end |
#deactivate_evaluation_form(params = {}) ⇒ Types::DeactivateEvaluationFormResponse
Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3716 def deactivate_evaluation_form(params = {}, = {}) req = build_request(:deactivate_evaluation_form, params) req.send_request() end |
#delete_attached_file(params = {}) ⇒ Struct
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
3758 3759 3760 3761 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3758 def delete_attached_file(params = {}, = {}) req = build_request(:delete_attached_file, params) req.send_request() end |
#delete_contact_evaluation(params = {}) ⇒ Struct
Deletes a contact evaluation in the specified Amazon Connect instance.
3789 3790 3791 3792 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3789 def delete_contact_evaluation(params = {}, = {}) req = build_request(:delete_contact_evaluation, params) req.send_request() end |
#delete_contact_flow(params = {}) ⇒ Struct
Deletes a flow for the specified Amazon Connect instance.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3820 def delete_contact_flow(params = {}, = {}) req = build_request(:delete_contact_flow, params) req.send_request() end |
#delete_contact_flow_module(params = {}) ⇒ Struct
Deletes the specified flow module.
3851 3852 3853 3854 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3851 def delete_contact_flow_module(params = {}, = {}) req = build_request(:delete_contact_flow_module, params) req.send_request() end |
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
3892 3893 3894 3895 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3892 def delete_evaluation_form(params = {}, = {}) req = build_request(:delete_evaluation_form, params) req.send_request() end |
#delete_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
3926 3927 3928 3929 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3926 def delete_hours_of_operation(params = {}, = {}) req = build_request(:delete_hours_of_operation, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
3969 3970 3971 3972 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3969 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_integration_association(params = {}) ⇒ Struct
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
4002 4003 4004 4005 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4002 def delete_integration_association(params = {}, = {}) req = build_request(:delete_integration_association, params) req.send_request() end |
#delete_predefined_attribute(params = {}) ⇒ Struct
Deletes a predefined attribute from the specified Amazon Connect instance.
4030 4031 4032 4033 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4030 def delete_predefined_attribute(params = {}, = {}) req = build_request(:delete_predefined_attribute, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
4061 4062 4063 4064 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4061 def delete_prompt(params = {}, = {}) req = build_request(:delete_prompt, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
4093 4094 4095 4096 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4093 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#delete_quick_connect(params = {}) ⇒ Struct
Deletes a quick connect.
After calling DeleteUser, it's important to call
DeleteQuickConnect
to delete any records related to the deleted
users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
4142 4143 4144 4145 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4142 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.
4173 4174 4175 4176 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4173 def delete_routing_profile(params = {}, = {}) req = build_request(:delete_routing_profile, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
Deletes a rule for the specified Amazon Connect instance.
4204 4205 4206 4207 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4204 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
4235 4236 4237 4238 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4235 def delete_security_profile(params = {}, = {}) req = build_request(:delete_security_profile, params) req.send_request() end |
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
4266 4267 4268 4269 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4266 def delete_task_template(params = {}, = {}) req = build_request(:delete_task_template, params) req.send_request() end |
#delete_traffic_distribution_group(params = {}) ⇒ Struct
Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.
4300 4301 4302 4303 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4300 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.
4335 4336 4337 4338 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4335 def delete_use_case(params = {}, = {}) req = build_request(:delete_use_case, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.
4388 4389 4390 4391 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4388 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.
4420 4421 4422 4423 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4420 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).
4448 4449 4450 4451 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4448 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.
4479 4480 4481 4482 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4479 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.
4520 4521 4522 4523 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4520 def delete_vocabulary(params = {}, = {}) req = build_request(:delete_vocabulary, params) req.send_request() end |
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
4570 4571 4572 4573 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4570 def describe_agent_status(params = {}, = {}) req = build_request(:describe_agent_status, params) req.send_request() end |
#describe_authentication_profile(params = {}) ⇒ Types::DescribeAuthenticationProfileResponse
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
4624 4625 4626 4627 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4624 def describe_authentication_profile(params = {}, = {}) req = build_request(:describe_authentication_profile, params) req.send_request() end |
#describe_contact(params = {}) ⇒ Types::DescribeContactResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
4738 4739 4740 4741 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4738 def describe_contact(params = {}, = {}) req = build_request(:describe_contact, params) req.send_request() end |
#describe_contact_evaluation(params = {}) ⇒ Types::DescribeContactEvaluationResponse
Describes a contact evaluation in the specified Amazon Connect instance.
4840 4841 4842 4843 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4840 def describe_contact_evaluation(params = {}, = {}) req = build_request(:describe_contact_evaluation, params) req.send_request() end |
#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED
. Once
a contact flow is published, $SAVED
needs to be supplied to view
saved content that has not been published.
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
4898 4899 4900 4901 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4898 def describe_contact_flow(params = {}, = {}) req = build_request(:describe_contact_flow, params) req.send_request() end |
#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse
Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED
. Once
a contact flow is published, $SAVED
needs to be supplied to view
saved content that has not been published.
4948 4949 4950 4951 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4948 def describe_contact_flow_module(params = {}, = {}) req = build_request(:describe_contact_flow_module, params) req.send_request() end |
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
5036 5037 5038 5039 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5036 def describe_evaluation_form(params = {}, = {}) req = build_request(:describe_evaluation_form, params) req.send_request() end |
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
5090 5091 5092 5093 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5090 def describe_hours_of_operation(params = {}, = {}) req = build_request(:describe_hours_of_operation, params) req.send_request() end |
#describe_instance(params = {}) ⇒ Types::DescribeInstanceResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.
If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.
5152 5153 5154 5155 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5152 def describe_instance(params = {}, = {}) req = build_request(:describe_instance, params) req.send_request() end |
#describe_instance_attribute(params = {}) ⇒ Types::DescribeInstanceAttributeResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
5193 5194 5195 5196 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5193 def describe_instance_attribute(params = {}, = {}) req = build_request(:describe_instance_attribute, params) req.send_request() end |
#describe_instance_storage_config(params = {}) ⇒ Types::DescribeInstanceStorageConfigResponse
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
5250 5251 5252 5253 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5250 def describe_instance_storage_config(params = {}, = {}) req = build_request(:describe_instance_storage_config, params) req.send_request() end |
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are
calling in the Amazon Web Services Region where the traffic
distribution group was created, you can use either a phone number ARN
or UUID value for the PhoneNumberId
URI request parameter. However,
if the number is claimed to a traffic distribution group and you are
calling this API in the alternate Amazon Web Services Region
associated with the traffic distribution group, you must provide a
full phone number ARN. If a UUID is provided in this scenario, you
will receive a ResourceNotFoundException
.
5301 5302 5303 5304 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5301 def describe_phone_number(params = {}, = {}) req = build_request(:describe_phone_number, params) req.send_request() end |
#describe_predefined_attribute(params = {}) ⇒ Types::DescribePredefinedAttributeResponse
Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
5346 5347 5348 5349 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5346 def describe_predefined_attribute(params = {}, = {}) req = build_request(:describe_predefined_attribute, params) req.send_request() end |
#describe_prompt(params = {}) ⇒ Types::DescribePromptResponse
Describes the prompt.
5390 5391 5392 5393 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5390 def describe_prompt(params = {}, = {}) req = build_request(:describe_prompt, params) req.send_request() end |
#describe_queue(params = {}) ⇒ Types::DescribeQueueResponse
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
5443 5444 5445 5446 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5443 def describe_queue(params = {}, = {}) req = build_request(:describe_queue, params) req.send_request() end |
#describe_quick_connect(params = {}) ⇒ Types::DescribeQuickConnectResponse
Describes the quick connect.
5493 5494 5495 5496 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5493 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.
5549 5550 5551 5552 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5549 def describe_routing_profile(params = {}, = {}) req = build_request(:describe_routing_profile, params) req.send_request() end |
#describe_rule(params = {}) ⇒ Types::DescribeRuleResponse
Describes a rule for the specified Amazon Connect instance.
5626 5627 5628 5629 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5626 def describe_rule(params = {}, = {}) req = build_request(:describe_rule, params) req.send_request() end |
#describe_security_profile(params = {}) ⇒ Types::DescribeSecurityProfileResponse
Gets basic information about the security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
5688 5689 5690 5691 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5688 def describe_security_profile(params = {}, = {}) req = build_request(:describe_security_profile, params) req.send_request() end |
#describe_traffic_distribution_group(params = {}) ⇒ Types::DescribeTrafficDistributionGroupResponse
Gets details and status of a traffic distribution group.
5727 5728 5729 5730 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5727 def describe_traffic_distribution_group(params = {}, = {}) req = build_request(:describe_traffic_distribution_group, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
5791 5792 5793 5794 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5791 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.
5860 5861 5862 5863 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5860 def describe_user_hierarchy_group(params = {}, = {}) req = build_request(:describe_user_hierarchy_group, params) req.send_request() end |
#describe_user_hierarchy_structure(params = {}) ⇒ Types::DescribeUserHierarchyStructureResponse
Describes the hierarchy structure of the specified Amazon Connect instance.
5918 5919 5920 5921 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5918 def describe_user_hierarchy_structure(params = {}, = {}) req = build_request(:describe_user_hierarchy_structure, params) req.send_request() end |
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED
needs to be supplied if a view is unpublished.
The view identifier can contain an optional qualifier, for example,
<view-id>:$SAVED
, which is either an actual version number or an
Amazon Connect managed qualifier $SAVED | $LATEST
. If it is not
supplied, then $LATEST
is assumed for customer managed views and an
error is returned if there is no published content available. Version
1 is assumed for Amazon Web Services managed views.
5980 5981 5982 5983 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5980 def describe_view(params = {}, = {}) req = build_request(:describe_view, params) req.send_request() end |
#describe_vocabulary(params = {}) ⇒ Types::DescribeVocabularyResponse
Describes the specified vocabulary.
6026 6027 6028 6029 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6026 def describe_vocabulary(params = {}, = {}) req = build_request(:describe_vocabulary, params) req.send_request() end |
#disassociate_analytics_data_set(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Removes the dataset ID associated with a given Amazon Connect instance.
6068 6069 6070 6071 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6068 def disassociate_analytics_data_set(params = {}, = {}) req = build_request(:disassociate_analytics_data_set, params) req.send_request() end |
#disassociate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
6102 6103 6104 6105 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6102 def disassociate_approved_origin(params = {}, = {}) req = build_request(:disassociate_approved_origin, params) req.send_request() end |
#disassociate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.
6146 6147 6148 6149 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6146 def disassociate_bot(params = {}, = {}) req = build_request(:disassociate_bot, params) req.send_request() end |
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
6181 6182 6183 6184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6181 def disassociate_flow(params = {}, = {}) req = build_request(:disassociate_flow, params) req.send_request() end |
#disassociate_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Removes the storage type configurations for the specified resource type and association ID.
6221 6222 6223 6224 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6221 def disassociate_instance_storage_config(params = {}, = {}) req = build_request(:disassociate_instance_storage_config, params) req.send_request() end |
#disassociate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Remove the Lambda function from the dropdown options available in the relevant flow blocks.
6257 6258 6259 6260 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6257 def disassociate_lambda_function(params = {}, = {}) req = build_request(:disassociate_lambda_function, params) req.send_request() end |
#disassociate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Revokes authorization from the specified instance to access the specified Amazon Lex bot.
6297 6298 6299 6300 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6297 def disassociate_lex_bot(params = {}, = {}) req = build_request(:disassociate_lex_bot, params) req.send_request() end |
#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are
calling this API using an instance in the Amazon Web Services Region
where the traffic distribution group was created, you can use either a
full phone number ARN or UUID value for the PhoneNumberId
URI
request parameter. However, if the number is claimed to a traffic
distribution group and you are calling this API using an instance in
the alternate Amazon Web Services Region associated with the traffic
distribution group, you must provide a full phone number ARN. If a
UUID is provided in this scenario, you will receive a
ResourceNotFoundException
.
6340 6341 6342 6343 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6340 def disassociate_phone_number_contact_flow(params = {}, = {}) req = build_request(:disassociate_phone_number_contact_flow, params) req.send_request() end |
#disassociate_queue_quick_connects(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
6378 6379 6380 6381 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6378 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.
6418 6419 6420 6421 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6418 def disassociate_routing_profile_queues(params = {}, = {}) req = build_request(:disassociate_routing_profile_queues, params) req.send_request() end |
#disassociate_security_key(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
6453 6454 6455 6456 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6453 def disassociate_security_key(params = {}, = {}) req = build_request(:disassociate_security_key, params) req.send_request() end |
#disassociate_traffic_distribution_group_user(params = {}) ⇒ Struct
Disassociates an agent from a traffic distribution group.
6492 6493 6494 6495 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6492 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.
6528 6529 6530 6531 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6528 def disassociate_user_proficiencies(params = {}, = {}) req = build_request(:disassociate_user_proficiencies, params) req.send_request() end |
#dismiss_user_contact(params = {}) ⇒ Struct
Dismisses contacts from an agent’s CCP and returns the agent to an
available state, which allows the agent to receive a new routed
contact. Contacts can only be dismissed if they are in a MISSED
,
ERROR
, ENDED
, or REJECTED
state in the Agent Event Stream.
6566 6567 6568 6569 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6566 def dismiss_user_contact(params = {}, = {}) req = build_request(:dismiss_user_contact, params) req.send_request() end |
#get_attached_file(params = {}) ⇒ Types::GetAttachedFileResponse
Provides a pre-signed URL for download of an approved attached file.
This API also returns metadata about the attached file. It will only
return a downloadURL if the status of the attached file is APPROVED
.
6641 6642 6643 6644 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6641 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.
6674 6675 6676 6677 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6674 def get_contact_attributes(params = {}, = {}) req = build_request(:get_contact_attributes, params) req.send_request() end |
#get_current_metric_data(params = {}) ⇒ Types::GetCurrentMetricDataResponse
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6940 6941 6942 6943 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 6940 def get_current_metric_data(params = {}, = {}) req = build_request(:get_current_metric_data, params) req.send_request() end |
#get_current_user_data(params = {}) ⇒ Types::GetCurrentUserDataResponse
Gets the real-time active user data from the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7053 7054 7055 7056 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7053 def get_current_user_data(params = {}, = {}) req = build_request(:get_current_user_data, params) req.send_request() end |
#get_federation_token(params = {}) ⇒ Types::GetFederationTokenResponse
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
Provided identity: Principal: .... User: .... cannot be used for
federation with Amazon Connect
7114 7115 7116 7117 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7114 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.
7159 7160 7161 7162 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7159 def get_flow_association(params = {}, = {}) req = build_request(:get_flow_association, params) req.send_request() end |
#get_metric_data(params = {}) ⇒ Types::GetMetricDataResponse
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
GetMetricData
. Use it to retrieve historical agent and contact
metrics for the last 3 months, at varying intervals. You can also use
it to build custom dashboards to measure historical queue and agent
performance. For example, you can track the number of incoming
contacts for the last 7 days, with data split by day, to see how
contact volume changed per day of the week.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7475 7476 7477 7478 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 7475 def get_metric_data(params = {}, = {}) req = build_request(:get_metric_data, params) req.send_request() end |
#get_metric_data_v2(params = {}) ⇒ Types::GetMetricDataV2Response
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, the
previous version of this API. It has new metrics, offers filtering at
a metric level, and offers the ability to filter and group data by
channels, queues, routing profiles, agents, and agent hierarchy
levels. It can retrieve historical data for the last 3 months, at
varying intervals.
For a description of the historical metrics that are supported by
GetMetricDataV2
and GetMetricData
, see Historical metrics
definitions in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8903 8904 8905 8906 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8903 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.
8944 8945 8946 8947 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 8944 def get_prompt_file(params = {}, = {}) req = build_request(:get_prompt_file, params) req.send_request() end |
#get_task_template(params = {}) ⇒ Types::GetTaskTemplateResponse
Gets details about a specific task template in the specified Amazon Connect instance.
9024 9025 9026 9027 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9024 def get_task_template(params = {}, = {}) req = build_request(:get_task_template, params) req.send_request() end |
#get_traffic_distribution(params = {}) ⇒ Types::GetTrafficDistributionResponse
Retrieves the current traffic distribution for a given traffic distribution group.
9070 9071 9072 9073 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9070 def get_traffic_distribution(params = {}, = {}) req = build_request(:get_traffic_distribution, params) req.send_request() end |
#import_phone_number(params = {}) ⇒ Types::ImportPhoneNumberResponse
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
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.
9166 9167 9168 9169 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9166 def import_phone_number(params = {}, = {}) req = build_request(:import_phone_number, params) req.send_request() end |
#list_agent_statuses(params = {}) ⇒ Types::ListAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9226 9227 9228 9229 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9226 def list_agent_statuses(params = {}, = {}) req = build_request(:list_agent_statuses, params) req.send_request() end |
#list_analytics_data_associations(params = {}) ⇒ Types::ListAnalyticsDataAssociationsResponse
This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
9283 9284 9285 9286 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9283 def list_analytics_data_associations(params = {}, = {}) req = build_request(:list_analytics_data_associations, params) req.send_request() end |
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9335 9336 9337 9338 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9335 def list_approved_origins(params = {}, = {}) req = build_request(:list_approved_origins, params) req.send_request() end |
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9393 9394 9395 9396 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9393 def list_authentication_profiles(params = {}, = {}) req = build_request(:list_authentication_profiles, params) req.send_request() end |
#list_bots(params = {}) ⇒ Types::ListBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9452 9453 9454 9455 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9452 def list_bots(params = {}, = {}) req = build_request(:list_bots, params) req.send_request() end |
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9513 9514 9515 9516 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9513 def list_contact_evaluations(params = {}, = {}) req = build_request(:list_contact_evaluations, params) req.send_request() end |
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9569 9570 9571 9572 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9569 def list_contact_flow_modules(params = {}, = {}) req = build_request(:list_contact_flow_modules, params) req.send_request() end |
#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse
Provides information about the flows for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
For more information about flows, see Flows in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9639 9640 9641 9642 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9639 def list_contact_flows(params = {}, = {}) req = build_request(:list_contact_flows, params) req.send_request() end |
#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes
, returns a list of references
associated with the contact. References are links to documents that
are related to a contact, such as emails, attachments, or URLs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9711 9712 9713 9714 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9711 def list_contact_references(params = {}, = {}) req = build_request(:list_contact_references, params) req.send_request() end |
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9773 9774 9775 9776 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9773 def list_default_vocabularies(params = {}, = {}) req = build_request(:list_default_vocabularies, params) req.send_request() end |
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9834 9835 9836 9837 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9834 def list_evaluation_form_versions(params = {}, = {}) req = build_request(:list_evaluation_form_versions, params) req.send_request() end |
#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse
Lists evaluation forms in the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9892 9893 9894 9895 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9892 def list_evaluation_forms(params = {}, = {}) req = build_request(:list_evaluation_forms, params) req.send_request() end |
#list_flow_associations(params = {}) ⇒ Types::ListFlowAssociationsResponse
List the flow association based on the filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9946 9947 9948 9949 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 9946 def list_flow_associations(params = {}, = {}) req = build_request(:list_flow_associations, params) req.send_request() end |
#list_hours_of_operations(params = {}) ⇒ Types::ListHoursOfOperationsResponse
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10007 10008 10009 10010 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10007 def list_hours_of_operations(params = {}, = {}) req = build_request(:list_hours_of_operations, params) req.send_request() end |
#list_instance_attributes(params = {}) ⇒ Types::ListInstanceAttributesResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10060 10061 10062 10063 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10060 def list_instance_attributes(params = {}, = {}) req = build_request(:list_instance_attributes, params) req.send_request() end |
#list_instance_storage_configs(params = {}) ⇒ Types::ListInstanceStorageConfigsResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10127 10128 10129 10130 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10127 def list_instance_storage_configs(params = {}, = {}) req = build_request(:list_instance_storage_configs, params) req.send_request() end |
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10181 10182 10183 10184 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10181 def list_instances(params = {}, = {}) req = build_request(:list_instances, params) req.send_request() end |
#list_integration_associations(params = {}) ⇒ Types::ListIntegrationAssociationsResponse
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10245 10246 10247 10248 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10245 def list_integration_associations(params = {}, = {}) req = build_request(:list_integration_associations, params) req.send_request() end |
#list_lambda_functions(params = {}) ⇒ Types::ListLambdaFunctionsResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10297 10298 10299 10300 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10297 def list_lambda_functions(params = {}, = {}) req = build_request(:list_lambda_functions, params) req.send_request() end |
#list_lex_bots(params = {}) ⇒ Types::ListLexBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10356 10357 10358 10359 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10356 def list_lex_bots(params = {}, = {}) req = build_request(:list_lex_bots, params) req.send_request() end |
#list_phone_numbers(params = {}) ⇒ Types::ListPhoneNumbersResponse
Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types
UIFN
,SHARED
,THIRD_PARTY_TF
, andTHIRD_PARTY_DID
. While it returns numbers of those types, it incorrectly lists them asTOLL_FREE
orDID
.The phone number
Arn
value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with aResourceNotFoundException
. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10451 10452 10453 10454 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10451 def list_phone_numbers(params = {}, = {}) req = build_request(:list_phone_numbers, params) req.send_request() end |
#list_phone_numbers_v2(params = {}) ⇒ Types::ListPhoneNumbersV2Response
Lists phone numbers claimed to your Amazon Connect instance or traffic
distribution group. If the provided TargetArn
is a traffic
distribution group, you can call this API in both Amazon Web Services
Regions associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
ListPhoneNumbersV2
returns only the
phone numbers claimed to the instance.
- When given a traffic distribution group ARN
ListPhoneNumbersV2
returns only the phone numbers claimed to the traffic distribution group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10553 10554 10555 10556 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10553 def list_phone_numbers_v2(params = {}, = {}) req = build_request(:list_phone_numbers_v2, params) req.send_request() end |
#list_predefined_attributes(params = {}) ⇒ Types::ListPredefinedAttributesResponse
Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10607 10608 10609 10610 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10607 def list_predefined_attributes(params = {}, = {}) req = build_request(:list_predefined_attributes, params) req.send_request() end |
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Provides information about the prompts for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10656 10657 10658 10659 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10656 def list_prompts(params = {}, = {}) req = build_request(:list_prompts, params) req.send_request() end |
#list_queue_quick_connects(params = {}) ⇒ Types::ListQueueQuickConnectsResponse
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10721 10722 10723 10724 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10721 def list_queue_quick_connects(params = {}, = {}) req = build_request(:list_queue_quick_connects, params) req.send_request() end |
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes
parameter, both standard and
agent queues are returned. This might cause an unexpected truncation
of results if you have more than 1000 agents and you limit the number
of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10792 10793 10794 10795 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10792 def list_queues(params = {}, = {}) req = build_request(:list_queues, params) req.send_request() end |
#list_quick_connects(params = {}) ⇒ Types::ListQuickConnectsResponse
Provides information about the quick connects for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10854 10855 10856 10857 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10854 def list_quick_connects(params = {}, = {}) req = build_request(:list_quick_connects, params) req.send_request() end |
#list_realtime_contact_analysis_segments_v2(params = {}) ⇒ Types::ListRealtimeContactAnalysisSegmentsV2Response
Provides a list of analysis segments for a real-time analysis session.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10962 10963 10964 10965 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 10962 def list_realtime_contact_analysis_segments_v2(params = {}, = {}) req = build_request(:list_realtime_contact_analysis_segments_v2, params) req.send_request() end |
#list_routing_profile_queues(params = {}) ⇒ Types::ListRoutingProfileQueuesResponse
Lists the queues associated with a routing profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11024 11025 11026 11027 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11024 def list_routing_profile_queues(params = {}, = {}) req = build_request(:list_routing_profile_queues, params) req.send_request() end |
#list_routing_profiles(params = {}) ⇒ Types::ListRoutingProfilesResponse
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11087 11088 11089 11090 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11087 def list_routing_profiles(params = {}, = {}) req = build_request(:list_routing_profiles, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
List all rules for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11151 11152 11153 11154 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11151 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_security_keys(params = {}) ⇒ Types::ListSecurityKeysResponse
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11205 11206 11207 11208 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11205 def list_security_keys(params = {}, = {}) req = build_request(:list_security_keys, params) req.send_request() end |
#list_security_profile_applications(params = {}) ⇒ Types::ListSecurityProfileApplicationsResponse
Returns a list of third-party applications in a specific security profile.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11264 11265 11266 11267 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11264 def list_security_profile_applications(params = {}, = {}) req = build_request(:list_security_profile_applications, params) req.send_request() end |
#list_security_profile_permissions(params = {}) ⇒ Types::ListSecurityProfilePermissionsResponse
Lists the permissions granted to a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11330 11331 11332 11333 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11330 def (params = {}, = {}) req = build_request(:list_security_profile_permissions, params) req.send_request() end |
#list_security_profiles(params = {}) ⇒ Types::ListSecurityProfilesResponse
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11394 11395 11396 11397 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11394 def list_security_profiles(params = {}, = {}) req = build_request(:list_security_profiles, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
11437 11438 11439 11440 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11437 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_task_templates(params = {}) ⇒ Types::ListTaskTemplatesResponse
Lists task templates for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11507 11508 11509 11510 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11507 def list_task_templates(params = {}, = {}) req = build_request(:list_task_templates, params) req.send_request() end |
#list_traffic_distribution_group_users(params = {}) ⇒ Types::ListTrafficDistributionGroupUsersResponse
Lists traffic distribution group users.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11553 11554 11555 11556 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11553 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.
11606 11607 11608 11609 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11606 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.
11660 11661 11662 11663 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11660 def list_use_cases(params = {}, = {}) req = build_request(:list_use_cases, params) req.send_request() end |
#list_user_hierarchy_groups(params = {}) ⇒ Types::ListUserHierarchyGroupsResponse
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11721 11722 11723 11724 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11721 def list_user_hierarchy_groups(params = {}, = {}) req = build_request(:list_user_hierarchy_groups, params) req.send_request() end |
#list_user_proficiencies(params = {}) ⇒ Types::ListUserProficienciesResponse
Lists proficiencies associated with a user.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11775 11776 11777 11778 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11775 def list_user_proficiencies(params = {}, = {}) req = build_request(:list_user_proficiencies, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Provides summary information about the users for the specified Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11829 11830 11831 11832 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11829 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_view_versions(params = {}) ⇒ Types::ListViewVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Results will be sorted from highest to lowest.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11887 11888 11889 11890 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11887 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.
11943 11944 11945 11946 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 11943 def list_views(params = {}, = {}) req = build_request(:list_views, params) req.send_request() end |
#monitor_contact(params = {}) ⇒ Types::MonitorContactResponse
Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.
12005 12006 12007 12008 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12005 def monitor_contact(params = {}, = {}) req = build_request(:monitor_contact, params) req.send_request() end |
#pause_contact(params = {}) ⇒ Struct
Allows pausing an ongoing task contact.
12036 12037 12038 12039 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12036 def pause_contact(params = {}, = {}) req = build_request(:pause_contact, params) req.send_request() end |
#put_user_status(params = {}) ⇒ Struct
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
12081 12082 12083 12084 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12081 def put_user_status(params = {}, = {}) req = build_request(:put_user_status, params) req.send_request() end |
#release_phone_number(params = {}) ⇒ Struct
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.
To release phone numbers from a traffic distribution group, use the
ReleasePhoneNumber
API, not the Amazon Connect admin website.
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.
If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
12145 12146 12147 12148 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12145 def release_phone_number(params = {}, = {}) req = build_request(:release_phone_number, params) req.send_request() end |
#replicate_instance(params = {}) ⇒ Types::ReplicateInstanceResponse
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
12215 12216 12217 12218 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12215 def replicate_instance(params = {}, = {}) req = build_request(:replicate_instance, params) req.send_request() end |
#resume_contact(params = {}) ⇒ Struct
Allows resuming a task contact in a paused state.
12246 12247 12248 12249 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12246 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.
12288 12289 12290 12291 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12288 def resume_contact_recording(params = {}, = {}) req = build_request(:resume_contact_recording, params) req.send_request() end |
#search_agent_statuses(params = {}) ⇒ Types::SearchAgentStatusesResponse
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12394 12395 12396 12397 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12394 def search_agent_statuses(params = {}, = {}) req = build_request(:search_agent_statuses, params) req.send_request() end |
#search_available_phone_numbers(params = {}) ⇒ Types::SearchAvailablePhoneNumbersResponse
Searches for available phone numbers that you can claim to your Amazon
Connect instance or traffic distribution group. If the provided
TargetArn
is a traffic distribution group, you can call this API in
both Amazon Web Services Regions associated with the traffic
distribution group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12469 12470 12471 12472 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12469 def search_available_phone_numbers(params = {}, = {}) req = build_request(:search_available_phone_numbers, params) req.send_request() end |
#search_contact_flow_modules(params = {}) ⇒ Types::SearchContactFlowModulesResponse
Searches the flow modules in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12576 12577 12578 12579 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12576 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 contact flows in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12687 12688 12689 12690 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12687 def search_contact_flows(params = {}, = {}) req = build_request(:search_contact_flows, params) req.send_request() end |
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Amazon Connect instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12797 12798 12799 12800 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12797 def search_contacts(params = {}, = {}) req = build_request(:search_contacts, params) req.send_request() end |
#search_hours_of_operations(params = {}) ⇒ Types::SearchHoursOfOperationsResponse
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12907 12908 12909 12910 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12907 def search_hours_of_operations(params = {}, = {}) req = build_request(:search_hours_of_operations, params) req.send_request() end |
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12985 12986 12987 12988 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 12985 def search_predefined_attributes(params = {}, = {}) req = build_request(:search_predefined_attributes, params) req.send_request() end |
#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse
Searches prompts in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13088 13089 13090 13091 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13088 def search_prompts(params = {}, = {}) req = build_request(:search_prompts, params) req.send_request() end |
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13205 13206 13207 13208 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13205 def search_queues(params = {}, = {}) req = build_request(:search_queues, params) req.send_request() end |
#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse
Searches quick connects in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13314 13315 13316 13317 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13314 def search_quick_connects(params = {}, = {}) req = build_request(:search_quick_connects, params) req.send_request() end |
#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse
Searches tags used in an Amazon Connect instance using optional search criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13395 13396 13397 13398 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13395 def (params = {}, = {}) req = build_request(:search_resource_tags, params) req.send_request() end |
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Amazon Connect instance, with optional filtering.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13517 13518 13519 13520 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13517 def search_routing_profiles(params = {}, = {}) req = build_request(:search_routing_profiles, params) req.send_request() end |
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Amazon Connect instance, with optional filtering.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13639 13640 13641 13642 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13639 def search_security_profiles(params = {}, = {}) req = build_request(:search_security_profiles, params) req.send_request() end |
#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
The UserHierarchyGroup with "LevelId": "0"
is the foundation for
building levels on top of an instance. It is not user-definable, nor
is it visible in the UI.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13771 13772 13773 13774 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13771 def search_user_hierarchy_groups(params = {}, = {}) req = build_request(:search_user_hierarchy_groups, params) req.send_request() end |
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users in an Amazon Connect instance, with optional filtering.
AfterContactWorkTimeLimit
is returned in milliseconds.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13955 13956 13957 13958 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 13955 def search_users(params = {}, = {}) req = build_request(:search_users, params) req.send_request() end |
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Amazon Connect instance
using State
, NameStartsWith
, and LanguageCode
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14028 14029 14030 14031 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14028 def search_vocabularies(params = {}, = {}) req = build_request(:search_vocabularies, params) req.send_request() end |
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:
SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat
When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.
Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
14112 14113 14114 14115 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14112 def send_chat_integration_event(params = {}, = {}) req = build_request(:send_chat_integration_event, params) req.send_request() end |
#start_attached_file_upload(params = {}) ⇒ Types::StartAttachedFileUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
14220 14221 14222 14223 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14220 def start_attached_file_upload(params = {}, = {}) req = build_request(:start_attached_file_upload, params) req.send_request() end |
#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse
Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a
TooManyRequests
exception.The quota for concurrent active chats is exceeded. Active chat throttling returns a
LimitExceededException
.
If you use the ChatDurationInMinutes
parameter and receive a 400
error, your account may not support the ability to configure custom
chat durations. For more information, contact Amazon Web Services
Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
14423 14424 14425 14426 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14423 def start_chat_contact(params = {}, = {}) req = build_request(:start_chat_contact, params) req.send_request() end |
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.
14489 14490 14491 14492 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14489 def start_contact_evaluation(params = {}, = {}) req = build_request(:start_contact_evaluation, params) req.send_request() end |
#start_contact_recording(params = {}) ⇒ Struct
Starts recording the contact:
If the API is called before the agent joins the call, recording starts when the agent joins the call.
If the API is called after the agent joins the call, recording starts at the time of the API call.
StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
14553 14554 14555 14556 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14553 def start_contact_recording(params = {}, = {}) req = build_request(:start_contact_recording, params) req.send_request() end |
#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse
Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
14630 14631 14632 14633 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14630 def start_contact_streaming(params = {}, = {}) req = build_request(:start_contact_streaming, params) req.send_request() end |
#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse
Places an outbound call to a contact, and then initiates the flow. It
performs the actions in the flow that's specified (in
ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
TrafficType
= CAMPAIGN
, you must submit a service quota
increase request to the quota Amazon Connect campaigns.
14798 14799 14800 14801 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14798 def start_outbound_voice_contact(params = {}, = {}) req = build_request(:start_outbound_voice_contact, params) req.send_request() end |
#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId
and RelatedContactId
input
parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same
PreviousContactId
will affect every contact in the chain.There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same
PreviousContactId
.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same
RelatedContactId
.
In addition, when calling StartTaskContact include only one of these
parameters: ContactFlowID
, QuickConnectID
, or TaskTemplateID
.
Only one parameter is required as long as the task template has a flow
configured to run it. If more than one parameter is specified, or only
the TaskTemplateID
is specified but it does not have a flow
configured, the request returns an error because Amazon Connect cannot
identify the unique flow to run when the task is created.
A ServiceQuotaExceededException
occurs when the number of open tasks
exceeds the active tasks quota or there are already 12 tasks
referencing the same PreviousContactId
. For more information about
service quotas for task contacts, see Amazon Connect service
quotas in the Amazon Connect Administrator Guide.
14983 14984 14985 14986 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 14983 def start_task_contact(params = {}, = {}) req = build_request(:start_task_contact, params) req.send_request() end |
#start_web_rtc_contact(params = {}) ⇒ Types::StartWebRTCContactResponse
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
15113 15114 15115 15116 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15113 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.
15166 15167 15168 15169 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15166 def stop_contact(params = {}, = {}) req = build_request(:stop_contact, params) req.send_request() end |
#stop_contact_recording(params = {}) ⇒ Struct
Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
15210 15211 15212 15213 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15210 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.
15251 15252 15253 15254 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15251 def stop_contact_streaming(params = {}, = {}) req = build_request(:stop_contact_streaming, params) req.send_request() end |
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
Submits a contact evaluation in the specified Amazon Connect instance.
Answers included in the request are merged with existing answers for
the given evaluation. If no answers or notes are passed, the
evaluation is submitted with the existing answers and notes. You can
delete an answer or note by passing an empty object (\{\}
) to the
question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
15318 15319 15320 15321 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15318 def submit_contact_evaluation(params = {}, = {}) req = build_request(:submit_contact_evaluation, params) req.send_request() end |
#suspend_contact_recording(params = {}) ⇒ Struct
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
The period of time that the recording is suspended is filled with silence in the final recording.
Voice and screen recordings are supported.
15364 15365 15366 15367 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15364 def suspend_contact_recording(params = {}, = {}) req = build_request(:suspend_contact_recording, params) req.send_request() end |
#tag_contact(params = {}) ⇒ Struct
Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
15412 15413 15414 15415 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15412 def tag_contact(params = {}, = {}) req = build_request(:tag_contact, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
15455 15456 15457 15458 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15455 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#transfer_contact(params = {}) ⇒ Types::TransferContactResponse
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.
Note the following requirements:
Transfer is supported for only
TASK
contacts.Do not use both
QueueId
andUserId
in the same call.The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
The
TransferContact
API can be called only on active contacts.A contact cannot be transferred more than 11 times.
15539 15540 15541 15542 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15539 def transfer_contact(params = {}, = {}) req = build_request(:transfer_contact, params) req.send_request() end |
#untag_contact(params = {}) ⇒ Struct
Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.
15581 15582 15583 15584 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15581 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.
15607 15608 15609 15610 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15607 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
15661 15662 15663 15664 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15661 def update_agent_status(params = {}, = {}) req = build_request(:update_agent_status, params) req.send_request() end |
#update_authentication_profile(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
15739 15740 15741 15742 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15739 def update_authentication_profile(params = {}, = {}) req = build_request(:update_authentication_profile, params) req.send_request() end |
#update_contact(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
You can add or update user-defined contact information for both ongoing and completed contacts.
15797 15798 15799 15800 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15797 def update_contact(params = {}, = {}) req = build_request(:update_contact, params) req.send_request() end |
#update_contact_attributes(params = {}) ⇒ Struct
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
15878 15879 15880 15881 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15878 def update_contact_attributes(params = {}, = {}) req = build_request(:update_contact_attributes, params) req.send_request() end |
#update_contact_evaluation(params = {}) ⇒ Types::UpdateContactEvaluationResponse
Updates details about a contact evaluation in the specified Amazon
Connect instance. A contact evaluation must be in draft state. Answers
included in the request are merged with existing answers for the given
evaluation. An answer or note can be deleted by passing an empty
object (\{\}
) to the question identifier.
15941 15942 15943 15944 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15941 def update_contact_evaluation(params = {}, = {}) req = build_request(:update_contact_evaluation, params) req.send_request() end |
#update_contact_flow_content(params = {}) ⇒ Struct
Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED
. Once
a contact flow is published, $SAVED
needs to be supplied to view
saved content that has not been published.
15990 15991 15992 15993 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 15990 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.
16033 16034 16035 16036 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16033 def (params = {}, = {}) req = build_request(:update_contact_flow_metadata, params) req.send_request() end |
#update_contact_flow_module_content(params = {}) ⇒ Struct
Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED
. Once
a contact flow is published, $SAVED
needs to be supplied to view
saved content that has not been published.
16079 16080 16081 16082 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16079 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.
16122 16123 16124 16125 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16122 def (params = {}, = {}) req = build_request(:update_contact_flow_module_metadata, params) req.send_request() end |
#update_contact_flow_name(params = {}) ⇒ Struct
The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
16163 16164 16165 16166 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16163 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.
16263 16264 16265 16266 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16263 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.
16301 16302 16303 16304 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16301 def update_contact_schedule(params = {}, = {}) req = build_request(:update_contact_schedule, params) req.send_request() end |
#update_evaluation_form(params = {}) ⇒ Types::UpdateEvaluationFormResponse
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
16452 16453 16454 16455 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16452 def update_evaluation_form(params = {}, = {}) req = build_request(:update_evaluation_form, params) req.send_request() end |
#update_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
16514 16515 16516 16517 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16514 def update_hours_of_operation(params = {}, = {}) req = build_request(:update_hours_of_operation, params) req.send_request() end |
#update_instance_attribute(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
16558 16559 16560 16561 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16558 def update_instance_attribute(params = {}, = {}) req = build_request(:update_instance_attribute, params) req.send_request() end |
#update_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates an existing configuration for a resource type. This API is idempotent.
16627 16628 16629 16630 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16627 def update_instance_storage_config(params = {}, = {}) req = build_request(:update_instance_storage_config, params) req.send_request() end |
#update_participant_role_config(params = {}) ⇒ Struct
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
Customer idle timeout
Customer auto-disconnect timeout
Agent idle timeout
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
16692 16693 16694 16695 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16692 def update_participant_role_config(params = {}, = {}) req = build_request(:update_participant_role_config, params) req.send_request() end |
#update_phone_number(params = {}) ⇒ Types::UpdatePhoneNumberResponse
Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.
You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.
16770 16771 16772 16773 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16770 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.
16817 16818 16819 16820 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16817 def (params = {}, = {}) req = build_request(:update_phone_number_metadata, params) req.send_request() end |
#update_predefined_attribute(params = {}) ⇒ Struct
Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
16858 16859 16860 16861 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16858 def update_predefined_attribute(params = {}, = {}) req = build_request(:update_predefined_attribute, params) req.send_request() end |
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Updates a prompt.
16915 16916 16917 16918 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16915 def update_prompt(params = {}, = {}) req = build_request(:update_prompt, params) req.send_request() end |
#update_queue_hours_of_operation(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation for the specified queue.
16953 16954 16955 16956 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16953 def update_queue_hours_of_operation(params = {}, = {}) req = build_request(:update_queue_hours_of_operation, params) req.send_request() end |
#update_queue_max_contacts(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the maximum number of contacts allowed in a queue before it is considered full.
16993 16994 16995 16996 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 16993 def update_queue_max_contacts(params = {}, = {}) req = build_request(:update_queue_max_contacts, params) req.send_request() end |
#update_queue_name(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name
or
Description
must be provided.
17036 17037 17038 17039 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17036 def update_queue_name(params = {}, = {}) req = build_request(:update_queue_name, params) req.send_request() end |
#update_queue_outbound_caller_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for
OutboundCallerIdNumberId
. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive aResourceNotFoundException
.Only use the phone number ARN format that doesn't contain
instance
in the path, for example,arn:aws:connect:us-east-1:1234567890:phone-number/uuid
. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
17106 17107 17108 17109 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17106 def update_queue_outbound_caller_config(params = {}, = {}) req = build_request(:update_queue_outbound_caller_config, params) req.send_request() end |
#update_queue_status(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
17144 17145 17146 17147 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17144 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.
17192 17193 17194 17195 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17192 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.
17233 17234 17235 17236 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17233 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.
17272 17273 17274 17275 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17272 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.
17317 17318 17319 17320 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17317 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.
17352 17353 17354 17355 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17352 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.
17394 17395 17396 17397 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17394 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.
17441 17442 17443 17444 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17441 def update_routing_profile_queues(params = {}, = {}) req = build_request(:update_routing_profile_queues, params) req.send_request() end |
#update_rule(params = {}) ⇒ Struct
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
17563 17564 17565 17566 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17563 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |
#update_security_profile(params = {}) ⇒ Struct
Updates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
17649 17650 17651 17652 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17649 def update_security_profile(params = {}, = {}) req = build_request(:update_security_profile, params) req.send_request() end |
#update_task_template(params = {}) ⇒ Types::UpdateTaskTemplateResponse
Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.
17795 17796 17797 17798 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17795 def update_task_template(params = {}, = {}) req = build_request(:update_task_template, params) req.send_request() end |
#update_traffic_distribution(params = {}) ⇒ Struct
Updates the traffic distribution for a given traffic distribution group.
SignInConfig
distribution is available only on a default
TrafficDistributionGroup
(see the IsDefault
parameter in the
TrafficDistributionGroup data type). If you call
UpdateTrafficDistribution
with a modified SignInConfig
and a
non-default TrafficDistributionGroup
, an InvalidRequestException
is returned.
For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.
17874 17875 17876 17877 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17874 def update_traffic_distribution(params = {}, = {}) req = build_request(:update_traffic_distribution, params) req.send_request() end |
#update_user_hierarchy(params = {}) ⇒ Struct
Assigns the specified hierarchy group to the specified user.
17909 17910 17911 17912 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17909 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.
17944 17945 17946 17947 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17944 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.
17992 17993 17994 17995 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 17992 def update_user_hierarchy_structure(params = {}, = {}) req = build_request(:update_user_hierarchy_structure, params) req.send_request() end |
#update_user_identity_info(params = {}) ⇒ Struct
Updates the identity information for the specified user.
We strongly recommend limiting who has the ability to invoke
UpdateUserIdentityInfo
. Someone with that ability can change the
login credentials of other users by changing their email address. This
poses a security risk to your organization. They can change the email
address of a user to the attacker's email address, and then reset the
password through email. For more information, see Best Practices for
Security Profiles in the Amazon Connect Administrator Guide.
18045 18046 18047 18048 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18045 def update_user_identity_info(params = {}, = {}) req = build_request(:update_user_identity_info, params) req.send_request() end |
#update_user_phone_config(params = {}) ⇒ Struct
Updates the phone configuration settings for the specified user.
18085 18086 18087 18088 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18085 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.
18124 18125 18126 18127 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18124 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.
18159 18160 18161 18162 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18159 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.
18194 18195 18196 18197 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18194 def update_user_security_profiles(params = {}, = {}) req = build_request(:update_user_security_profiles, params) req.send_request() end |
#update_view_content(params = {}) ⇒ Types::UpdateViewContentResponse
Updates the view content of the given view identifier in the specified Amazon Connect instance.
It performs content validation if Status
is set to SAVED
and
performs full content validation if Status
is PUBLISHED
. Note that
the $SAVED
alias' content will always be updated, but the $LATEST
alias' content will only be updated if Status
is PUBLISHED
.
18265 18266 18267 18268 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18265 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.
18301 18302 18303 18304 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 18301 def (params = {}, = {}) req = build_request(:update_view_metadata, params) req.send_request() end |