Struct rusoto_connect::ConnectClient

pub struct ConnectClient { /* fields omitted */ }

A client for the Amazon Connect API.

Methods

impl ConnectClient

pub fn new(region: Region) -> ConnectClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> ConnectClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    P::Future: Send,
    D: DispatchSignedRequest + Send + Sync + 'static,
    D::Future: Send, 

Trait Implementations

impl Connect for ConnectClient

fn create_user(
    &self,
    input: CreateUserRequest
) -> RusotoFuture<CreateUserResponse, CreateUserError>

Creates a new user account in your Amazon Connect instance.

fn delete_user(
    &self,
    input: DeleteUserRequest
) -> RusotoFuture<(), DeleteUserError>

Deletes a user account from Amazon Connect.

fn describe_user(
    &self,
    input: DescribeUserRequest
) -> RusotoFuture<DescribeUserResponse, DescribeUserError>

Returns a User object that contains information about the user account specified by the UserId.

fn describe_user_hierarchy_group(
    &self,
    input: DescribeUserHierarchyGroupRequest
) -> RusotoFuture<DescribeUserHierarchyGroupResponse, DescribeUserHierarchyGroupError>

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

fn describe_user_hierarchy_structure(
    &self,
    input: DescribeUserHierarchyStructureRequest
) -> RusotoFuture<DescribeUserHierarchyStructureResponse, DescribeUserHierarchyStructureError>

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

fn get_contact_attributes(
    &self,
    input: GetContactAttributesRequest
) -> RusotoFuture<GetContactAttributesResponse, GetContactAttributesError>

Retrieves the contact attributes associated with a contact.

fn get_current_metric_data(
    &self,
    input: GetCurrentMetricDataRequest
) -> RusotoFuture<GetCurrentMetricDataResponse, GetCurrentMetricDataError>

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

fn get_federation_token(
    &self,
    input: GetFederationTokenRequest
) -> RusotoFuture<GetFederationTokenResponse, GetFederationTokenError>

Retrieves a token for federation.

fn get_metric_data(
    &self,
    input: GetMetricDataRequest
) -> RusotoFuture<GetMetricDataResponse, GetMetricDataError>

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

fn list_routing_profiles(
    &self,
    input: ListRoutingProfilesRequest
) -> RusotoFuture<ListRoutingProfilesResponse, ListRoutingProfilesError>

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

fn list_security_profiles(
    &self,
    input: ListSecurityProfilesRequest
) -> RusotoFuture<ListSecurityProfilesResponse, ListSecurityProfilesError>

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

fn list_user_hierarchy_groups(
    &self,
    input: ListUserHierarchyGroupsRequest
) -> RusotoFuture<ListUserHierarchyGroupsResponse, ListUserHierarchyGroupsError>

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

fn list_users(
    &self,
    input: ListUsersRequest
) -> RusotoFuture<ListUsersResponse, ListUsersError>

Returns a UserSummaryList, which is an array of UserSummary objects.

fn start_outbound_voice_contact(
    &self,
    input: StartOutboundVoiceContactRequest
) -> RusotoFuture<StartOutboundVoiceContactResponse, StartOutboundVoiceContactError>

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails.

fn stop_contact(
    &self,
    input: StopContactRequest
) -> RusotoFuture<StopContactResponse, StopContactError>

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

fn update_contact_attributes(
    &self,
    input: UpdateContactAttributesRequest
) -> RusotoFuture<UpdateContactAttributesResponse, UpdateContactAttributesError>

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to 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 identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important:

You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

fn update_user_hierarchy(
    &self,
    input: UpdateUserHierarchyRequest
) -> RusotoFuture<(), UpdateUserHierarchyError>

Assigns the specified hierarchy group to the user.

fn update_user_identity_info(
    &self,
    input: UpdateUserIdentityInfoRequest
) -> RusotoFuture<(), UpdateUserIdentityInfoError>

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

fn update_user_phone_config(
    &self,
    input: UpdateUserPhoneConfigRequest
) -> RusotoFuture<(), UpdateUserPhoneConfigError>

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

fn update_user_routing_profile(
    &self,
    input: UpdateUserRoutingProfileRequest
) -> RusotoFuture<(), UpdateUserRoutingProfileError>

Assigns the specified routing profile to a user.

fn update_user_security_profiles(
    &self,
    input: UpdateUserSecurityProfilesRequest
) -> RusotoFuture<(), UpdateUserSecurityProfilesError>

Updates the security profiles assigned to the user.

impl Clone for ConnectClient

fn clone(&self) -> ConnectClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.