Class: Aws::Connect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Connect::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb
Overview
An API client for Connect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Connect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_evaluation_form(params = {}) ⇒ Types::ActivateEvaluationFormResponse
Activates an evaluation form in the specified Amazon Connect instance.
-
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
Associates the specified dataset for a Amazon Connect instance with the target account.
-
#associate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#associate_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
Associates a list of analytics datasets for a given Amazon Connect instance to a target account.
-
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
Removes a list of analytics datasets associated with a given Amazon Connect instance.
-
#batch_get_attached_file_metadata(params = {}) ⇒ Types::BatchGetAttachedFileMetadataResponse
Allows you to retrieve metadata about multiple attached files on an associated resource.
-
#batch_get_flow_association(params = {}) ⇒ Types::BatchGetFlowAssociationResponse
Retrieve the flow associations for the given resources.
-
#batch_put_contact(params = {}) ⇒ Types::BatchPutContactResponse
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. -
#claim_phone_number(params = {}) ⇒ Types::ClaimPhoneNumberResponse
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
-
#complete_attached_file_upload(params = {}) ⇒ Struct
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
-
#create_agent_status(params = {}) ⇒ Types::CreateAgentStatusResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#create_contact(params = {}) ⇒ Types::CreateContactResponse
Creates a new contact.
-
#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse
Creates a flow for the specified Amazon Connect instance.
-
#create_contact_flow_module(params = {}) ⇒ Types::CreateContactFlowModuleResponse
Creates a flow module for the specified Amazon Connect instance.
-
#create_contact_flow_version(params = {}) ⇒ Types::CreateContactFlowVersionResponse
Publishes a new version of the flow provided.
-
#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse
Create new email address in the specified Amazon Connect instance.
-
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
Creates an evaluation form in the specified Amazon Connect instance.
-
#create_hours_of_operation(params = {}) ⇒ Types::CreateHoursOfOperationResponse
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_push_notification_registration(params = {}) ⇒ Types::CreatePushNotificationRegistrationResponse
Creates registration for a device token and a chat contact to receive real-time push notifications.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
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_email_address(params = {}) ⇒ Struct
Deletes email address from the specified Amazon Connect instance.
-
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Amazon Connect instance.
-
#delete_hours_of_operation(params = {}) ⇒ Struct
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_push_notification_registration(params = {}) ⇒ Struct
Deletes registration for a device token and a chat contact.
-
#delete_queue(params = {}) ⇒ Struct
Deletes a queue.
-
#delete_quick_connect(params = {}) ⇒ Struct
Deletes a quick connect.
-
#delete_routing_profile(params = {}) ⇒ Struct
Deletes a routing profile.
-
#delete_rule(params = {}) ⇒ Struct
Deletes a rule for the specified Amazon Connect instance.
-
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
-
#delete_task_template(params = {}) ⇒ Struct
Deletes the task template.
-
#delete_traffic_distribution_group(params = {}) ⇒ Struct
Deletes a traffic distribution group.
-
#delete_use_case(params = {}) ⇒ Struct
Deletes a use case from an integration association.
-
#delete_user(params = {}) ⇒ Struct
Deletes a user account from the specified Amazon Connect instance.
-
#delete_user_hierarchy_group(params = {}) ⇒ Struct
Deletes an existing user hierarchy group.
-
#delete_view(params = {}) ⇒ Struct
Deletes the view entirely.
-
#delete_view_version(params = {}) ⇒ Struct
Deletes the particular version specified in
ViewVersion
identifier. -
#delete_vocabulary(params = {}) ⇒ Types::DeleteVocabularyResponse
Deletes the vocabulary that has the given identifier.
-
#describe_agent_status(params = {}) ⇒ Types::DescribeAgentStatusResponse
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_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse
Describe email address form the specified Amazon Connect instance.
-
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Amazon Connect instance.
-
#describe_hours_of_operation(params = {}) ⇒ Types::DescribeHoursOfOperationResponse
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
Removes the dataset ID associated with a given Amazon Connect instance.
-
#disassociate_approved_origin(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_flow(params = {}) ⇒ Struct
Disassociates a connect resource from a flow.
-
#disassociate_instance_storage_config(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_lambda_function(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_lex_bot(params = {}) ⇒ Struct
This API is in preview release for Amazon Connect and is subject to change.
-
#disassociate_phone_number_contact_flow(params = {}) ⇒ Struct
Removes the flow association from a phone number claimed to your Amazon Connect instance.
-
#disassociate_queue_quick_connects(params = {}) ⇒ Struct
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 Web Services End User Messaging, 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
Lists the association status of requested dataset ID for a given Amazon Connect instance.
-
#list_approved_origins(params = {}) ⇒ Types::ListApprovedOriginsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_associated_contacts(params = {}) ⇒ Types::ListAssociatedContactsResponse
Provides information about contact tree, a list of associated contacts with a unique identifier.
-
#list_authentication_profiles(params = {}) ⇒ Types::ListAuthenticationProfilesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_bots(params = {}) ⇒ Types::ListBotsResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_contact_evaluations(params = {}) ⇒ Types::ListContactEvaluationsResponse
Lists contact evaluations in the specified Amazon Connect instance.
-
#list_contact_flow_modules(params = {}) ⇒ Types::ListContactFlowModulesResponse
Provides information about the flow modules for the specified Amazon Connect instance.
-
#list_contact_flow_versions(params = {}) ⇒ Types::ListContactFlowVersionsResponse
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
-
#list_contact_flows(params = {}) ⇒ Types::ListContactFlowsResponse
Provides information about the flows for the specified Amazon Connect instance.
-
#list_contact_references(params = {}) ⇒ Types::ListContactReferencesResponse
This API is in preview release for Amazon Connect and is subject to change.
-
#list_default_vocabularies(params = {}) ⇒ Types::ListDefaultVocabulariesResponse
Lists the default vocabularies for the specified Amazon Connect instance.
-
#list_evaluation_form_versions(params = {}) ⇒ Types::ListEvaluationFormVersionsResponse
Lists versions of an evaluation form in the specified Amazon Connect instance.
-
#list_evaluation_forms(params = {}) ⇒ Types::ListEvaluationFormsResponse
Lists evaluation forms in the specified Amazon Connect instance.
-
#list_flow_associations(params = {}) ⇒ Types::ListFlowAssociationsResponse
List the flow association based on the filters.
-
#list_hours_of_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 flows in an Amazon Connect instance, with optional filtering.
-
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts in an Amazon Connect instance.
-
#search_email_addresses(params = {}) ⇒ Types::SearchEmailAddressesResponse
Searches email address in an instance, with optional filtering.
-
#search_hours_of_operations(params = {}) ⇒ Types::SearchHoursOfOperationsResponse
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
-
#search_predefined_attributes(params = {}) ⇒ Types::SearchPredefinedAttributesResponse
Searches predefined attributes that meet certain criteria.
-
#search_prompts(params = {}) ⇒ Types::SearchPromptsResponse
Searches prompts in an Amazon Connect instance, with optional filtering.
-
#search_queues(params = {}) ⇒ Types::SearchQueuesResponse
Searches queues in an Amazon Connect instance, with optional filtering.
-
#search_quick_connects(params = {}) ⇒ Types::SearchQuickConnectsResponse
Searches quick connects in an Amazon Connect instance, with optional filtering.
-
#search_resource_tags(params = {}) ⇒ Types::SearchResourceTagsResponse
Searches tags used in an Amazon Connect instance using optional search criteria.
-
#search_routing_profiles(params = {}) ⇒ Types::SearchRoutingProfilesResponse
Searches routing profiles in an Amazon Connect instance, with optional filtering.
-
#search_security_profiles(params = {}) ⇒ Types::SearchSecurityProfilesResponse
Searches security profiles in an Amazon Connect instance, with optional filtering.
-
#search_user_hierarchy_groups(params = {}) ⇒ Types::SearchUserHierarchyGroupsResponse
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
-
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users in an Amazon Connect instance, with optional filtering.
-
#search_vocabularies(params = {}) ⇒ Types::SearchVocabulariesResponse
Searches for vocabularies within a specific Amazon Connect instance using
State
,NameStartsWith
, andLanguageCode
. -
#send_chat_integration_event(params = {}) ⇒ Types::SendChatIntegrationEventResponse
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
-
#send_outbound_email(params = {}) ⇒ Struct
Send outbound email for outbound campaigns.
-
#start_attached_file_upload(params = {}) ⇒ Types::StartAttachedFileUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading your content.
-
#start_chat_contact(params = {}) ⇒ Types::StartChatContactResponse
Initiates a flow to start a new chat for the customer.
-
#start_contact_evaluation(params = {}) ⇒ Types::StartContactEvaluationResponse
Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
-
#start_contact_recording(params = {}) ⇒ Struct
Starts recording the contact:.
-
#start_contact_streaming(params = {}) ⇒ Types::StartContactStreamingResponse
Initiates real-time message streaming for a new chat contact.
-
#start_email_contact(params = {}) ⇒ Types::StartEmailContactResponse
Creates an inbound email contact and initiates a flow to start the email contact for the customer.
-
#start_outbound_chat_contact(params = {}) ⇒ Types::StartOutboundChatContactResponse
Initiates a new outbound SMS contact to a customer.
-
#start_outbound_email_contact(params = {}) ⇒ Types::StartOutboundEmailContactResponse
Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
-
#start_outbound_voice_contact(params = {}) ⇒ Types::StartOutboundVoiceContactResponse
Places an outbound call to a contact, and then initiates the flow.
-
#start_screen_sharing(params = {}) ⇒ Struct
Starts screen sharing for a contact.
-
#start_task_contact(params = {}) ⇒ Types::StartTaskContactResponse
Initiates a flow to start a new task contact.
-
#start_web_rtc_contact(params = {}) ⇒ Types::StartWebRTCContactResponse
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
-
#stop_contact(params = {}) ⇒ Struct
Ends the specified contact.
-
#stop_contact_recording(params = {}) ⇒ Struct
Stops recording a call when a contact is being recorded.
-
#stop_contact_streaming(params = {}) ⇒ Struct
Ends message streaming on a specified contact.
-
#submit_contact_evaluation(params = {}) ⇒ Types::SubmitContactEvaluationResponse
Submits a contact evaluation in the specified Amazon Connect instance.
-
#suspend_contact_recording(params = {}) ⇒ Struct
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, 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_email_address_metadata(params = {}) ⇒ Types::UpdateEmailAddressMetadataResponse
Updates an email address metadata.
-
#update_evaluation_form(params = {}) ⇒ Types::UpdateEvaluationFormResponse
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
-
#update_hours_of_operation(params = {}) ⇒ Struct
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_outbound_email_config(params = {}) ⇒ Struct
Updates the outbound email address Id for a specified queue.
-
#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.
444 445 446 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 444 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.
494 495 496 497 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 494 def activate_evaluation_form(params = {}, = {}) req = build_request(:activate_evaluation_form, params) req.send_request() end |
#associate_analytics_data_set(params = {}) ⇒ Types::AssociateAnalyticsDataSetResponse
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
546 547 548 549 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 546 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.
580 581 582 583 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 580 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.
624 625 626 627 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 624 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.
668 669 670 671 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 668 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.
713 714 715 716 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 713 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.
810 811 812 813 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 810 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.
846 847 848 849 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 846 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.
885 886 887 888 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 885 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
.
932 933 934 935 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 932 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.
970 971 972 973 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 970 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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1014 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.
1054 1055 1056 1057 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1054 def associate_security_key(params = {}, = {}) req = build_request(:associate_security_key, params) req.send_request() end |
#associate_traffic_distribution_group_user(params = {}) ⇒ Struct
Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1093 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.
1130 1131 1132 1133 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1130 def associate_user_proficiencies(params = {}, = {}) req = build_request(:associate_user_proficiencies, params) req.send_request() end |
#batch_associate_analytics_data_set(params = {}) ⇒ Types::BatchAssociateAnalyticsDataSetResponse
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
1184 1185 1186 1187 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1184 def batch_associate_analytics_data_set(params = {}, = {}) req = build_request(:batch_associate_analytics_data_set, params) req.send_request() end |
#batch_disassociate_analytics_data_set(params = {}) ⇒ Types::BatchDisassociateAnalyticsDataSetResponse
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1235 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.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1300 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.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1350 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1442 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1557 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.
1598 1599 1600 1601 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1598 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.
1660 1661 1662 1663 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1660 def create_agent_status(params = {}, = {}) req = build_request(:create_agent_status, params) req.send_request() end |
#create_contact(params = {}) ⇒ Types::CreateContactResponse
Creates a new contact.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1797 def create_contact(params = {}, = {}) req = build_request(:create_contact, params) req.send_request() end |
#create_contact_flow(params = {}) ⇒ Types::CreateContactFlowResponse
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1879 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.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 1953 def create_contact_flow_module(params = {}, = {}) req = build_request(:create_contact_flow_module, params) req.send_request() end |
#create_contact_flow_version(params = {}) ⇒ Types::CreateContactFlowVersionResponse
Publishes a new version of the flow provided. Versions are immutable
and monotonically increasing. If a version of the same flow content
already exists, no new version is created and instead the existing
version number is returned. If the FlowContentSha256
provided is
different from the FlowContentSha256
of the $LATEST
published flow
content, then an error is returned. This API only supports creating
versions for flows of type Campaign
.
2009 2010 2011 2012 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2009 def create_contact_flow_version(params = {}, = {}) req = build_request(:create_contact_flow_version, params) req.send_request() end |
#create_email_address(params = {}) ⇒ Types::CreateEmailAddressResponse
Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
2082 2083 2084 2085 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2082 def create_email_address(params = {}, = {}) req = build_request(:create_email_address, params) req.send_request() end |
#create_evaluation_form(params = {}) ⇒ Types::CreateEvaluationFormResponse
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
2217 2218 2219 2220 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2217 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.
2292 2293 2294 2295 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2292 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.
2369 2370 2371 2372 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2369 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.
2442 2443 2444 2445 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2442 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.
2514 2515 2516 2517 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2514 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.
2636 2637 2638 2639 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2636 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.
2677 2678 2679 2680 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2677 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.
2744 2745 2746 2747 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2744 def create_prompt(params = {}, = {}) req = build_request(:create_prompt, params) req.send_request() end |
#create_push_notification_registration(params = {}) ⇒ Types::CreatePushNotificationRegistrationResponse
Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.
2818 2819 2820 2821 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2818 def create_push_notification_registration(params = {}, = {}) req = build_request(:create_push_notification_registration, 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.
2926 2927 2928 2929 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2926 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.
2994 2995 2996 2997 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 2994 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.
3093 3094 3095 3096 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3093 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.
3240 3241 3242 3243 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3240 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.
3344 3345 3346 3347 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3344 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.
3471 3472 3473 3474 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3471 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.
3551 3552 3553 3554 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3551 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.
3603 3604 3605 3606 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3603 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.
3726 3727 3728 3729 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3726 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.
3779 3780 3781 3782 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3779 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.
3870 3871 3872 3873 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3870 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.
3934 3935 3936 3937 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 3934 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.
4025 4026 4027 4028 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4025 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.
4073 4074 4075 4076 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4073 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.
4115 4116 4117 4118 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4115 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.
4146 4147 4148 4149 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4146 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.
4177 4178 4179 4180 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4177 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.
4208 4209 4210 4211 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4208 def delete_contact_flow_module(params = {}, = {}) req = build_request(:delete_contact_flow_module, params) req.send_request() end |
#delete_email_address(params = {}) ⇒ Struct
Deletes email address from the specified Amazon Connect instance.
4239 4240 4241 4242 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4239 def delete_email_address(params = {}, = {}) req = build_request(:delete_email_address, params) req.send_request() end |
#delete_evaluation_form(params = {}) ⇒ Struct
Deletes an evaluation form in the specified Amazon Connect instance.
If the version property is provided, only the specified version of the evaluation form is deleted.
If no version is provided, then the full form (all versions) is deleted.
4280 4281 4282 4283 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4280 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.
4314 4315 4316 4317 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4314 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.
4357 4358 4359 4360 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4357 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.
4390 4391 4392 4393 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4390 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.
4418 4419 4420 4421 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4418 def delete_predefined_attribute(params = {}, = {}) req = build_request(:delete_predefined_attribute, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Struct
Deletes a prompt.
4449 4450 4451 4452 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4449 def delete_prompt(params = {}, = {}) req = build_request(:delete_prompt, params) req.send_request() end |
#delete_push_notification_registration(params = {}) ⇒ Struct
Deletes registration for a device token and a chat contact.
4484 4485 4486 4487 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4484 def delete_push_notification_registration(params = {}, = {}) req = build_request(:delete_push_notification_registration, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
4516 4517 4518 4519 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4516 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.
4565 4566 4567 4568 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4565 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.
4596 4597 4598 4599 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4596 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.
4627 4628 4629 4630 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4627 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_security_profile(params = {}) ⇒ Struct
Deletes a security profile.
4658 4659 4660 4661 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4658 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.
4689 4690 4691 4692 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4689 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.
4721 4722 4723 4724 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4721 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.
4756 4757 4758 4759 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4756 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.
4809 4810 4811 4812 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4809 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.
4841 4842 4843 4844 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4841 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).
4869 4870 4871 4872 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4869 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.
4900 4901 4902 4903 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4900 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.
4941 4942 4943 4944 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4941 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.
4991 4992 4993 4994 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 4991 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.
5045 5046 5047 5048 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5045 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 from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API
5177 5178 5179 5180 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5177 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.
5279 5280 5281 5282 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5279 def describe_contact_evaluation(params = {}, = {}) req = build_request(:describe_contact_evaluation, params) req.send_request() end |
#describe_contact_flow(params = {}) ⇒ Types::DescribeContactFlowResponse
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. After
a flow is published, $SAVED
needs to be supplied to view saved
content that has not been published.
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
5342 5343 5344 5345 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5342 def describe_contact_flow(params = {}, = {}) req = build_request(:describe_contact_flow, params) req.send_request() end |
#describe_contact_flow_module(params = {}) ⇒ Types::DescribeContactFlowModuleResponse
Describes the specified flow module.
Use the $SAVED
alias in the request to describe the SAVED
content
of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. After
a flow is published, $SAVED
needs to be supplied to view saved
content that has not been published.
5392 5393 5394 5395 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5392 def describe_contact_flow_module(params = {}, = {}) req = build_request(:describe_contact_flow_module, params) req.send_request() end |
#describe_email_address(params = {}) ⇒ Types::DescribeEmailAddressResponse
Describe email address form the specified Amazon Connect instance.
5444 5445 5446 5447 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5444 def describe_email_address(params = {}, = {}) req = build_request(:describe_email_address, params) req.send_request() end |
#describe_evaluation_form(params = {}) ⇒ Types::DescribeEvaluationFormResponse
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
5532 5533 5534 5535 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5532 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.
5586 5587 5588 5589 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5586 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.
5648 5649 5650 5651 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5648 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.
5689 5690 5691 5692 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5689 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.
5746 5747 5748 5749 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5746 def describe_instance_storage_config(params = {}, = {}) req = build_request(:describe_instance_storage_config, params) req.send_request() end |
#describe_phone_number(params = {}) ⇒ Types::DescribePhoneNumberResponse
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are
calling in the Amazon Web Services Region where the traffic
distribution group was created, you can use either a phone number ARN
or UUID value for the PhoneNumberId
URI request parameter. However,
if the number is claimed to a traffic distribution group and you are
calling this API in the alternate Amazon Web Services Region
associated with the traffic distribution group, you must provide a
full phone number ARN. If a UUID is provided in this scenario, you
receive a ResourceNotFoundException
.
5797 5798 5799 5800 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/client.rb', line 5797 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.