pub struct Client { /* private fields */ }
Expand description

Client for Amazon Connect Service

Client for invoking operations on Amazon Connect Service. Each operation on Amazon Connect Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_connect::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_connect::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_connect::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssociateApprovedOrigin operation.

Constructs a fluent builder for the AssociateBot operation.

Constructs a fluent builder for the AssociateDefaultVocabulary operation.

Constructs a fluent builder for the AssociateInstanceStorageConfig operation.

Constructs a fluent builder for the AssociateLambdaFunction operation.

Constructs a fluent builder for the AssociateLexBot operation.

Constructs a fluent builder for the AssociatePhoneNumberContactFlow operation.

Constructs a fluent builder for the AssociateQueueQuickConnects operation.

Constructs a fluent builder for the AssociateRoutingProfileQueues operation.

Constructs a fluent builder for the AssociateSecurityKey operation.

Constructs a fluent builder for the ClaimPhoneNumber operation.

Constructs a fluent builder for the CreateAgentStatus operation.

Constructs a fluent builder for the CreateContactFlow operation.

Constructs a fluent builder for the CreateContactFlowModule operation.

Constructs a fluent builder for the CreateHoursOfOperation operation.

Constructs a fluent builder for the CreateInstance operation.

Constructs a fluent builder for the CreateIntegrationAssociation operation.

Constructs a fluent builder for the CreateQueue operation.

Constructs a fluent builder for the CreateQuickConnect operation.

Constructs a fluent builder for the CreateRoutingProfile operation.

Constructs a fluent builder for the CreateSecurityProfile operation.

Constructs a fluent builder for the CreateTaskTemplate operation.

Constructs a fluent builder for the CreateUseCase operation.

Constructs a fluent builder for the CreateUser operation.

Constructs a fluent builder for the CreateUserHierarchyGroup operation.

Constructs a fluent builder for the CreateVocabulary operation.

Constructs a fluent builder for the DeleteContactFlow operation.

Constructs a fluent builder for the DeleteContactFlowModule operation.

Constructs a fluent builder for the DeleteHoursOfOperation operation.

Constructs a fluent builder for the DeleteInstance operation.

Constructs a fluent builder for the DeleteIntegrationAssociation operation.

Constructs a fluent builder for the DeleteQuickConnect operation.

Constructs a fluent builder for the DeleteSecurityProfile operation.

Constructs a fluent builder for the DeleteTaskTemplate operation.

Constructs a fluent builder for the DeleteUseCase operation.

Constructs a fluent builder for the DeleteUser operation.

Constructs a fluent builder for the DeleteUserHierarchyGroup operation.

Constructs a fluent builder for the DeleteVocabulary operation.

Constructs a fluent builder for the DescribeAgentStatus operation.

Constructs a fluent builder for the DescribeContact operation.

Constructs a fluent builder for the DescribeContactFlow operation.

Constructs a fluent builder for the DescribeContactFlowModule operation.

Constructs a fluent builder for the DescribeHoursOfOperation operation.

Constructs a fluent builder for the DescribeInstance operation.

Constructs a fluent builder for the DescribeInstanceAttribute operation.

Constructs a fluent builder for the DescribeInstanceStorageConfig operation.

Constructs a fluent builder for the DescribePhoneNumber operation.

Constructs a fluent builder for the DescribeQueue operation.

Constructs a fluent builder for the DescribeQuickConnect operation.

Constructs a fluent builder for the DescribeRoutingProfile operation.

Constructs a fluent builder for the DescribeSecurityProfile operation.

Constructs a fluent builder for the DescribeUser operation.

Constructs a fluent builder for the DescribeUserHierarchyGroup operation.

Constructs a fluent builder for the DescribeUserHierarchyStructure operation.

Constructs a fluent builder for the DescribeVocabulary operation.

Constructs a fluent builder for the DisassociateApprovedOrigin operation.

Constructs a fluent builder for the DisassociateBot operation.

Constructs a fluent builder for the DisassociateInstanceStorageConfig operation.

Constructs a fluent builder for the DisassociateLambdaFunction operation.

