Struct rusoto_connect::ConnectClient

pub struct ConnectClient { /* fields omitted */ }

A client for the Amazon Connect API.

Implementations

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,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> ConnectClient

Trait Implementations

impl Clone for ConnectClient

pub fn clone(&self) -> ConnectClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connect for ConnectClient

pub fn create_user<'life0, 'async_trait>(
    &'life0 self,
    input: CreateUserRequest
) -> Pin<Box<dyn Future<Output = Result<CreateUserResponse, RusotoError<CreateUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

pub fn delete_user<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteUserRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn describe_user<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeUserRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserResponse, RusotoError<DescribeUserError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the specified user account. You can find the instance ID in the 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.

pub fn describe_user_hierarchy_group<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeUserHierarchyGroupRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserHierarchyGroupResponse, RusotoError<DescribeUserHierarchyGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the specified hierarchy group.

pub fn describe_user_hierarchy_structure<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeUserHierarchyStructureRequest
) -> Pin<Box<dyn Future<Output = Result<DescribeUserHierarchyStructureResponse, RusotoError<DescribeUserHierarchyStructureError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Describes the hierarchy structure of the specified Amazon Connect instance.

pub fn get_contact_attributes<'life0, 'async_trait>(
    &'life0 self,
    input: GetContactAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<GetContactAttributesResponse, RusotoError<GetContactAttributesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the contact attributes for the specified contact.

pub fn get_current_metric_data<'life0, 'async_trait>(
    &'life0 self,
    input: GetCurrentMetricDataRequest
) -> Pin<Box<dyn Future<Output = Result<GetCurrentMetricDataResponse, RusotoError<GetCurrentMetricDataError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn get_federation_token<'life0, 'async_trait>(
    &'life0 self,
    input: GetFederationTokenRequest
) -> Pin<Box<dyn Future<Output = Result<GetFederationTokenResponse, RusotoError<GetFederationTokenError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves a token for federation.

pub fn get_metric_data<'life0, 'async_trait>(
    &'life0 self,
    input: GetMetricDataRequest
) -> Pin<Box<dyn Future<Output = Result<GetMetricDataResponse, RusotoError<GetMetricDataError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_contact_flows<'life0, 'async_trait>(
    &'life0 self,
    input: ListContactFlowsRequest
) -> Pin<Box<dyn Future<Output = Result<ListContactFlowsResponse, RusotoError<ListContactFlowsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides information about the contact flows for the specified Amazon Connect instance.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

pub fn list_hours_of_operations<'life0, 'async_trait>(
    &'life0 self,
    input: ListHoursOfOperationsRequest
) -> Pin<Box<dyn Future<Output = Result<ListHoursOfOperationsResponse, RusotoError<ListHoursOfOperationsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_phone_numbers<'life0, 'async_trait>(
    &'life0 self,
    input: ListPhoneNumbersRequest
) -> Pin<Box<dyn Future<Output = Result<ListPhoneNumbersResponse, RusotoError<ListPhoneNumbersError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_queues<'life0, 'async_trait>(
    &'life0 self,
    input: ListQueuesRequest
) -> Pin<Box<dyn Future<Output = Result<ListQueuesResponse, RusotoError<ListQueuesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides information about the queues for the specified Amazon Connect instance.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

pub fn list_routing_profiles<'life0, 'async_trait>(
    &'life0 self,
    input: ListRoutingProfilesRequest
) -> Pin<Box<dyn Future<Output = Result<ListRoutingProfilesResponse, RusotoError<ListRoutingProfilesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_security_profiles<'life0, 'async_trait>(
    &'life0 self,
    input: ListSecurityProfilesRequest
) -> Pin<Box<dyn Future<Output = Result<ListSecurityProfilesResponse, RusotoError<ListSecurityProfilesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_tags_for_resource<'life0, 'async_trait>(
    &'life0 self,
    input: ListTagsForResourceRequest
) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_user_hierarchy_groups<'life0, 'async_trait>(
    &'life0 self,
    input: ListUserHierarchyGroupsRequest
) -> Pin<Box<dyn Future<Output = Result<ListUserHierarchyGroupsResponse, RusotoError<ListUserHierarchyGroupsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn list_users<'life0, 'async_trait>(
    &'life0 self,
    input: ListUsersRequest
) -> Pin<Box<dyn Future<Output = Result<ListUsersResponse, RusotoError<ListUsersError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides summary information about the users for the specified Amazon Connect instance.

pub fn start_chat_contact<'life0, 'async_trait>(
    &'life0 self,
    input: StartChatContactRequest
) -> Pin<Box<dyn Future<Output = Result<StartChatContactResponse, RusotoError<StartChatContactError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Initiates a contact 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 need to 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 two situations:

• API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

• The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

pub fn start_outbound_voice_contact<'life0, 'async_trait>(
    &'life0 self,
    input: StartOutboundVoiceContactRequest
) -> Pin<Box<dyn Future<Output = Result<StartOutboundVoiceContactResponse, RusotoError<StartOutboundVoiceContactError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is 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.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

pub fn stop_contact<'life0, 'async_trait>(
    &'life0 self,
    input: StopContactRequest
) -> Pin<Box<dyn Future<Output = Result<StopContactResponse, RusotoError<StopContactError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Ends the specified contact.

pub fn tag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: TagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<TagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Adds the specified tags to the specified resource.

The supported resource type is users.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

pub fn untag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: UntagResourceRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Removes the specified tags from the specified resource.

pub fn update_contact_attributes<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateContactAttributesRequest
) -> Pin<Box<dyn Future<Output = Result<UpdateContactAttributesResponse, RusotoError<UpdateContactAttributesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates or updates the contact attributes associated with the specified contact.

You can 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 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.

pub fn update_user_hierarchy<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateUserHierarchyRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateUserHierarchyError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Assigns the specified hierarchy group to the specified user.

pub fn update_user_identity_info<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateUserIdentityInfoRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateUserIdentityInfoError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the identity information for the specified user.

Someone with the ability to invoke UpdateUserIndentityInfo 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. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

pub fn update_user_phone_config<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateUserPhoneConfigRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateUserPhoneConfigError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the phone configuration settings for the specified user.

pub fn update_user_routing_profile<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateUserRoutingProfileRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateUserRoutingProfileError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Assigns the specified routing profile to the specified user.

pub fn update_user_security_profiles<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateUserSecurityProfilesRequest
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateUserSecurityProfilesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Assigns the specified security profiles to the specified user.