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

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

Trait Implementations

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.

impl Connect for ConnectClient

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.

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.

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.

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.

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.

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.

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 more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.

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.

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 more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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, 

Initiates a contact flow to place an outbound call to a customer.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.