Constructs a fluent builder for the DisassociateLexBot operation.

Constructs a fluent builder for the DisassociatePhoneNumberContactFlow operation.

Constructs a fluent builder for the DisassociateQueueQuickConnects operation.

Constructs a fluent builder for the DisassociateRoutingProfileQueues operation.

Constructs a fluent builder for the DisassociateSecurityKey operation.

Constructs a fluent builder for the GetContactAttributes operation.

Constructs a fluent builder for the GetCurrentMetricData operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • instance_id(impl Into<String>) / set_instance_id(Option<String>):

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • filters(Filters) / set_filters(Option<Filters>):

      The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

    • groupings(Vec<Grouping>) / set_groupings(Option<Vec<Grouping>>):

      The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.

      If no Grouping is included in the request, a summary of metrics is returned.

    • current_metrics(Vec<CurrentMetric>) / set_current_metrics(Option<Vec<CurrentMetric>>):

      The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

      AGENTS_AFTER_CONTACT_WORK

      Unit: COUNT

      Name in real-time metrics report: ACW

      AGENTS_AVAILABLE

      Unit: COUNT

      Name in real-time metrics report: Available

      AGENTS_ERROR

      Unit: COUNT

      Name in real-time metrics report: Error

      AGENTS_NON_PRODUCTIVE

      Unit: COUNT

      Name in real-time metrics report: NPT (Non-Productive Time)

      AGENTS_ON_CALL

      Unit: COUNT

      Name in real-time metrics report: On contact

      AGENTS_ON_CONTACT

      Unit: COUNT

      Name in real-time metrics report: On contact

      AGENTS_ONLINE

      Unit: COUNT

      Name in real-time metrics report: Online

      AGENTS_STAFFED

      Unit: COUNT

      Name in real-time metrics report: Staffed

      CONTACTS_IN_QUEUE

      Unit: COUNT

      Name in real-time metrics report: In queue

      CONTACTS_SCHEDULED

      Unit: COUNT

      Name in real-time metrics report: Scheduled

      OLDEST_CONTACT_AGE

      Unit: SECONDS

      When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

      When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

      { “Metric”: { “Name”: “OLDEST_CONTACT_AGE”, “Unit”: “SECONDS” }, “Value”: 24113.0 }

      The actual OLDEST_CONTACT_AGE is 24 seconds.

      Name in real-time metrics report: Oldest

      SLOTS_ACTIVE

      Unit: COUNT

      Name in real-time metrics report: Active

      SLOTS_AVAILABLE

      Unit: COUNT

      Name in real-time metrics report: Availability

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of results to return per page.

  • On success, responds with GetCurrentMetricDataOutput with field(s):
  • On failure, responds with SdkError<GetCurrentMetricDataError>

Constructs a fluent builder for the GetCurrentUserData operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the GetFederationToken operation.

Constructs a fluent builder for the GetMetricData operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • instance_id(impl Into<String>) / set_instance_id(Option<String>):

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • start_time(DateTime) / set_start_time(Option<DateTime>):

      The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

      The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

    • end_time(DateTime) / set_end_time(Option<DateTime>):

      The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

      The time range between the start and end time must be less than 24 hours.

    • filters(Filters) / set_filters(Option<Filters>):

      The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

      To filter by Queues, enter the queue ID/ARN, not the name of the queue.

    • groupings(Vec<Grouping>) / set_groupings(Option<Vec<Grouping>>):

      The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

    • historical_metrics(Vec<HistoricalMetric>) / set_historical_metrics(Option<Vec<HistoricalMetric>>):

      The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      This API does not support a contacts incoming metric (there’s no CONTACTS_INCOMING metric missing from the documented list).

      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for “Less than”).

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of results to return per page.

  • On success, responds with GetMetricDataOutput with field(s):
    • next_token(Option<String>):

      If there are additional results, this is the token for the next set of results.

      The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

    • metric_results(Option<Vec<HistoricalMetricResult>>):

      Information about the historical metrics.

      If no grouping is specified, a summary of metric data is returned.

  • On failure, responds with SdkError<GetMetricDataError>

Constructs a fluent builder for the GetTaskTemplate operation.

Constructs a fluent builder for the ListAgentStatuses operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListApprovedOrigins operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBots operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListContactFlowModules operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListContactFlows operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListContactReferences operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListDefaultVocabularies operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListHoursOfOperations operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListInstanceAttributes operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListInstances operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListInstanceStorageConfigs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListIntegrationAssociations operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListLambdaFunctions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListLexBots operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListPhoneNumbers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListPhoneNumbersV2 operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListPrompts operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListQueueQuickConnects operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListQueues operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListQuickConnects operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListRoutingProfileQueues operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListRoutingProfiles operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSecurityKeys operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSecurityProfilePermissions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSecurityProfiles operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ListTaskTemplates operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListUseCases operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListUserHierarchyGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListUsers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the PutUserStatus operation.

Constructs a fluent builder for the ReleasePhoneNumber operation.

Constructs a fluent builder for the ResumeContactRecording operation.

Constructs a fluent builder for the SearchAvailablePhoneNumbers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the SearchUsers operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the SearchVocabularies operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the StartChatContact operation.

Constructs a fluent builder for the StartContactRecording operation.

Constructs a fluent builder for the StartContactStreaming operation.

Constructs a fluent builder for the StartOutboundVoiceContact operation.

Constructs a fluent builder for the StartTaskContact operation.

Constructs a fluent builder for the StopContact operation.

Constructs a fluent builder for the StopContactRecording operation.

Constructs a fluent builder for the StopContactStreaming operation.

Constructs a fluent builder for the SuspendContactRecording operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the TransferContact operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateAgentStatus operation.

Constructs a fluent builder for the UpdateContact operation.

Constructs a fluent builder for the UpdateContactAttributes operation.

Constructs a fluent builder for the UpdateContactFlowContent operation.

Constructs a fluent builder for the UpdateContactFlowMetadata operation.

Constructs a fluent builder for the UpdateContactFlowModuleContent operation.

Constructs a fluent builder for the UpdateContactFlowModuleMetadata operation.

Constructs a fluent builder for the UpdateContactFlowName operation.

Constructs a fluent builder for the UpdateContactSchedule operation.

Constructs a fluent builder for the UpdateHoursOfOperation operation.

Constructs a fluent builder for the UpdateInstanceAttribute operation.

Constructs a fluent builder for the UpdateInstanceStorageConfig operation.

Constructs a fluent builder for the UpdatePhoneNumber operation.

Constructs a fluent builder for the UpdateQueueHoursOfOperation operation.

Constructs a fluent builder for the UpdateQueueMaxContacts operation.

Constructs a fluent builder for the UpdateQueueName operation.

Constructs a fluent builder for the UpdateQueueOutboundCallerConfig operation.

Constructs a fluent builder for the UpdateQueueStatus operation.

Constructs a fluent builder for the UpdateQuickConnectConfig operation.

Constructs a fluent builder for the UpdateQuickConnectName operation.

Constructs a fluent builder for the UpdateRoutingProfileConcurrency operation.

Constructs a fluent builder for the UpdateRoutingProfileDefaultOutboundQueue operation.

Constructs a fluent builder for the UpdateRoutingProfileName operation.

Constructs a fluent builder for the UpdateRoutingProfileQueues operation.

Constructs a fluent builder for the UpdateSecurityProfile operation.

Constructs a fluent builder for the UpdateTaskTemplate operation.

Constructs a fluent builder for the UpdateUserHierarchy operation.

Constructs a fluent builder for the UpdateUserHierarchyGroupName operation.

Constructs a fluent builder for the UpdateUserHierarchyStructure operation.

Constructs a fluent builder for the UpdateUserIdentityInfo operation.

Constructs a fluent builder for the UpdateUserPhoneConfig operation.

Constructs a fluent builder for the UpdateUserRoutingProfile operation.

Constructs a fluent builder for the UpdateUserSecurityProfiles operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more