Struct aws_sdk_connect::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_connect::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_connect::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ActivateEvaluationForm operation has a Client::activate_evaluation_form, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.activate_evaluation_form()
    .instance_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn activate_evaluation_form(&self) -> ActivateEvaluationFormFluentBuilder

Constructs a fluent builder for the ActivateEvaluationForm operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    The unique identifier for the evaluation form.

    
    
  • evaluation_form_version(i32) / set_evaluation_form_version(Option<i32>):
    required: true
    

    The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.

    
    
• On success, responds with ActivateEvaluationFormOutput with field(s):
  • evaluation_form_id(String):

    The unique identifier for the evaluation form.

  • evaluation_form_arn(String):

    The Amazon Resource Name (ARN) for the evaluation form resource.

  • evaluation_form_version(i32):

    A version of the evaluation form.

• On failure, responds with SdkError<ActivateEvaluationFormError>

impl Client

pub fn associate_approved_origin(&self) -> AssociateApprovedOriginFluentBuilder

Constructs a fluent builder for the AssociateApprovedOrigin operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • origin(impl Into<String>) / set_origin(Option<String>):
    required: true
    

    The domain to add to your allow list.

    
    
• On success, responds with AssociateApprovedOriginOutput
• On failure, responds with SdkError<AssociateApprovedOriginError>

impl Client

pub fn associate_bot(&self) -> AssociateBotFluentBuilder

Constructs a fluent builder for the AssociateBot operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • lex_bot(LexBot) / set_lex_bot(Option<LexBot>):
    required: false
    

    Configuration information of an Amazon Lex bot.

    
    
  • lex_v2_bot(LexV2Bot) / set_lex_v2_bot(Option<LexV2Bot>):
    required: false
    

    The Amazon Lex V2 bot to associate with the instance.

    
    
• On success, responds with AssociateBotOutput
• On failure, responds with SdkError<AssociateBotError>

impl Client

pub fn associate_default_vocabulary( &self ) -> AssociateDefaultVocabularyFluentBuilder

Constructs a fluent builder for the AssociateDefaultVocabulary operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • language_code(VocabularyLanguageCode) / set_language_code(Option<VocabularyLanguageCode>):
    required: true
    

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

    
    
  • vocabulary_id(impl Into<String>) / set_vocabulary_id(Option<String>):
    required: false
    

    The identifier of the custom vocabulary. If this is empty, the default is set to none.

    
    
• On success, responds with AssociateDefaultVocabularyOutput
• On failure, responds with SdkError<AssociateDefaultVocabularyError>

impl Client

pub fn associate_instance_storage_config( &self ) -> AssociateInstanceStorageConfigFluentBuilder

Constructs a fluent builder for the AssociateInstanceStorageConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • resource_type(InstanceStorageResourceType) / set_resource_type(Option<InstanceStorageResourceType>):
    required: true
    

    A valid resource type.

    
    
  • storage_config(InstanceStorageConfig) / set_storage_config(Option<InstanceStorageConfig>):
    required: true
    

    A valid storage type.

    
    
• On success, responds with AssociateInstanceStorageConfigOutput with field(s):
  • association_id(Option<String>):

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

• On failure, responds with SdkError<AssociateInstanceStorageConfigError>

impl Client

pub fn associate_lambda_function(&self) -> AssociateLambdaFunctionFluentBuilder

Constructs a fluent builder for the AssociateLambdaFunction operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • function_arn(impl Into<String>) / set_function_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

    
    
• On success, responds with AssociateLambdaFunctionOutput
• On failure, responds with SdkError<AssociateLambdaFunctionError>

impl Client

pub fn associate_lex_bot(&self) -> AssociateLexBotFluentBuilder

Constructs a fluent builder for the AssociateLexBot operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • lex_bot(LexBot) / set_lex_bot(Option<LexBot>):
    required: true
    

    The Amazon Lex bot to associate with the instance.

    
    
• On success, responds with AssociateLexBotOutput
• On failure, responds with SdkError<AssociateLexBotError>

impl Client

pub fn associate_phone_number_contact_flow( &self ) -> AssociatePhoneNumberContactFlowFluentBuilder

Constructs a fluent builder for the AssociatePhoneNumberContactFlow operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    A unique identifier for the phone number.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
• On success, responds with AssociatePhoneNumberContactFlowOutput
• On failure, responds with SdkError<AssociatePhoneNumberContactFlowError>

impl Client

pub fn associate_queue_quick_connects( &self ) -> AssociateQueueQuickConnectsFluentBuilder

Constructs a fluent builder for the AssociateQueueQuickConnects operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • quick_connect_ids(impl Into<String>) / set_quick_connect_ids(Option<Vec::<String>>):
    required: true
    

    The quick connects to associate with this queue.

    
    
• On success, responds with AssociateQueueQuickConnectsOutput
• On failure, responds with SdkError<AssociateQueueQuickConnectsError>

impl Client

pub fn associate_routing_profile_queues( &self ) -> AssociateRoutingProfileQueuesFluentBuilder

Constructs a fluent builder for the AssociateRoutingProfileQueues operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • queue_configs(RoutingProfileQueueConfig) / set_queue_configs(Option<Vec::<RoutingProfileQueueConfig>>):
    required: true
    

    The queues to associate with this routing profile.

    
    
• On success, responds with AssociateRoutingProfileQueuesOutput
• On failure, responds with SdkError<AssociateRoutingProfileQueuesError>

impl Client

pub fn associate_security_key(&self) -> AssociateSecurityKeyFluentBuilder

Constructs a fluent builder for the AssociateSecurityKey operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: true
    

    A valid security key in PEM format.

    
    
• On success, responds with AssociateSecurityKeyOutput with field(s):
  • association_id(Option<String>):

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

• On failure, responds with SdkError<AssociateSecurityKeyError>

impl Client

pub fn associate_traffic_distribution_group_user( &self ) -> AssociateTrafficDistributionGroupUserFluentBuilder

Constructs a fluent builder for the AssociateTrafficDistributionGroupUser operation.

• The fluent builder is configurable:
  • traffic_distribution_group_id(impl Into<String>) / set_traffic_distribution_group_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account. This can be the ID or the ARN of the user.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with AssociateTrafficDistributionGroupUserOutput
• On failure, responds with SdkError<AssociateTrafficDistributionGroupUserError>

impl Client

pub fn batch_get_flow_association(&self) -> BatchGetFlowAssociationFluentBuilder

Constructs a fluent builder for the BatchGetFlowAssociation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • resource_ids(impl Into<String>) / set_resource_ids(Option<Vec::<String>>):
    required: true
    

    A list of resource identifiers to retrieve flow associations.

    
    
  • resource_type(ListFlowAssociationResourceType) / set_resource_type(Option<ListFlowAssociationResourceType>):
    required: false
    

    The type of resource association.

    
    
• On success, responds with BatchGetFlowAssociationOutput with field(s):
  • flow_association_summary_list(Option<Vec::<FlowAssociationSummary>>):

    Information about flow associations.

• On failure, responds with SdkError<BatchGetFlowAssociationError>

impl Client

pub fn batch_put_contact(&self) -> BatchPutContactFluentBuilder

Constructs a fluent builder for the BatchPutContact operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_data_request_list(ContactDataRequest) / set_contact_data_request_list(Option<Vec::<ContactDataRequest>>):
    required: true
    

    List of individual contact requests.

    
    
• On success, responds with BatchPutContactOutput with field(s):
  • successful_request_list(Option<Vec::<SuccessfulRequest>>):

    List of requests for which contact was successfully created.

  • failed_request_list(Option<Vec::<FailedRequest>>):

    List of requests for which contact creation failed.

• On failure, responds with SdkError<BatchPutContactError>

impl Client

pub fn claim_phone_number(&self) -> ClaimPhoneNumberFluentBuilder

Constructs a fluent builder for the ClaimPhoneNumber operation.

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

    
    
  • phone_number(impl Into<String>) / set_phone_number(Option<String>):
    required: true
    

    The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

    
    
  • phone_number_description(impl Into<String>) / set_phone_number_description(Option<String>):
    required: false
    

    The description of the phone number.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

    
    
• On success, responds with ClaimPhoneNumberOutput with field(s):
  • phone_number_id(Option<String>):

    A unique identifier for the phone number.

  • phone_number_arn(Option<String>):

    The Amazon Resource Name (ARN) of the phone number.

• On failure, responds with SdkError<ClaimPhoneNumberError>

impl Client

pub fn create_agent_status(&self) -> CreateAgentStatusFluentBuilder

Constructs a fluent builder for the CreateAgentStatus operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the status.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the status.

    
    
  • state(AgentStatusState) / set_state(Option<AgentStatusState>):
    required: true
    

    The state of the status.

    
    
  • display_order(i32) / set_display_order(Option<i32>):
    required: false
    

    The display order of the status.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateAgentStatusOutput with field(s):
  • agent_status_arn(Option<String>):

    The Amazon Resource Name (ARN) of the agent status.

  • agent_status_id(Option<String>):

    The identifier of the agent status.

• On failure, responds with SdkError<CreateAgentStatusError>

impl Client

pub fn create_contact_flow(&self) -> CreateContactFlowFluentBuilder

Constructs a fluent builder for the CreateContactFlow operation.

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

    The identifier of the Amazon Connect instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the flow.

    
    
  • r#type(ContactFlowType) / set_type(Option<ContactFlowType>):
    required: true
    

    The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the flow.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

    Length Constraints: Minimum length of 1. Maximum length of 256000.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateContactFlowOutput with field(s):
  • contact_flow_id(Option<String>):

    The identifier of the flow.

  • contact_flow_arn(Option<String>):

    The Amazon Resource Name (ARN) of the flow.

• On failure, responds with SdkError<CreateContactFlowError>

impl Client

pub fn create_contact_flow_module(&self) -> CreateContactFlowModuleFluentBuilder

Constructs a fluent builder for the CreateContactFlowModule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the flow module.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the flow module.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with CreateContactFlowModuleOutput with field(s):
  • id(Option<String>):

    The identifier of the flow module.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the flow module.

• On failure, responds with SdkError<CreateContactFlowModuleError>

impl Client

pub fn create_evaluation_form(&self) -> CreateEvaluationFormFluentBuilder

Constructs a fluent builder for the CreateEvaluationForm operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    A title of the evaluation form.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the evaluation form.

    
    
  • items(EvaluationFormItem) / set_items(Option<Vec::<EvaluationFormItem>>):
    required: true
    

    Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

    
    
  • scoring_strategy(EvaluationFormScoringStrategy) / set_scoring_strategy(Option<EvaluationFormScoringStrategy>):
    required: false
    

    A scoring strategy of the evaluation form.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with CreateEvaluationFormOutput with field(s):
  • evaluation_form_id(String):

    The unique identifier for the evaluation form.

  • evaluation_form_arn(String):

    The Amazon Resource Name (ARN) for the evaluation form resource.

• On failure, responds with SdkError<CreateEvaluationFormError>

impl Client

pub fn create_hours_of_operation(&self) -> CreateHoursOfOperationFluentBuilder

Constructs a fluent builder for the CreateHoursOfOperation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the hours of operation.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the hours of operation.

    
    
  • time_zone(impl Into<String>) / set_time_zone(Option<String>):
    required: true
    

    The time zone of the hours of operation.

    
    
  • config(HoursOfOperationConfig) / set_config(Option<Vec::<HoursOfOperationConfig>>):
    required: true
    

    Configuration information for the hours of operation: day, start time, and end time.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateHoursOfOperationOutput with field(s):
  • hours_of_operation_id(Option<String>):

    The identifier for the hours of operation.

  • hours_of_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) for the hours of operation.

• On failure, responds with SdkError<CreateHoursOfOperationError>

impl Client

pub fn create_instance(&self) -> CreateInstanceFluentBuilder

Constructs a fluent builder for the CreateInstance operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token.

    
    
  • identity_management_type(DirectoryType) / set_identity_management_type(Option<DirectoryType>):
    required: true
    

    The type of identity management for your Amazon Connect users.

    
    
  • instance_alias(impl Into<String>) / set_instance_alias(Option<String>):
    required: false
    

    The name for your instance.

    
    
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

    The identifier for the directory.

    
    
  • inbound_calls_enabled(bool) / set_inbound_calls_enabled(Option<bool>):
    required: true
    

    Your contact center handles incoming contacts.

    
    
  • outbound_calls_enabled(bool) / set_outbound_calls_enabled(Option<bool>):
    required: true
    

    Your contact center allows outbound calls.

    
    
• On success, responds with CreateInstanceOutput with field(s):
  • id(Option<String>):

    The identifier for the instance.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the instance.

• On failure, responds with SdkError<CreateInstanceError>

impl Client

pub fn create_integration_association( &self ) -> CreateIntegrationAssociationFluentBuilder

Constructs a fluent builder for the CreateIntegrationAssociation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • integration_type(IntegrationType) / set_integration_type(Option<IntegrationType>):
    required: true
    

    The type of information to be ingested.

    
    
  • integration_arn(impl Into<String>) / set_integration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the integration.

    When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.

    
    
  • source_application_url(impl Into<String>) / set_source_application_url(Option<String>):
    required: false
    

    The URL for the external application. This field is only required for the EVENT integration type.

    
    
  • source_application_name(impl Into<String>) / set_source_application_name(Option<String>):
    required: false
    

    The name of the external application. This field is only required for the EVENT integration type.

    
    
  • source_type(SourceType) / set_source_type(Option<SourceType>):
    required: false
    

    The type of the data source. This field is only required for the EVENT integration type.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateIntegrationAssociationOutput with field(s):
  • integration_association_id(Option<String>):

    The identifier for the integration association.

  • integration_association_arn(Option<String>):

    The Amazon Resource Name (ARN) for the association.

• On failure, responds with SdkError<CreateIntegrationAssociationError>

impl Client

pub fn create_participant(&self) -> CreateParticipantFluentBuilder

Constructs a fluent builder for the CreateParticipant operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • participant_details(ParticipantDetailsToAdd) / set_participant_details(Option<ParticipantDetailsToAdd>):
    required: true
    

    Information identifying the participant.

    The only Valid value for ParticipantRole is CUSTOM_BOT.

    DisplayName is Required.

    
    
• On success, responds with CreateParticipantOutput with field(s):
  • participant_credentials(Option<ParticipantTokenCredentials>):

    The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

  • participant_id(Option<String>):

    The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

• On failure, responds with SdkError<CreateParticipantError>

impl Client

pub fn create_persistent_contact_association( &self ) -> CreatePersistentContactAssociationFluentBuilder

Constructs a fluent builder for the CreatePersistentContactAssociation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

    
    
  • rehydration_type(RehydrationType) / set_rehydration_type(Option<RehydrationType>):
    required: true
    

    The contactId chosen for rehydration depends on the type chosen.

    • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

    • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

    The actual contactId used for rehydration is provided in the response of this API.

    To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

    • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

      • Configuration

        • SourceContactId = “C2”

        • RehydrationType = “FROM_SEGMENT”

      • Expected behavior

        • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

    • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

      • Configuration

        • SourceContactId = “C1”

        • RehydrationType = “ENTIRE_PAST_SESSION”

      • Expected behavior

        • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

    
    
  • source_contact_id(impl Into<String>) / set_source_contact_id(Option<String>):
    required: true
    

    The contactId from which a persistent chat session must be started.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with CreatePersistentContactAssociationOutput with field(s):
  • continued_from_contact_id(Option<String>):

    The contactId from which a persistent chat session is started. This field is populated only for persistent chat.

• On failure, responds with SdkError<CreatePersistentContactAssociationError>

impl Client

pub fn create_prompt(&self) -> CreatePromptFluentBuilder

Constructs a fluent builder for the CreatePrompt operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the prompt.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the prompt.

    
    
  • s3_uri(impl Into<String>) / set_s3_uri(Option<String>):
    required: true
    

    The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreatePromptOutput with field(s):
  • prompt_arn(Option<String>):

    The Amazon Resource Name (ARN) of the prompt.

  • prompt_id(Option<String>):

    A unique identifier for the prompt.

• On failure, responds with SdkError<CreatePromptError>

impl Client

pub fn create_queue(&self) -> CreateQueueFluentBuilder

Constructs a fluent builder for the CreateQueue operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the queue.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the queue.

    
    
  • outbound_caller_config(OutboundCallerConfig) / set_outbound_caller_config(Option<OutboundCallerConfig>):
    required: false
    

    The outbound caller ID name, number, and outbound whisper flow.

    
    
  • hours_of_operation_id(impl Into<String>) / set_hours_of_operation_id(Option<String>):
    required: true
    

    The identifier for the hours of operation.

    
    
  • max_contacts(i32) / set_max_contacts(Option<i32>):
    required: false
    

    The maximum number of contacts that can be in the queue before it is considered full.

    
    
  • quick_connect_ids(impl Into<String>) / set_quick_connect_ids(Option<Vec::<String>>):
    required: false
    

    The quick connects available to agents who are working the queue.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateQueueOutput with field(s):
  • queue_arn(Option<String>):

    The Amazon Resource Name (ARN) of the queue.

  • queue_id(Option<String>):

    The identifier for the queue.

• On failure, responds with SdkError<CreateQueueError>

impl Client

pub fn create_quick_connect(&self) -> CreateQuickConnectFluentBuilder

Constructs a fluent builder for the CreateQuickConnect operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A unique name of the quick connect.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the quick connect.

    
    
  • quick_connect_config(QuickConnectConfig) / set_quick_connect_config(Option<QuickConnectConfig>):
    required: true
    

    Configuration settings for the quick connect.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateQuickConnectOutput with field(s):
  • quick_connect_arn(Option<String>):

    The Amazon Resource Name (ARN) for the quick connect.

  • quick_connect_id(Option<String>):

    The identifier for the quick connect.

• On failure, responds with SdkError<CreateQuickConnectError>

impl Client

pub fn create_routing_profile(&self) -> CreateRoutingProfileFluentBuilder

Constructs a fluent builder for the CreateRoutingProfile operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the routing profile. Must not be more than 127 characters.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    Description of the routing profile. Must not be more than 250 characters.

    
    
  • default_outbound_queue_id(impl Into<String>) / set_default_outbound_queue_id(Option<String>):
    required: true
    

    The default outbound queue for the routing profile.

    
    
  • queue_configs(RoutingProfileQueueConfig) / set_queue_configs(Option<Vec::<RoutingProfileQueueConfig>>):
    required: false
    

    The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

    The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.

    
    
  • media_concurrencies(MediaConcurrency) / set_media_concurrencies(Option<Vec::<MediaConcurrency>>):
    required: true
    

    The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
  • agent_availability_timer(AgentAvailabilityTimer) / set_agent_availability_timer(Option<AgentAvailabilityTimer>):
    required: false
    

    Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.

    
    
• On success, responds with CreateRoutingProfileOutput with field(s):
  • routing_profile_arn(Option<String>):

    The Amazon Resource Name (ARN) of the routing profile.

  • routing_profile_id(Option<String>):

    The identifier of the routing profile.

• On failure, responds with SdkError<CreateRoutingProfileError>

impl Client

pub fn create_rule(&self) -> CreateRuleFluentBuilder

Constructs a fluent builder for the CreateRule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A unique name for the rule.

    
    
  • trigger_event_source(RuleTriggerEventSource) / set_trigger_event_source(Option<RuleTriggerEventSource>):
    required: true
    

    The event source to trigger the rule.

    
    
  • function(impl Into<String>) / set_function(Option<String>):
    required: true
    

    The conditions of the rule.

    
    
  • actions(RuleAction) / set_actions(Option<Vec::<RuleAction>>):
    required: true
    

    A list of actions to be run when the rule is triggered.

    
    
  • publish_status(RulePublishStatus) / set_publish_status(Option<RulePublishStatus>):
    required: true
    

    The publish status of the rule.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with CreateRuleOutput with field(s):
  • rule_arn(String):

    The Amazon Resource Name (ARN) of the rule.

  • rule_id(String):

    A unique identifier for the rule.

• On failure, responds with SdkError<CreateRuleError>

impl Client

pub fn create_security_profile(&self) -> CreateSecurityProfileFluentBuilder

Constructs a fluent builder for the CreateSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The name of the security profile.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the security profile.

    
    
  • permissions(impl Into<String>) / set_permissions(Option<Vec::<String>>):
    required: false
    

    Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
  • allowed_access_control_tags(impl Into<String>, impl Into<String>) / set_allowed_access_control_tags(Option<HashMap::<String, String>>):
    required: false
    

    The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

    
    
  • tag_restricted_resources(impl Into<String>) / set_tag_restricted_resources(Option<Vec::<String>>):
    required: false
    

    The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

    
    
  • applications(Application) / set_applications(Option<Vec::<Application>>):
    required: false
    

    This API is in preview release for Amazon Connect and is subject to change.

    A list of third-party applications that the security profile will give access to.

    
    
• On success, responds with CreateSecurityProfileOutput with field(s):
  • security_profile_id(Option<String>):

    The identifier for the security profle.

  • security_profile_arn(Option<String>):

    The Amazon Resource Name (ARN) for the security profile.

• On failure, responds with SdkError<CreateSecurityProfileError>

impl Client

pub fn create_task_template(&self) -> CreateTaskTemplateFluentBuilder

Constructs a fluent builder for the CreateTaskTemplate operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the task template.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the task template.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: false
    

    The identifier of the flow that runs by default when a task is created by referencing this template.

    
    
  • constraints(TaskTemplateConstraints) / set_constraints(Option<TaskTemplateConstraints>):
    required: false
    

    Constraints that are applicable to the fields listed.

    
    
  • defaults(TaskTemplateDefaults) / set_defaults(Option<TaskTemplateDefaults>):
    required: false
    

    The default values for fields when a task is created by referencing this template.

    
    
  • status(TaskTemplateStatus) / set_status(Option<TaskTemplateStatus>):
    required: false
    

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

    
    
  • fields(TaskTemplateField) / set_fields(Option<Vec::<TaskTemplateField>>):
    required: true
    

    Fields that are part of the template.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with CreateTaskTemplateOutput with field(s):
  • id(String):

    The identifier of the task template resource.

  • arn(String):

    The Amazon Resource Name (ARN) for the task template resource.

• On failure, responds with SdkError<CreateTaskTemplateError>

impl Client

pub fn create_traffic_distribution_group( &self ) -> CreateTrafficDistributionGroupFluentBuilder

Constructs a fluent builder for the CreateTrafficDistributionGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the traffic distribution group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the traffic distribution group.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateTrafficDistributionGroupOutput with field(s):
  • id(Option<String>):

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the traffic distribution group.

• On failure, responds with SdkError<CreateTrafficDistributionGroupError>

impl Client

pub fn create_use_case(&self) -> CreateUseCaseFluentBuilder

Constructs a fluent builder for the CreateUseCase operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • integration_association_id(impl Into<String>) / set_integration_association_id(Option<String>):
    required: true
    

    The identifier for the integration association.

    
    
  • use_case_type(UseCaseType) / set_use_case_type(Option<UseCaseType>):
    required: true
    

    The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateUseCaseOutput with field(s):
  • use_case_id(Option<String>):

    The identifier of the use case.

  • use_case_arn(Option<String>):

    The Amazon Resource Name (ARN) for the use case.

• On failure, responds with SdkError<CreateUseCaseError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

• The fluent builder is configurable:
  • username(impl Into<String>) / set_username(Option<String>):
    required: true
    

    The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: false
    

    The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

    
    
  • identity_info(UserIdentityInfo) / set_identity_info(Option<UserIdentityInfo>):
    required: false
    

    The information about the identity of the user.

    
    
  • phone_config(UserPhoneConfig) / set_phone_config(Option<UserPhoneConfig>):
    required: true
    

    The phone settings for the user.

    
    
  • directory_user_id(impl Into<String>) / set_directory_user_id(Option<String>):
    required: false
    

    The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

    This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

    
    
  • security_profile_ids(impl Into<String>) / set_security_profile_ids(Option<Vec::<String>>):
    required: true
    

    The identifier of the security profile for the user.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile for the user.

    
    
  • hierarchy_group_id(impl Into<String>) / set_hierarchy_group_id(Option<String>):
    required: false
    

    The identifier of the hierarchy group for the user.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateUserOutput with field(s):
  • user_id(Option<String>):

    The identifier of the user account.

  • user_arn(Option<String>):

    The Amazon Resource Name (ARN) of the user account.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn create_user_hierarchy_group( &self ) -> CreateUserHierarchyGroupFluentBuilder

Constructs a fluent builder for the CreateUserHierarchyGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the user hierarchy group. Must not be more than 100 characters.

    
    
  • parent_group_id(impl Into<String>) / set_parent_group_id(Option<String>):
    required: false
    

    The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateUserHierarchyGroupOutput with field(s):
  • hierarchy_group_id(Option<String>):

    The identifier of the hierarchy group.

  • hierarchy_group_arn(Option<String>):

    The Amazon Resource Name (ARN) of the hierarchy group.

• On failure, responds with SdkError<CreateUserHierarchyGroupError>

impl Client

pub fn create_view(&self) -> CreateViewFluentBuilder

Constructs a fluent builder for the CreateView operation.

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

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

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.

    
    
  • status(ViewStatus) / set_status(Option<ViewStatus>):
    required: true
    

    Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

    
    
  • content(ViewInputContent) / set_content(Option<ViewInputContent>):
    required: true
    

    View content containing all content necessary to render a view except for runtime input data.

    The total uncompressed content has a maximum file size of 400kB.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the view.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the view.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateViewOutput with field(s):
  • view(Option<View>):

    A view resource object. Contains metadata and content necessary to render the view.

• On failure, responds with SdkError<CreateViewError>

impl Client

pub fn create_view_version(&self) -> CreateViewVersionFluentBuilder

Constructs a fluent builder for the CreateViewVersion operation.

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The identifier of the view. Both ViewArn and ViewId can be used.

    
    
  • version_description(impl Into<String>) / set_version_description(Option<String>):
    required: false
    

    The description for the version being published.

    
    
  • view_content_sha256(impl Into<String>) / set_view_content_sha256(Option<String>):
    required: false
    

    Indicates the checksum value of the latest published view content.

    
    
• On success, responds with CreateViewVersionOutput with field(s):
  • view(Option<View>):

    All view data is contained within the View object.

• On failure, responds with SdkError<CreateViewVersionError>

impl Client

pub fn create_vocabulary(&self) -> CreateVocabularyFluentBuilder

Constructs a fluent builder for the CreateVocabulary operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • vocabulary_name(impl Into<String>) / set_vocabulary_name(Option<String>):
    required: true
    

    A unique name of the custom vocabulary.

    
    
  • language_code(VocabularyLanguageCode) / set_language_code(Option<VocabularyLanguageCode>):
    required: true
    

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with CreateVocabularyOutput with field(s):
  • vocabulary_arn(String):

    The Amazon Resource Name (ARN) of the custom vocabulary.

  • vocabulary_id(String):

    The identifier of the custom vocabulary.

  • state(VocabularyState):

    The current state of the custom vocabulary.

• On failure, responds with SdkError<CreateVocabularyError>

impl Client

pub fn deactivate_evaluation_form( &self ) -> DeactivateEvaluationFormFluentBuilder

Constructs a fluent builder for the DeactivateEvaluationForm operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    The unique identifier for the evaluation form.

    
    
  • evaluation_form_version(i32) / set_evaluation_form_version(Option<i32>):
    required: true
    

    A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.

    
    
• On success, responds with DeactivateEvaluationFormOutput with field(s):
  • evaluation_form_id(String):

    The unique identifier for the evaluation form.

  • evaluation_form_arn(String):

    The Amazon Resource Name (ARN) for the evaluation form resource.

  • evaluation_form_version(i32):

    The version of the deactivated evaluation form resource.

• On failure, responds with SdkError<DeactivateEvaluationFormError>

impl Client

pub fn delete_contact_evaluation(&self) -> DeleteContactEvaluationFluentBuilder

Constructs a fluent builder for the DeleteContactEvaluation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_id(impl Into<String>) / set_evaluation_id(Option<String>):
    required: true
    

    A unique identifier for the contact evaluation.

    
    
• On success, responds with DeleteContactEvaluationOutput
• On failure, responds with SdkError<DeleteContactEvaluationError>

impl Client

pub fn delete_contact_flow(&self) -> DeleteContactFlowFluentBuilder

Constructs a fluent builder for the DeleteContactFlow operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
• On success, responds with DeleteContactFlowOutput
• On failure, responds with SdkError<DeleteContactFlowError>

impl Client

pub fn delete_contact_flow_module(&self) -> DeleteContactFlowModuleFluentBuilder

Constructs a fluent builder for the DeleteContactFlowModule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_module_id(impl Into<String>) / set_contact_flow_module_id(Option<String>):
    required: true
    

    The identifier of the flow module.

    
    
• On success, responds with DeleteContactFlowModuleOutput
• On failure, responds with SdkError<DeleteContactFlowModuleError>

impl Client

pub fn delete_evaluation_form(&self) -> DeleteEvaluationFormFluentBuilder

Constructs a fluent builder for the DeleteEvaluationForm operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    The unique identifier for the evaluation form.

    
    
  • evaluation_form_version(i32) / set_evaluation_form_version(Option<i32>):
    required: false
    

    The unique identifier for the evaluation form.

    
    
• On success, responds with DeleteEvaluationFormOutput
• On failure, responds with SdkError<DeleteEvaluationFormError>

impl Client

pub fn delete_hours_of_operation(&self) -> DeleteHoursOfOperationFluentBuilder

Constructs a fluent builder for the DeleteHoursOfOperation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • hours_of_operation_id(impl Into<String>) / set_hours_of_operation_id(Option<String>):
    required: true
    

    The identifier for the hours of operation.

    
    
• On success, responds with DeleteHoursOfOperationOutput
• On failure, responds with SdkError<DeleteHoursOfOperationError>

impl Client

pub fn delete_instance(&self) -> DeleteInstanceFluentBuilder

Constructs a fluent builder for the DeleteInstance operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DeleteInstanceOutput
• On failure, responds with SdkError<DeleteInstanceError>

impl Client

pub fn delete_integration_association( &self ) -> DeleteIntegrationAssociationFluentBuilder

Constructs a fluent builder for the DeleteIntegrationAssociation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • integration_association_id(impl Into<String>) / set_integration_association_id(Option<String>):
    required: true
    

    The identifier for the integration association.

    
    
• On success, responds with DeleteIntegrationAssociationOutput
• On failure, responds with SdkError<DeleteIntegrationAssociationError>

impl Client

pub fn delete_prompt(&self) -> DeletePromptFluentBuilder

Constructs a fluent builder for the DeletePrompt operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • prompt_id(impl Into<String>) / set_prompt_id(Option<String>):
    required: true
    

    A unique identifier for the prompt.

    
    
• On success, responds with DeletePromptOutput
• On failure, responds with SdkError<DeletePromptError>

impl Client

pub fn delete_queue(&self) -> DeleteQueueFluentBuilder

Constructs a fluent builder for the DeleteQueue operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
• On success, responds with DeleteQueueOutput
• On failure, responds with SdkError<DeleteQueueError>

impl Client

pub fn delete_quick_connect(&self) -> DeleteQuickConnectFluentBuilder

Constructs a fluent builder for the DeleteQuickConnect operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • quick_connect_id(impl Into<String>) / set_quick_connect_id(Option<String>):
    required: true
    

    The identifier for the quick connect.

    
    
• On success, responds with DeleteQuickConnectOutput
• On failure, responds with SdkError<DeleteQuickConnectError>

impl Client

pub fn delete_routing_profile(&self) -> DeleteRoutingProfileFluentBuilder

Constructs a fluent builder for the DeleteRoutingProfile operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
• On success, responds with DeleteRoutingProfileOutput
• On failure, responds with SdkError<DeleteRoutingProfileError>

impl Client

pub fn delete_rule(&self) -> DeleteRuleFluentBuilder

Constructs a fluent builder for the DeleteRule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    A unique identifier for the rule.

    
    
• On success, responds with DeleteRuleOutput
• On failure, responds with SdkError<DeleteRuleError>

impl Client

pub fn delete_security_profile(&self) -> DeleteSecurityProfileFluentBuilder

Constructs a fluent builder for the DeleteSecurityProfile operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • security_profile_id(impl Into<String>) / set_security_profile_id(Option<String>):
    required: true
    

    The identifier for the security profle.

    
    
• On success, responds with DeleteSecurityProfileOutput
• On failure, responds with SdkError<DeleteSecurityProfileError>

impl Client

pub fn delete_task_template(&self) -> DeleteTaskTemplateFluentBuilder

Constructs a fluent builder for the DeleteTaskTemplate operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • task_template_id(impl Into<String>) / set_task_template_id(Option<String>):
    required: true
    

    A unique identifier for the task template.

    
    
• On success, responds with DeleteTaskTemplateOutput
• On failure, responds with SdkError<DeleteTaskTemplateError>

impl Client

pub fn delete_traffic_distribution_group( &self ) -> DeleteTrafficDistributionGroupFluentBuilder

Constructs a fluent builder for the DeleteTrafficDistributionGroup operation.

• The fluent builder is configurable:
  • traffic_distribution_group_id(impl Into<String>) / set_traffic_distribution_group_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

    
    
• On success, responds with DeleteTrafficDistributionGroupOutput
• On failure, responds with SdkError<DeleteTrafficDistributionGroupError>

impl Client

pub fn delete_use_case(&self) -> DeleteUseCaseFluentBuilder

Constructs a fluent builder for the DeleteUseCase operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • integration_association_id(impl Into<String>) / set_integration_association_id(Option<String>):
    required: true
    

    The identifier for the integration association.

    
    
  • use_case_id(impl Into<String>) / set_use_case_id(Option<String>):
    required: true
    

    The identifier for the use case.

    
    
• On success, responds with DeleteUseCaseOutput
• On failure, responds with SdkError<DeleteUseCaseError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user.

    
    
• On success, responds with DeleteUserOutput
• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn delete_user_hierarchy_group( &self ) -> DeleteUserHierarchyGroupFluentBuilder

Constructs a fluent builder for the DeleteUserHierarchyGroup operation.

• The fluent builder is configurable:
  • hierarchy_group_id(impl Into<String>) / set_hierarchy_group_id(Option<String>):
    required: true
    

    The identifier of the hierarchy group.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DeleteUserHierarchyGroupOutput
• On failure, responds with SdkError<DeleteUserHierarchyGroupError>

impl Client

pub fn delete_view(&self) -> DeleteViewFluentBuilder

Constructs a fluent builder for the DeleteView operation.

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The identifier of the view. Both ViewArn and ViewId can be used.

    
    
• On success, responds with DeleteViewOutput
• On failure, responds with SdkError<DeleteViewError>

impl Client

pub fn delete_view_version(&self) -> DeleteViewVersionFluentBuilder

Constructs a fluent builder for the DeleteViewVersion operation.

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The identifier of the view. Both ViewArn and ViewId can be used.

    
    
  • view_version(i32) / set_view_version(Option<i32>):
    required: true
    

    The version number of the view.

    
    
• On success, responds with DeleteViewVersionOutput
• On failure, responds with SdkError<DeleteViewVersionError>

impl Client

pub fn delete_vocabulary(&self) -> DeleteVocabularyFluentBuilder

Constructs a fluent builder for the DeleteVocabulary operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • vocabulary_id(impl Into<String>) / set_vocabulary_id(Option<String>):
    required: true
    

    The identifier of the custom vocabulary.

    
    
• On success, responds with DeleteVocabularyOutput with field(s):
  • vocabulary_arn(String):

    The Amazon Resource Name (ARN) of the custom vocabulary.

  • vocabulary_id(String):

    The identifier of the custom vocabulary.

  • state(VocabularyState):

    The current state of the custom vocabulary.

• On failure, responds with SdkError<DeleteVocabularyError>

impl Client

pub fn describe_agent_status(&self) -> DescribeAgentStatusFluentBuilder

Constructs a fluent builder for the DescribeAgentStatus operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • agent_status_id(impl Into<String>) / set_agent_status_id(Option<String>):
    required: true
    

    The identifier for the agent status.

    
    
• On success, responds with DescribeAgentStatusOutput with field(s):
  • agent_status(Option<AgentStatus>):

    The agent status.

• On failure, responds with SdkError<DescribeAgentStatusError>

impl Client

pub fn describe_contact(&self) -> DescribeContactFluentBuilder

Constructs a fluent builder for the DescribeContact operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
• On success, responds with DescribeContactOutput with field(s):
  • contact(Option<Contact>):

    Information about the contact.

• On failure, responds with SdkError<DescribeContactError>

impl Client

pub fn describe_contact_evaluation( &self ) -> DescribeContactEvaluationFluentBuilder

Constructs a fluent builder for the DescribeContactEvaluation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_id(impl Into<String>) / set_evaluation_id(Option<String>):
    required: true
    

    A unique identifier for the contact evaluation.

    
    
• On success, responds with DescribeContactEvaluationOutput with field(s):
  • evaluation(Option<Evaluation>):

    Information about the evaluation form completed for a specific contact.

  • evaluation_form(Option<EvaluationFormContent>):

    Information about the evaluation form.

• On failure, responds with SdkError<DescribeContactEvaluationError>

impl Client

pub fn describe_contact_flow(&self) -> DescribeContactFlowFluentBuilder

Constructs a fluent builder for the DescribeContactFlow operation.

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

    The identifier of the Amazon Connect instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
• On success, responds with DescribeContactFlowOutput with field(s):
  • contact_flow(Option<ContactFlow>):

    Information about the flow.

• On failure, responds with SdkError<DescribeContactFlowError>

impl Client

pub fn describe_contact_flow_module( &self ) -> DescribeContactFlowModuleFluentBuilder

Constructs a fluent builder for the DescribeContactFlowModule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_module_id(impl Into<String>) / set_contact_flow_module_id(Option<String>):
    required: true
    

    The identifier of the flow module.

    
    
• On success, responds with DescribeContactFlowModuleOutput with field(s):
  • contact_flow_module(Option<ContactFlowModule>):

    Information about the flow module.

• On failure, responds with SdkError<DescribeContactFlowModuleError>

impl Client

pub fn describe_evaluation_form(&self) -> DescribeEvaluationFormFluentBuilder

Constructs a fluent builder for the DescribeEvaluationForm operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    A unique identifier for the contact evaluation.

    
    
  • evaluation_form_version(i32) / set_evaluation_form_version(Option<i32>):
    required: false
    

    A version of the evaluation form.

    
    
• On success, responds with DescribeEvaluationFormOutput with field(s):
  • evaluation_form(Option<EvaluationForm>):

    Information about the evaluation form.

• On failure, responds with SdkError<DescribeEvaluationFormError>

impl Client

pub fn describe_hours_of_operation( &self ) -> DescribeHoursOfOperationFluentBuilder

Constructs a fluent builder for the DescribeHoursOfOperation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • hours_of_operation_id(impl Into<String>) / set_hours_of_operation_id(Option<String>):
    required: true
    

    The identifier for the hours of operation.

    
    
• On success, responds with DescribeHoursOfOperationOutput with field(s):
  • hours_of_operation(Option<HoursOfOperation>):

    The hours of operation.

• On failure, responds with SdkError<DescribeHoursOfOperationError>

impl Client

pub fn describe_instance(&self) -> DescribeInstanceFluentBuilder

Constructs a fluent builder for the DescribeInstance operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DescribeInstanceOutput with field(s):
  • instance(Option<Instance>):

    The name of the instance.

• On failure, responds with SdkError<DescribeInstanceError>

impl Client

pub fn describe_instance_attribute( &self ) -> DescribeInstanceAttributeFluentBuilder

Constructs a fluent builder for the DescribeInstanceAttribute operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • attribute_type(InstanceAttributeType) / set_attribute_type(Option<InstanceAttributeType>):
    required: true
    

    The type of attribute.

    
    
• On success, responds with DescribeInstanceAttributeOutput with field(s):
  • attribute(Option<Attribute>):

    The type of attribute.

• On failure, responds with SdkError<DescribeInstanceAttributeError>

impl Client

pub fn describe_instance_storage_config( &self ) -> DescribeInstanceStorageConfigFluentBuilder

Constructs a fluent builder for the DescribeInstanceStorageConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    
    
  • resource_type(InstanceStorageResourceType) / set_resource_type(Option<InstanceStorageResourceType>):
    required: true
    

    A valid resource type.

    
    
• On success, responds with DescribeInstanceStorageConfigOutput with field(s):
  • storage_config(Option<InstanceStorageConfig>):

    A valid storage type.

• On failure, responds with SdkError<DescribeInstanceStorageConfigError>

impl Client

pub fn describe_phone_number(&self) -> DescribePhoneNumberFluentBuilder

Constructs a fluent builder for the DescribePhoneNumber operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    A unique identifier for the phone number.

    
    
• On success, responds with DescribePhoneNumberOutput with field(s):
  • claimed_phone_number_summary(Option<ClaimedPhoneNumberSummary>):

    Information about a phone number that’s been claimed to your Amazon Connect instance or traffic distribution group.

• On failure, responds with SdkError<DescribePhoneNumberError>

impl Client

pub fn describe_prompt(&self) -> DescribePromptFluentBuilder

Constructs a fluent builder for the DescribePrompt operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • prompt_id(impl Into<String>) / set_prompt_id(Option<String>):
    required: true
    

    A unique identifier for the prompt.

    
    
• On success, responds with DescribePromptOutput with field(s):
  • prompt(Option<Prompt>):

    Information about the prompt.

• On failure, responds with SdkError<DescribePromptError>

impl Client

pub fn describe_queue(&self) -> DescribeQueueFluentBuilder

Constructs a fluent builder for the DescribeQueue operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
• On success, responds with DescribeQueueOutput with field(s):
  • queue(Option<Queue>):

    The name of the queue.

• On failure, responds with SdkError<DescribeQueueError>

impl Client

pub fn describe_quick_connect(&self) -> DescribeQuickConnectFluentBuilder

Constructs a fluent builder for the DescribeQuickConnect operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • quick_connect_id(impl Into<String>) / set_quick_connect_id(Option<String>):
    required: true
    

    The identifier for the quick connect.

    
    
• On success, responds with DescribeQuickConnectOutput with field(s):
  • quick_connect(Option<QuickConnect>):

    Information about the quick connect.

• On failure, responds with SdkError<DescribeQuickConnectError>

impl Client

pub fn describe_routing_profile(&self) -> DescribeRoutingProfileFluentBuilder

Constructs a fluent builder for the DescribeRoutingProfile operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
• On success, responds with DescribeRoutingProfileOutput with field(s):
  • routing_profile(Option<RoutingProfile>):

    The routing profile.

• On failure, responds with SdkError<DescribeRoutingProfileError>

impl Client

pub fn describe_rule(&self) -> DescribeRuleFluentBuilder

Constructs a fluent builder for the DescribeRule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    A unique identifier for the rule.

    
    
• On success, responds with DescribeRuleOutput with field(s):
  • rule(Option<Rule>):

    Information about the rule.

• On failure, responds with SdkError<DescribeRuleError>

impl Client

pub fn describe_security_profile(&self) -> DescribeSecurityProfileFluentBuilder

Constructs a fluent builder for the DescribeSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_id(impl Into<String>) / set_security_profile_id(Option<String>):
    required: true
    

    The identifier for the security profle.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DescribeSecurityProfileOutput with field(s):
  • security_profile(Option<SecurityProfile>):

    The security profile.

• On failure, responds with SdkError<DescribeSecurityProfileError>

impl Client

pub fn describe_traffic_distribution_group( &self ) -> DescribeTrafficDistributionGroupFluentBuilder

Constructs a fluent builder for the DescribeTrafficDistributionGroup operation.

• The fluent builder is configurable:
  • traffic_distribution_group_id(impl Into<String>) / set_traffic_distribution_group_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

    
    
• On success, responds with DescribeTrafficDistributionGroupOutput with field(s):
  • traffic_distribution_group(Option<TrafficDistributionGroup>):

    Information about the traffic distribution group.

• On failure, responds with SdkError<DescribeTrafficDistributionGroupError>

impl Client

pub fn describe_user(&self) -> DescribeUserFluentBuilder

Constructs a fluent builder for the DescribeUser operation.

• The fluent builder is configurable:
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DescribeUserOutput with field(s):
  • user(Option<User>):

    Information about the user account and configuration settings.

• On failure, responds with SdkError<DescribeUserError>

impl Client

pub fn describe_user_hierarchy_group( &self ) -> DescribeUserHierarchyGroupFluentBuilder

Constructs a fluent builder for the DescribeUserHierarchyGroup operation.

• The fluent builder is configurable:
  • hierarchy_group_id(impl Into<String>) / set_hierarchy_group_id(Option<String>):
    required: true
    

    The identifier of the hierarchy group.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DescribeUserHierarchyGroupOutput with field(s):
  • hierarchy_group(Option<HierarchyGroup>):

    Information about the hierarchy group.

• On failure, responds with SdkError<DescribeUserHierarchyGroupError>

impl Client

pub fn describe_user_hierarchy_structure( &self ) -> DescribeUserHierarchyStructureFluentBuilder

Constructs a fluent builder for the DescribeUserHierarchyStructure operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DescribeUserHierarchyStructureOutput with field(s):
  • hierarchy_structure(Option<HierarchyStructure>):

    Information about the hierarchy structure.

• On failure, responds with SdkError<DescribeUserHierarchyStructureError>

impl Client

pub fn describe_view(&self) -> DescribeViewFluentBuilder

Constructs a fluent builder for the DescribeView operation.

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The ViewId of the view. This must be an ARN for Amazon Web Services managed views.

    
    
• On success, responds with DescribeViewOutput with field(s):
  • view(Option<View>):

    All view data is contained within the View object.

• On failure, responds with SdkError<DescribeViewError>

impl Client

pub fn describe_vocabulary(&self) -> DescribeVocabularyFluentBuilder

Constructs a fluent builder for the DescribeVocabulary operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • vocabulary_id(impl Into<String>) / set_vocabulary_id(Option<String>):
    required: true
    

    The identifier of the custom vocabulary.

    
    
• On success, responds with DescribeVocabularyOutput with field(s):
  • vocabulary(Option<Vocabulary>):

    A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.

• On failure, responds with SdkError<DescribeVocabularyError>

impl Client

pub fn disassociate_approved_origin( &self ) -> DisassociateApprovedOriginFluentBuilder

Constructs a fluent builder for the DisassociateApprovedOrigin operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • origin(impl Into<String>) / set_origin(Option<String>):
    required: true
    

    The domain URL of the integrated application.

    
    
• On success, responds with DisassociateApprovedOriginOutput
• On failure, responds with SdkError<DisassociateApprovedOriginError>

impl Client

pub fn disassociate_bot(&self) -> DisassociateBotFluentBuilder

Constructs a fluent builder for the DisassociateBot operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • lex_bot(LexBot) / set_lex_bot(Option<LexBot>):
    required: false
    

    Configuration information of an Amazon Lex bot.

    
    
  • lex_v2_bot(LexV2Bot) / set_lex_v2_bot(Option<LexV2Bot>):
    required: false
    

    The Amazon Lex V2 bot to disassociate from the instance.

    
    
• On success, responds with DisassociateBotOutput
• On failure, responds with SdkError<DisassociateBotError>

impl Client

pub fn disassociate_instance_storage_config( &self ) -> DisassociateInstanceStorageConfigFluentBuilder

Constructs a fluent builder for the DisassociateInstanceStorageConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    
    
  • resource_type(InstanceStorageResourceType) / set_resource_type(Option<InstanceStorageResourceType>):
    required: true
    

    A valid resource type.

    
    
• On success, responds with DisassociateInstanceStorageConfigOutput
• On failure, responds with SdkError<DisassociateInstanceStorageConfigError>

impl Client

pub fn disassociate_lambda_function( &self ) -> DisassociateLambdaFunctionFluentBuilder

Constructs a fluent builder for the DisassociateLambdaFunction operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..

    
    
  • function_arn(impl Into<String>) / set_function_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Lambda function being disassociated.

    
    
• On success, responds with DisassociateLambdaFunctionOutput
• On failure, responds with SdkError<DisassociateLambdaFunctionError>

impl Client

pub fn disassociate_lex_bot(&self) -> DisassociateLexBotFluentBuilder

Constructs a fluent builder for the DisassociateLexBot operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • bot_name(impl Into<String>) / set_bot_name(Option<String>):
    required: true
    

    The name of the Amazon Lex bot. Maximum character limit of 50.

    
    
  • lex_region(impl Into<String>) / set_lex_region(Option<String>):
    required: true
    

    The Amazon Web Services Region in which the Amazon Lex bot has been created.

    
    
• On success, responds with DisassociateLexBotOutput
• On failure, responds with SdkError<DisassociateLexBotError>

impl Client

pub fn disassociate_phone_number_contact_flow( &self ) -> DisassociatePhoneNumberContactFlowFluentBuilder

Constructs a fluent builder for the DisassociatePhoneNumberContactFlow operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    A unique identifier for the phone number.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DisassociatePhoneNumberContactFlowOutput
• On failure, responds with SdkError<DisassociatePhoneNumberContactFlowError>

impl Client

pub fn disassociate_queue_quick_connects( &self ) -> DisassociateQueueQuickConnectsFluentBuilder

Constructs a fluent builder for the DisassociateQueueQuickConnects operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • quick_connect_ids(impl Into<String>) / set_quick_connect_ids(Option<Vec::<String>>):
    required: true
    

    The quick connects to disassociate from the queue.

    
    
• On success, responds with DisassociateQueueQuickConnectsOutput
• On failure, responds with SdkError<DisassociateQueueQuickConnectsError>

impl Client

pub fn disassociate_routing_profile_queues( &self ) -> DisassociateRoutingProfileQueuesFluentBuilder

Constructs a fluent builder for the DisassociateRoutingProfileQueues operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • queue_references(RoutingProfileQueueReference) / set_queue_references(Option<Vec::<RoutingProfileQueueReference>>):
    required: true
    

    The queues to disassociate from this routing profile.

    
    
• On success, responds with DisassociateRoutingProfileQueuesOutput
• On failure, responds with SdkError<DisassociateRoutingProfileQueuesError>

impl Client

pub fn disassociate_security_key(&self) -> DisassociateSecurityKeyFluentBuilder

Constructs a fluent builder for the DisassociateSecurityKey operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    
    
• On success, responds with DisassociateSecurityKeyOutput
• On failure, responds with SdkError<DisassociateSecurityKeyError>

impl Client

pub fn disassociate_traffic_distribution_group_user( &self ) -> DisassociateTrafficDistributionGroupUserFluentBuilder

Constructs a fluent builder for the DisassociateTrafficDistributionGroupUser operation.

• The fluent builder is configurable:
  • traffic_distribution_group_id(impl Into<String>) / set_traffic_distribution_group_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier for the user. This can be the ID or the ARN of the user.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with DisassociateTrafficDistributionGroupUserOutput
• On failure, responds with SdkError<DisassociateTrafficDistributionGroupUserError>

impl Client

pub fn dismiss_user_contact(&self) -> DismissUserContactFluentBuilder

Constructs a fluent builder for the DismissUserContact operation.

• The fluent builder is configurable:
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

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

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
• On success, responds with DismissUserContactOutput
• On failure, responds with SdkError<DismissUserContactError>

impl Client

pub fn get_contact_attributes(&self) -> GetContactAttributesFluentBuilder

Constructs a fluent builder for the GetContactAttributes operation.

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

    The identifier of the Amazon Connect instance.

    
    
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    The identifier of the initial contact.

    
    
• On success, responds with GetContactAttributesOutput with field(s):
  • attributes(Option<HashMap::<String, String>>):

    Information about the attributes.

• On failure, responds with SdkError<GetContactAttributesError>

impl Client

pub fn get_current_metric_data(&self) -> GetCurrentMetricDataFluentBuilder

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>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    The filters to apply to returned metrics. You can filter up to the following limits:

    • Queues: 100

    • Routing profiles: 100

    • Channels: 3 (VOICE, CHAT, and TASK channels are supported.)

    Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.

    Currently tagging is only supported on the resources that are passed in the filter.

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

    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 you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.

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

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

    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>):
    required: false
    

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • sort_criteria(CurrentMetricSortCriteria) / set_sort_criteria(Option<Vec::<CurrentMetricSortCriteria>>):
    required: false
    

    The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.

    Note the following:

    • Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.

    
    
• On success, responds with GetCurrentMetricDataOutput 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::<CurrentMetricResult>>):

    Information about the real-time metrics.

  • data_snapshot_time(Option<DateTime>):

    The time at which the metrics were retrieved and cached for pagination.

  • approximate_total_count(Option<i64>):

    The total count of the result, regardless of the current page size.

• On failure, responds with SdkError<GetCurrentMetricDataError>

impl Client

pub fn get_current_user_data(&self) -> GetCurrentUserDataFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • filters(UserDataFilters) / set_filters(Option<UserDataFilters>):
    required: true
    

    The filters to apply to returned user data. You can filter up to the following limits:

    • Queues: 100

    • Routing profiles: 100

    • Agents: 100

    • Contact states: 9

    • User hierarchy groups: 1

    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

    Currently tagging is only supported on the resources that are passed in the filter.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

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

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

  • user_data_list(Option<Vec::<UserData>>):

    A list of the user data that is returned.

  • approximate_total_count(Option<i64>):

    The total count of the result, regardless of the current page size.

• On failure, responds with SdkError<GetCurrentUserDataError>

impl Client

pub fn get_federation_token(&self) -> GetFederationTokenFluentBuilder

Constructs a fluent builder for the GetFederationToken operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with GetFederationTokenOutput with field(s):
  • credentials(Option<Credentials>):

    The credentials to use for federation.

  • sign_in_url(Option<String>):

    The URL to sign into the user’s instance.

  • user_arn(Option<String>):

    The Amazon Resource Name (ARN) of the user.

  • user_id(Option<String>):

    The identifier for the user. This can be the ID or the ARN of the user.

• On failure, responds with SdkError<GetFederationTokenError>

impl Client

pub fn get_metric_data(&self) -> GetMetricDataFluentBuilder

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>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: true
    

    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>):
    required: true
    

    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(Grouping) / set_groupings(Option<Vec::<Grouping>>):
    required: false
    

    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(HistoricalMetric) / set_historical_metrics(Option<Vec::<HistoricalMetric>>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn get_metric_data_v2(&self) -> GetMetricDataV2FluentBuilder

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

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.

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

    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 before the end time timestamp. The start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.

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

    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 later than the start time timestamp. It cannot be later than the current timestamp.

    
    
  • interval(IntervalDetails) / set_interval(Option<IntervalDetails>):
    required: false
    

    The interval period and timezone to apply to returned metrics.

    • IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

      For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.

      The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.

      • FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

      • THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

      • HOUR: The difference between StartTime and EndTime must be less than 3 days.

      • DAY: The difference between StartTime and EndTime must be less than 35 days.

      • WEEK: The difference between StartTime and EndTime must be less than 35 days.

      • TOTAL: The difference between StartTime and EndTime must be less than 35 days.

    • TimeZone: The timezone applied to requested metrics.

    
    
  • filters(FilterV2) / set_filters(Option<Vec::<FilterV2>>):
    required: true
    

    The filters to apply to returned metrics. You can filter on the following resources:

    • Queues

    • Routing profiles

    • Agents

    • Channels

    • User hierarchy groups

    • Feature

    At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

    To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator’s Guide.

    Note the following limits:

    • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE

    • Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.

      contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.

    
    
  • groupings(impl Into<String>) / set_groupings(Option<Vec::<String>>):
    required: false
    

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

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

    Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE

    
    
  • metrics(MetricV2) / set_metrics(Option<Vec::<MetricV2>>):
    required: true
    

    The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator’s Guide.

    ABANDONMENT_RATE

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AGENT_ADHERENT_TIME

    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AGENT_NON_RESPONSE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

    AGENT_OCCUPANCY

    Unit: Percentage

    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

    AGENT_SCHEDULE_ADHERENCE

    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AGENT_SCHEDULED_TIME

    This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_ABANDON_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_AFTER_CONTACT_WORK_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_AGENT_CONNECTING_TIME

    Unit: Seconds

    Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    The Negate key in Metric Level Filters is not applicable for this metric.

    AVG_CONTACT_DURATION

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_CONVERSATION_DURATION

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_GREETING_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_HANDLE_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_HOLD_TIME_ALL_CONTACTS

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_HOLDS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_INTERACTION_AND_HOLD_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_INTERACTION_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_INTERRUPTIONS_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_INTERRUPTION_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_NON_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_QUEUE_ANSWER_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Feature

    Feature is a valid filter but not a valid grouping.

    AVG_RESOLUTION_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile

    AVG_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_TALK_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    AVG_TALK_TIME_CUSTOMER

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_ABANDONED

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_CREATED

    Unit: Count

    Valid metric filter key: INITIATION_METHOD

    Valid groupings and filters: Queue, Channel, Routing Profile, Feature

    Feature is a valid filter but not a valid grouping.

    CONTACTS_HANDLED

    Unit: Count

    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    CONTACTS_HOLD_ABANDONS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_QUEUED

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_RESOLVED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

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

    CONTACTS_TRANSFERRED_OUT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

    Feature is a valid filter but not a valid grouping.

    CONTACTS_TRANSFERRED_OUT_BY_AGENT

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    MAX_QUEUED_TIME

    Unit: Seconds

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    PERCENT_NON_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    PERCENT_TALK_TIME

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    PERCENT_TALK_TIME_AGENT

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    PERCENT_TALK_TIME_CUSTOMER

    This metric is available only for contacts analyzed by Contact Lens conversational analytics.

    Unit: Percentage

    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

    SERVICE_LEVEL

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

    Unit: Percent

    Valid groupings and filters: Queue, Channel, Routing Profile

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

    SUM_CONTACTS_ANSWERED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

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

    SUM_CONTACTS_ABANDONED_IN_X

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

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

    SUM_CONTACTS_DISCONNECTED

    Valid metric filter key: DISCONNECT_REASON

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

    SUM_RETRY_CALLBACK_ATTEMPTS

    Unit: Count

    Valid groupings and filters: Queue, Channel, Routing Profile

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

    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>):
    required: false
    

    The maximum number of results to return per page.

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

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

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

    Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.

• On failure, responds with SdkError<GetMetricDataV2Error>

impl Client

pub fn get_prompt_file(&self) -> GetPromptFileFluentBuilder

Constructs a fluent builder for the GetPromptFile operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • prompt_id(impl Into<String>) / set_prompt_id(Option<String>):
    required: true
    

    A unique identifier for the prompt.

    
    
• On success, responds with GetPromptFileOutput with field(s):
  • prompt_presigned_url(Option<String>):

    A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.

  • last_modified_time(Option<DateTime>):

    The timestamp when this resource was last modified.

  • last_modified_region(Option<String>):

    The Amazon Web Services Region where this resource was last modified.

• On failure, responds with SdkError<GetPromptFileError>

impl Client

pub fn get_task_template(&self) -> GetTaskTemplateFluentBuilder

Constructs a fluent builder for the GetTaskTemplate operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • task_template_id(impl Into<String>) / set_task_template_id(Option<String>):
    required: true
    

    A unique identifier for the task template.

    
    
  • snapshot_version(impl Into<String>) / set_snapshot_version(Option<String>):
    required: false
    

    The system generated version of a task template that is associated with a task, when the task is created.

    
    
• On success, responds with GetTaskTemplateOutput with field(s):
  • instance_id(Option<String>):

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • id(String):

    A unique identifier for the task template.

  • arn(String):

    The Amazon Resource Name (ARN).

  • name(String):

    The name of the task template.

  • description(Option<String>):

    The description of the task template.

  • contact_flow_id(Option<String>):

    The identifier of the flow that runs by default when a task is created by referencing this template.

  • constraints(Option<TaskTemplateConstraints>):

    Constraints that are applicable to the fields listed.

  • defaults(Option<TaskTemplateDefaults>):

    The default values for fields when a task is created by referencing this template.

  • fields(Option<Vec::<TaskTemplateField>>):

    Fields that are part of the template.

  • status(Option<TaskTemplateStatus>):

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

  • last_modified_time(Option<DateTime>):

    The timestamp when the task template was last modified.

  • created_time(Option<DateTime>):

    The timestamp when the task template was created.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

• On failure, responds with SdkError<GetTaskTemplateError>

impl Client

pub fn get_traffic_distribution(&self) -> GetTrafficDistributionFluentBuilder

Constructs a fluent builder for the GetTrafficDistribution operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group.

    
    
• On success, responds with GetTrafficDistributionOutput with field(s):
  • telephony_config(Option<TelephonyConfig>):

    The distribution of traffic between the instance and its replicas.

  • id(Option<String>):

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the traffic distribution group.

  • sign_in_config(Option<SignInConfig>):

    The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

  • agent_config(Option<AgentConfig>):

    The distribution of agents between the instance and its replica(s).

• On failure, responds with SdkError<GetTrafficDistributionError>

impl Client

pub fn list_agent_statuses(&self) -> ListAgentStatusesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • agent_status_types(AgentStatusType) / set_agent_status_types(Option<Vec::<AgentStatusType>>):
    required: false
    

    Available agent status types.

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

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

  • agent_status_summary_list(Option<Vec::<AgentStatusSummary>>):

    A summary of agent statuses.

• On failure, responds with SdkError<ListAgentStatusesError>

impl Client

pub fn list_approved_origins(&self) -> ListApprovedOriginsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListApprovedOriginsOutput with field(s):
  • origins(Option<Vec::<String>>):

    The approved origins.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListApprovedOriginsError>

impl Client

pub fn list_bots(&self) -> ListBotsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • lex_version(LexVersion) / set_lex_version(Option<LexVersion>):
    required: true
    

    The version of Amazon Lex or Amazon Lex V2.

    
    
• On success, responds with ListBotsOutput with field(s):
  • lex_bots(Option<Vec::<LexBotConfig>>):

    The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListBotsError>

impl Client

pub fn list_contact_evaluations(&self) -> ListContactEvaluationsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact in this instance of Amazon Connect.

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

    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.

    This is not expected to be set because the value returned in the previous response is always null.

    
    
• On success, responds with ListContactEvaluationsOutput with field(s):
  • evaluation_summary_list(Vec::<EvaluationSummary>):

    Provides details about a list of contact evaluations belonging to an instance.

  • next_token(Option<String>):

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

    This is always returned as null in the response.

• On failure, responds with SdkError<ListContactEvaluationsError>

impl Client

pub fn list_contact_flow_modules(&self) -> ListContactFlowModulesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • contact_flow_module_state(ContactFlowModuleState) / set_contact_flow_module_state(Option<ContactFlowModuleState>):
    required: false
    

    The state of the flow module.

    
    
• On success, responds with ListContactFlowModulesOutput with field(s):
  • contact_flow_modules_summary_list(Option<Vec::<ContactFlowModuleSummary>>):

    Information about the flow module.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListContactFlowModulesError>

impl Client

pub fn list_contact_flows(&self) -> ListContactFlowsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_types(ContactFlowType) / set_contact_flow_types(Option<Vec::<ContactFlowType>>):
    required: false
    

    The type of flow.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListContactFlowsOutput with field(s):
  • contact_flow_summary_list(Option<Vec::<ContactFlowSummary>>):

    Information about the flows.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListContactFlowsError>

impl Client

pub fn list_contact_references(&self) -> ListContactReferencesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the initial contact.

    
    
  • reference_types(ReferenceType) / set_reference_types(Option<Vec::<ReferenceType>>):
    required: true
    

    The type of reference.

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

    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.

    This is not expected to be set, because the value returned in the previous response is always null.

    
    
• On success, responds with ListContactReferencesOutput with field(s):
  • reference_summary_list(Option<Vec::<ReferenceSummary>>):

    Information about the flows.

  • next_token(Option<String>):

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

    This is always returned as null in the response.

• On failure, responds with SdkError<ListContactReferencesError>

impl Client

pub fn list_default_vocabularies(&self) -> ListDefaultVocabulariesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • language_code(VocabularyLanguageCode) / set_language_code(Option<VocabularyLanguageCode>):
    required: false
    

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

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

    The maximum number of results to return per page.

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

    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.

    
    
• On success, responds with ListDefaultVocabulariesOutput with field(s):
  • default_vocabulary_list(Vec::<DefaultVocabulary>):

    A list of default vocabularies.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListDefaultVocabulariesError>

impl Client

pub fn list_evaluation_form_versions( &self ) -> ListEvaluationFormVersionsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    The unique identifier for the evaluation form.

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

    The maximum number of results to return per page.

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

    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.

    
    
• On success, responds with ListEvaluationFormVersionsOutput with field(s):
  • evaluation_form_version_summary_list(Vec::<EvaluationFormVersionSummary>):

    Provides details about a list of evaluation forms belonging to an instance.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListEvaluationFormVersionsError>

impl Client

pub fn list_evaluation_forms(&self) -> ListEvaluationFormsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    The maximum number of results to return per page.

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

    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.

    
    
• On success, responds with ListEvaluationFormsOutput with field(s):
  • evaluation_form_summary_list(Vec::<EvaluationFormSummary>):

    Provides details about a list of evaluation forms belonging to an instance.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListEvaluationFormsError>

impl Client

pub fn list_hours_of_operations(&self) -> ListHoursOfOperationsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListHoursOfOperationsOutput with field(s):
  • hours_of_operation_summary_list(Option<Vec::<HoursOfOperationSummary>>):

    Information about the hours of operation.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListHoursOfOperationsError>

impl Client

pub fn list_instance_attributes(&self) -> ListInstanceAttributesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListInstanceAttributesOutput with field(s):
  • attributes(Option<Vec::<Attribute>>):

    The attribute types.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListInstanceAttributesError>

impl Client

pub fn list_instance_storage_configs( &self ) -> ListInstanceStorageConfigsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • resource_type(InstanceStorageResourceType) / set_resource_type(Option<InstanceStorageResourceType>):
    required: true
    

    A valid resource type.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListInstanceStorageConfigsOutput with field(s):
  • storage_configs(Option<Vec::<InstanceStorageConfig>>):

    A valid storage type.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListInstanceStorageConfigsError>

impl Client

pub fn list_instances(&self) -> ListInstancesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListInstancesOutput with field(s):
  • instance_summary_list(Option<Vec::<InstanceSummary>>):

    Information about the instances.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListInstancesError>

impl Client

pub fn list_integration_associations( &self ) -> ListIntegrationAssociationsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • integration_type(IntegrationType) / set_integration_type(Option<IntegrationType>):
    required: false
    

    The integration type.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • integration_arn(impl Into<String>) / set_integration_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the integration.

    
    
• On success, responds with ListIntegrationAssociationsOutput with field(s):
  • integration_association_summary_list(Option<Vec::<IntegrationAssociationSummary>>):

    The associations.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListIntegrationAssociationsError>

impl Client

pub fn list_lambda_functions(&self) -> ListLambdaFunctionsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListLambdaFunctionsOutput with field(s):
  • lambda_functions(Option<Vec::<String>>):

    The Lambdafunction ARNs associated with the specified instance.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListLambdaFunctionsError>

impl Client

pub fn list_lex_bots(&self) -> ListLexBotsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. If no value is specified, the default is 10.

    
    
• On success, responds with ListLexBotsOutput with field(s):
  • lex_bots(Option<Vec::<LexBot>>):

    The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListLexBotsError>

impl Client

pub fn list_phone_numbers(&self) -> ListPhoneNumbersFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • phone_number_types(PhoneNumberType) / set_phone_number_types(Option<Vec::<PhoneNumberType>>):
    required: false
    

    The type of phone number.

    We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.

    
    
  • phone_number_country_codes(PhoneNumberCountryCode) / set_phone_number_country_codes(Option<Vec::<PhoneNumberCountryCode>>):
    required: false
    

    The ISO country code.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListPhoneNumbersOutput with field(s):
  • phone_number_summary_list(Option<Vec::<PhoneNumberSummary>>):

    Information about the phone numbers.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListPhoneNumbersError>

impl Client

pub fn list_phone_numbers_v2(&self) -> ListPhoneNumbersV2FluentBuilder

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

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both TargetArn and InstanceId input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both TargetArn and InstanceId are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.

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

    The maximum number of results to return per page.

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

    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.

    
    
  • phone_number_country_codes(PhoneNumberCountryCode) / set_phone_number_country_codes(Option<Vec::<PhoneNumberCountryCode>>):
    required: false
    

    The ISO country code.

    
    
  • phone_number_types(PhoneNumberType) / set_phone_number_types(Option<Vec::<PhoneNumberType>>):
    required: false
    

    The type of phone number.

    
    
  • phone_number_prefix(impl Into<String>) / set_phone_number_prefix(Option<String>):
    required: false
    

    The prefix of the phone number. If provided, it must contain + as part of the country code.

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

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

  • list_phone_numbers_summary_list(Option<Vec::<ListPhoneNumbersSummary>>):

    Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.

• On failure, responds with SdkError<ListPhoneNumbersV2Error>

impl Client

pub fn list_prompts(&self) -> ListPromptsFluentBuilder

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

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

    The identifier of the Amazon Connect instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListPromptsOutput with field(s):
  • prompt_summary_list(Option<Vec::<PromptSummary>>):

    Information about the prompts.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListPromptsError>

impl Client

pub fn list_queue_quick_connects(&self) -> ListQueueQuickConnectsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

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

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

  • quick_connect_summary_list(Option<Vec::<QuickConnectSummary>>):

    Information about the quick connects.

  • last_modified_time(Option<DateTime>):

    The timestamp when this resource was last modified.

  • last_modified_region(Option<String>):

    The Amazon Web Services Region where this resource was last modified.

• On failure, responds with SdkError<ListQueueQuickConnectsError>

impl Client

pub fn list_queues(&self) -> ListQueuesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_types(QueueType) / set_queue_types(Option<Vec::<QueueType>>):
    required: false
    

    The type of queue.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListQueuesOutput with field(s):
  • queue_summary_list(Option<Vec::<QueueSummary>>):

    Information about the queues.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListQueuesError>

impl Client

pub fn list_quick_connects(&self) -> ListQuickConnectsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
  • quick_connect_types(QuickConnectType) / set_quick_connect_types(Option<Vec::<QuickConnectType>>):
    required: false
    

    The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

    
    
• On success, responds with ListQuickConnectsOutput with field(s):
  • quick_connect_summary_list(Option<Vec::<QuickConnectSummary>>):

    Information about the quick connects.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListQuickConnectsError>

impl Client

pub fn list_routing_profile_queues( &self ) -> ListRoutingProfileQueuesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

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

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

  • routing_profile_queue_config_summary_list(Option<Vec::<RoutingProfileQueueConfigSummary>>):

    Information about the routing profiles.

  • last_modified_time(Option<DateTime>):

    The timestamp when this resource was last modified.

  • last_modified_region(Option<String>):

    The Amazon Web Services Region where this resource was last modified.

• On failure, responds with SdkError<ListRoutingProfileQueuesError>

impl Client

pub fn list_routing_profiles(&self) -> ListRoutingProfilesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListRoutingProfilesOutput with field(s):
  • routing_profile_summary_list(Option<Vec::<RoutingProfileSummary>>):

    Information about the routing profiles.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListRoutingProfilesError>

impl Client

pub fn list_rules(&self) -> ListRulesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • publish_status(RulePublishStatus) / set_publish_status(Option<RulePublishStatus>):
    required: false
    

    The publish status of the rule.

    
    
  • event_source_name(EventSourceName) / set_event_source_name(Option<EventSourceName>):
    required: false
    

    The name of the event source.

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

    The maximum number of results to return per page.

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

    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.

    
    
• On success, responds with ListRulesOutput with field(s):
  • rule_summary_list(Vec::<RuleSummary>):

    Summary information about a rule.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListRulesError>

impl Client

pub fn list_security_keys(&self) -> ListSecurityKeysFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListSecurityKeysOutput with field(s):
  • security_keys(Option<Vec::<SecurityKey>>):

    The security keys.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListSecurityKeysError>

impl Client

pub fn list_security_profile_applications( &self ) -> ListSecurityProfileApplicationsFluentBuilder

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

• The fluent builder is configurable:
  • security_profile_id(impl Into<String>) / set_security_profile_id(Option<String>):
    required: true
    

    The identifier for the security profle.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListSecurityProfileApplicationsOutput with field(s):
  • applications(Option<Vec::<Application>>):

    This API is in preview release for Amazon Connect and is subject to change.

    A list of the third-party application’s metadata.

  • next_token(Option<String>):

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

  • last_modified_time(Option<DateTime>):

    The timestamp when this resource was last modified.

  • last_modified_region(Option<String>):

    The Amazon Web Services Region where this resource was last modified.

• On failure, responds with SdkError<ListSecurityProfileApplicationsError>

impl Client

pub fn list_security_profile_permissions( &self ) -> ListSecurityProfilePermissionsFluentBuilder

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

• The fluent builder is configurable:
  • security_profile_id(impl Into<String>) / set_security_profile_id(Option<String>):
    required: true
    

    The identifier for the security profle.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListSecurityProfilePermissionsOutput with field(s):
  • permissions(Option<Vec::<String>>):

    The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.

  • next_token(Option<String>):

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

  • last_modified_time(Option<DateTime>):

    The timestamp when this resource was last modified.

  • last_modified_region(Option<String>):

    The Amazon Web Services Region where this resource was last modified.

• On failure, responds with SdkError<ListSecurityProfilePermissionsError>

impl Client

pub fn list_security_profiles(&self) -> ListSecurityProfilesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListSecurityProfilesOutput with field(s):
  • security_profile_summary_list(Option<Vec::<SecurityProfileSummary>>):

    Information about the security profiles.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListSecurityProfilesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Information about the tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_task_templates(&self) -> ListTaskTemplatesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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.

    It is not expected that you set this because the value returned in the previous response is always null.

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

    The maximum number of results to return per page.

    It is not expected that you set this.

    
    
  • status(TaskTemplateStatus) / set_status(Option<TaskTemplateStatus>):
    required: false
    

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the task template.

    
    
• On success, responds with ListTaskTemplatesOutput with field(s):
  • task_templates(Option<Vec::<TaskTemplateMetadata>>):

    Provides details about a list of task templates belonging to an instance.

  • next_token(Option<String>):

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

    This is always returned as a null in the response.

• On failure, responds with SdkError<ListTaskTemplatesError>

impl Client

pub fn list_traffic_distribution_group_users( &self ) -> ListTrafficDistributionGroupUsersFluentBuilder

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

• The fluent builder is configurable:
  • traffic_distribution_group_id(impl Into<String>) / set_traffic_distribution_group_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

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

    The maximum number of results to return per page.

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

    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.

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

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

  • traffic_distribution_group_user_summary_list(Option<Vec::<TrafficDistributionGroupUserSummary>>):

    A list of traffic distribution group users.

• On failure, responds with SdkError<ListTrafficDistributionGroupUsersError>

impl Client

pub fn list_traffic_distribution_groups( &self ) -> ListTrafficDistributionGroupsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

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

    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.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

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

  • traffic_distribution_group_summary_list(Option<Vec::<TrafficDistributionGroupSummary>>):

    A list of traffic distribution groups.

• On failure, responds with SdkError<ListTrafficDistributionGroupsError>

impl Client

pub fn list_use_cases(&self) -> ListUseCasesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • integration_association_id(impl Into<String>) / set_integration_association_id(Option<String>):
    required: true
    

    The identifier for the integration association.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListUseCasesOutput with field(s):
  • use_case_summary_list(Option<Vec::<UseCase>>):

    The use cases.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListUseCasesError>

impl Client

pub fn list_user_hierarchy_groups(&self) -> ListUserHierarchyGroupsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListUserHierarchyGroupsOutput with field(s):
  • user_hierarchy_group_summary_list(Option<Vec::<HierarchyGroupSummary>>):

    Information about the hierarchy groups.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListUserHierarchyGroupsError>

impl Client

pub fn list_users(&self) -> ListUsersFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListUsersOutput with field(s):
  • user_summary_list(Option<Vec::<UserSummary>>):

    Information about the users.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListUsersError>

impl Client

pub fn list_view_versions(&self) -> ListViewVersionsFluentBuilder

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

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The identifier of the view. Both ViewArn and ViewId can be used.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListViewVersionsOutput with field(s):
  • view_version_summary_list(Option<Vec::<ViewVersionSummary>>):

    A list of view version summaries.

  • 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.

• On failure, responds with SdkError<ListViewVersionsError>

impl Client

pub fn list_views(&self) -> ListViewsFluentBuilder

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

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

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

    
    
  • r#type(ViewType) / set_type(Option<ViewType>):
    required: false
    

    The type of the view.

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

    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>):
    required: false
    

    The maximum number of results to return per page. The default MaxResult size is 100.

    
    
• On success, responds with ListViewsOutput with field(s):
  • views_summary_list(Option<Vec::<ViewSummary>>):

    A list of view summaries.

  • 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.

• On failure, responds with SdkError<ListViewsError>

impl Client

pub fn monitor_contact(&self) -> MonitorContactFluentBuilder

Constructs a fluent builder for the MonitorContact operation.

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

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

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • allowed_monitor_capabilities(MonitorCapability) / set_allowed_monitor_capabilities(Option<Vec::<MonitorCapability>>):
    required: false
    

    Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with MonitorContactOutput with field(s):
  • contact_id(Option<String>):

    The identifier of the contact.

  • contact_arn(Option<String>):

    The ARN of the contact.

• On failure, responds with SdkError<MonitorContactError>

impl Client

pub fn put_user_status(&self) -> PutUserStatusFluentBuilder

Constructs a fluent builder for the PutUserStatus operation.

• The fluent builder is configurable:
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • agent_status_id(impl Into<String>) / set_agent_status_id(Option<String>):
    required: true
    

    The identifier of the agent status.

    
    
• On success, responds with PutUserStatusOutput
• On failure, responds with SdkError<PutUserStatusError>

impl Client

pub fn release_phone_number(&self) -> ReleasePhoneNumberFluentBuilder

Constructs a fluent builder for the ReleasePhoneNumber operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    A unique identifier for the phone number.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with ReleasePhoneNumberOutput
• On failure, responds with SdkError<ReleasePhoneNumberError>

impl Client

pub fn replicate_instance(&self) -> ReplicateInstanceFluentBuilder

Constructs a fluent builder for the ReplicateInstance operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.

    
    
  • replica_region(impl Into<String>) / set_replica_region(Option<String>):
    required: true
    

    The Amazon Web Services Region where to replicate the Amazon Connect instance.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • replica_alias(impl Into<String>) / set_replica_alias(Option<String>):
    required: true
    

    The alias for the replicated instance. The ReplicaAlias must be unique.

    
    
• On success, responds with ReplicateInstanceOutput with field(s):
  • id(Option<String>):

    The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the replicated instance.

• On failure, responds with SdkError<ReplicateInstanceError>

impl Client

pub fn resume_contact_recording(&self) -> ResumeContactRecordingFluentBuilder

Constructs a fluent builder for the ResumeContactRecording operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    
    
• On success, responds with ResumeContactRecordingOutput
• On failure, responds with SdkError<ResumeContactRecordingError>

impl Client

pub fn search_available_phone_numbers( &self ) -> SearchAvailablePhoneNumbersFluentBuilder

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

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

    
    
  • phone_number_country_code(PhoneNumberCountryCode) / set_phone_number_country_code(Option<PhoneNumberCountryCode>):
    required: true
    

    The ISO country code.

    
    
  • phone_number_type(PhoneNumberType) / set_phone_number_type(Option<PhoneNumberType>):
    required: true
    

    The type of phone number.

    
    
  • phone_number_prefix(impl Into<String>) / set_phone_number_prefix(Option<String>):
    required: false
    

    The prefix of the phone number. If provided, it must contain + as part of the country code.

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

    The maximum number of results to return per page.

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

    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.

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

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

  • available_numbers_list(Option<Vec::<AvailableNumberSummary>>):

    A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

• On failure, responds with SdkError<SearchAvailablePhoneNumbersError>

impl Client

pub fn search_hours_of_operations(&self) -> SearchHoursOfOperationsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_filter(HoursOfOperationSearchFilter) / set_search_filter(Option<HoursOfOperationSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
  • search_criteria(HoursOfOperationSearchCriteria) / set_search_criteria(Option<HoursOfOperationSearchCriteria>):
    required: false
    

    The search criteria to be used to return hours of operations.

    
    
• On success, responds with SearchHoursOfOperationsOutput with field(s):
  • hours_of_operations(Option<Vec::<HoursOfOperation>>):

    Information about the hours of operations.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of hours of operations which matched your search query.

• On failure, responds with SdkError<SearchHoursOfOperationsError>

impl Client

pub fn search_prompts(&self) -> SearchPromptsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_filter(PromptSearchFilter) / set_search_filter(Option<PromptSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
  • search_criteria(PromptSearchCriteria) / set_search_criteria(Option<PromptSearchCriteria>):
    required: false
    

    The search criteria to be used to return prompts.

    
    
• On success, responds with SearchPromptsOutput with field(s):
  • prompts(Option<Vec::<Prompt>>):

    Information about the prompts.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of quick connects which matched your search query.

• On failure, responds with SdkError<SearchPromptsError>

impl Client

pub fn search_queues(&self) -> SearchQueuesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_filter(QueueSearchFilter) / set_search_filter(Option<QueueSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
  • search_criteria(QueueSearchCriteria) / set_search_criteria(Option<QueueSearchCriteria>):
    required: false
    

    The search criteria to be used to return queues.

    The name and description fields support “contains” queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    
    
• On success, responds with SearchQueuesOutput with field(s):
  • queues(Option<Vec::<Queue>>):

    Information about the queues.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of queues which matched your search query.

• On failure, responds with SdkError<SearchQueuesError>

impl Client

pub fn search_quick_connects(&self) -> SearchQuickConnectsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_filter(QuickConnectSearchFilter) / set_search_filter(Option<QuickConnectSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
  • search_criteria(QuickConnectSearchCriteria) / set_search_criteria(Option<QuickConnectSearchCriteria>):
    required: false
    

    The search criteria to be used to return quick connects.

    
    
• On success, responds with SearchQuickConnectsOutput with field(s):
  • quick_connects(Option<Vec::<QuickConnect>>):

    Information about the quick connects.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of quick connects which matched your search query.

• On failure, responds with SdkError<SearchQuickConnectsError>

impl Client

pub fn search_resource_tags(&self) -> SearchResourceTagsFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.

    
    
  • resource_types(impl Into<String>) / set_resource_types(Option<Vec::<String>>):
    required: false
    

    The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_criteria(ResourceTagsSearchCriteria) / set_search_criteria(Option<ResourceTagsSearchCriteria>):
    required: false
    

    The search criteria to be used to return tags.

    
    
• On success, responds with SearchResourceTagsOutput with field(s):
  • tags(Option<Vec::<TagSet>>):

    A list of tags used in the Amazon Connect instance.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<SearchResourceTagsError>

impl Client

pub fn search_routing_profiles(&self) -> SearchRoutingProfilesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_filter(RoutingProfileSearchFilter) / set_search_filter(Option<RoutingProfileSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
  • search_criteria(RoutingProfileSearchCriteria) / set_search_criteria(Option<RoutingProfileSearchCriteria>):
    required: false
    

    The search criteria to be used to return routing profiles.

    The name and description fields support “contains” queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    
    
• On success, responds with SearchRoutingProfilesOutput with field(s):
  • routing_profiles(Option<Vec::<RoutingProfile>>):

    Information about the routing profiles.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of routing profiles which matched your search query.

• On failure, responds with SdkError<SearchRoutingProfilesError>

impl Client

pub fn search_security_profiles(&self) -> SearchSecurityProfilesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_criteria(SecurityProfileSearchCriteria) / set_search_criteria(Option<SecurityProfileSearchCriteria>):
    required: false
    

    The search criteria to be used to return security profiles.

    The name field support “contains” queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    The currently supported value for FieldName: name

    
    
  • search_filter(SecurityProfilesSearchFilter) / set_search_filter(Option<SecurityProfilesSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
• On success, responds with SearchSecurityProfilesOutput with field(s):
  • security_profiles(Option<Vec::<SecurityProfileSearchSummary>>):

    Information about the security profiles.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of security profiles which matched your search query.

• On failure, responds with SdkError<SearchSecurityProfilesError>

impl Client

pub fn search_users(&self) -> SearchUsersFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    InstanceID is a required field. The “Required: No” below is incorrect.

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

    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>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • search_filter(UserSearchFilter) / set_search_filter(Option<UserSearchFilter>):
    required: false
    

    Filters to be applied to search results.

    
    
  • search_criteria(UserSearchCriteria) / set_search_criteria(Option<UserSearchCriteria>):
    required: false
    

    The search criteria to be used to return users.

    The name and description fields support “contains” queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

    
    
• On success, responds with SearchUsersOutput with field(s):
  • users(Option<Vec::<UserSearchSummary>>):

    Information about the users.

  • next_token(Option<String>):

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

  • approximate_total_count(Option<i64>):

    The total number of users who matched your search query.

• On failure, responds with SdkError<SearchUsersError>

impl Client

pub fn search_vocabularies(&self) -> SearchVocabulariesFluentBuilder

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

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

    The maximum number of results to return per page.

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

    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.

    
    
  • state(VocabularyState) / set_state(Option<VocabularyState>):
    required: false
    

    The current state of the custom vocabulary.

    
    
  • name_starts_with(impl Into<String>) / set_name_starts_with(Option<String>):
    required: false
    

    The starting pattern of the name of the vocabulary.

    
    
  • language_code(VocabularyLanguageCode) / set_language_code(Option<VocabularyLanguageCode>):
    required: false
    

    The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

    
    
• On success, responds with SearchVocabulariesOutput with field(s):
  • vocabulary_summary_list(Option<Vec::<VocabularySummary>>):

    The list of the available custom vocabularies.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<SearchVocabulariesError>

impl Client

pub fn start_chat_contact(&self) -> StartChatContactFluentBuilder

Constructs a fluent builder for the StartChatContact operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    
    
  • participant_details(ParticipantDetails) / set_participant_details(Option<ParticipantDetails>):
    required: true
    

    Information identifying the participant.

    
    
  • initial_message(ChatMessage) / set_initial_message(Option<ChatMessage>):
    required: false
    

    The initial message to be sent to the newly created chat.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • chat_duration_in_minutes(i32) / set_chat_duration_in_minutes(Option<i32>):
    required: false
    

    The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

    
    
  • supported_messaging_content_types(impl Into<String>) / set_supported_messaging_content_types(Option<Vec::<String>>):
    required: false
    

    The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

    Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

    The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

    
    
  • persistent_chat(PersistentChat) / set_persistent_chat(Option<PersistentChat>):
    required: false
    

    Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

    
    
  • related_contact_id(impl Into<String>) / set_related_contact_id(Option<String>):
    required: false
    

    The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

    You cannot provide data for both RelatedContactId and PersistentChat.

    
    
  • segment_attributes(impl Into<String>, SegmentAttributeValue) / set_segment_attributes(Option<HashMap::<String, SegmentAttributeValue>>):
    required: false
    

    A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

    Attribute keys can include only alphanumeric, -, and _.

    This field can be used to show channel subtype, such as connect:Guide.

    The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as { “connect:Subtype”: {“valueString” : “connect:Guide” }}.

    
    
• On success, responds with StartChatContactOutput with field(s):
  • contact_id(Option<String>):

    The identifier of this contact within the Amazon Connect instance.

  • participant_id(Option<String>):

    The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

  • participant_token(Option<String>):

    The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

  • continued_from_contact_id(Option<String>):

    The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

• On failure, responds with SdkError<StartChatContactError>

impl Client

pub fn start_contact_evaluation(&self) -> StartContactEvaluationFluentBuilder

Constructs a fluent builder for the StartContactEvaluation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact in this instance of Amazon Connect.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    The unique identifier for the evaluation form.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with StartContactEvaluationOutput with field(s):
  • evaluation_id(String):

    A unique identifier for the contact evaluation.

  • evaluation_arn(String):

    The Amazon Resource Name (ARN) for the contact evaluation resource.

• On failure, responds with SdkError<StartContactEvaluationError>

impl Client

pub fn start_contact_recording(&self) -> StartContactRecordingFluentBuilder

Constructs a fluent builder for the StartContactRecording operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    
    
  • voice_recording_configuration(VoiceRecordingConfiguration) / set_voice_recording_configuration(Option<VoiceRecordingConfiguration>):
    required: true
    

    The person being recorded.

    
    
• On success, responds with StartContactRecordingOutput
• On failure, responds with SdkError<StartContactRecordingError>

impl Client

pub fn start_contact_streaming(&self) -> StartContactStreamingFluentBuilder

Constructs a fluent builder for the StartContactStreaming operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    
    
  • chat_streaming_configuration(ChatStreamingConfiguration) / set_chat_streaming_configuration(Option<ChatStreamingConfiguration>):
    required: true
    

    The streaming configuration, such as the Amazon SNS streaming endpoint.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with StartContactStreamingOutput with field(s):
  • streaming_id(String):

    The identifier of the streaming configuration enabled.

• On failure, responds with SdkError<StartContactStreamingError>

impl Client

pub fn start_outbound_voice_contact( &self ) -> StartOutboundVoiceContactFluentBuilder

Constructs a fluent builder for the StartOutboundVoiceContact operation.

• The fluent builder is configurable:
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The phone number of the customer, in E.164 format.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    
    
  • source_phone_number(impl Into<String>) / set_source_phone_number(Option<String>):
    required: false
    

    The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: false
    

    The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    
    
  • answer_machine_detection_config(AnswerMachineDetectionConfig) / set_answer_machine_detection_config(Option<AnswerMachineDetectionConfig>):
    required: false
    

    Configuration of the answering machine detection for this outbound call.

    
    
  • campaign_id(impl Into<String>) / set_campaign_id(Option<String>):
    required: false
    

    The campaign identifier of the outbound communication.

    
    
  • traffic_type(TrafficType) / set_traffic_type(Option<TrafficType>):
    required: false
    

    Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

    
    
• On success, responds with StartOutboundVoiceContactOutput with field(s):
  • contact_id(Option<String>):

    The identifier of this contact within the Amazon Connect instance.

• On failure, responds with SdkError<StartOutboundVoiceContactError>

impl Client

pub fn start_task_contact(&self) -> StartTaskContactFluentBuilder

Constructs a fluent builder for the StartTaskContact operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • previous_contact_id(impl Into<String>) / set_previous_contact_id(Option<String>):
    required: false
    

    The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: false
    

    The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of a task that is shown to an agent in the Contact Control Panel (CCP).

    
    
  • references(impl Into<String>, Reference) / set_references(Option<HashMap::<String, Reference>>):
    required: false
    

    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the task that is shown to an agent in the Contact Control Panel (CCP).

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
  • scheduled_time(DateTime) / set_scheduled_time(Option<DateTime>):
    required: false
    

    The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

    
    
  • task_template_id(impl Into<String>) / set_task_template_id(Option<String>):
    required: false
    

    A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.

    
    
  • quick_connect_id(impl Into<String>) / set_quick_connect_id(Option<String>):
    required: false
    

    The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

    
    
  • related_contact_id(impl Into<String>) / set_related_contact_id(Option<String>):
    required: false
    

    The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

    
    
• On success, responds with StartTaskContactOutput with field(s):
  • contact_id(Option<String>):

    The identifier of this contact within the Amazon Connect instance.

• On failure, responds with SdkError<StartTaskContactError>

impl Client

pub fn stop_contact(&self) -> StopContactFluentBuilder

Constructs a fluent builder for the StopContact operation.

• The fluent builder is configurable:
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The ID of the contact.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • disconnect_reason(DisconnectReason) / set_disconnect_reason(Option<DisconnectReason>):
    required: false
    

    The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.

    
    
• On success, responds with StopContactOutput
• On failure, responds with SdkError<StopContactError>

impl Client

pub fn stop_contact_recording(&self) -> StopContactRecordingFluentBuilder

Constructs a fluent builder for the StopContactRecording operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    
    
• On success, responds with StopContactRecordingOutput
• On failure, responds with SdkError<StopContactRecordingError>

impl Client

pub fn stop_contact_streaming(&self) -> StopContactStreamingFluentBuilder

Constructs a fluent builder for the StopContactStreaming operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

    
    
  • streaming_id(impl Into<String>) / set_streaming_id(Option<String>):
    required: true
    

    The identifier of the streaming configuration enabled.

    
    
• On success, responds with StopContactStreamingOutput
• On failure, responds with SdkError<StopContactStreamingError>

impl Client

pub fn submit_contact_evaluation(&self) -> SubmitContactEvaluationFluentBuilder

Constructs a fluent builder for the SubmitContactEvaluation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_id(impl Into<String>) / set_evaluation_id(Option<String>):
    required: true
    

    A unique identifier for the contact evaluation.

    
    
  • answers(impl Into<String>, EvaluationAnswerInput) / set_answers(Option<HashMap::<String, EvaluationAnswerInput>>):
    required: false
    

    A map of question identifiers to answer value.

    
    
  • notes(impl Into<String>, EvaluationNote) / set_notes(Option<HashMap::<String, EvaluationNote>>):
    required: false
    

    A map of question identifiers to note value.

    
    
• On success, responds with SubmitContactEvaluationOutput with field(s):
  • evaluation_id(String):

    A unique identifier for the contact evaluation.

  • evaluation_arn(String):

    The Amazon Resource Name (ARN) for the contact evaluation resource.

• On failure, responds with SdkError<SubmitContactEvaluationError>

impl Client

pub fn suspend_contact_recording(&self) -> SuspendContactRecordingFluentBuilder

Constructs a fluent builder for the SuspendContactRecording operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    
    
• On success, responds with SuspendContactRecordingOutput
• On failure, responds with SdkError<SuspendContactRecordingError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn transfer_contact(&self) -> TransferContactFluentBuilder

Constructs a fluent builder for the TransferContact operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact in this instance of Amazon Connect.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: false
    

    The identifier for the queue.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The identifier for the user. This can be the ID or the ARN of the user.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with TransferContactOutput with field(s):
  • contact_id(Option<String>):

    The identifier of the contact in this instance of Amazon Connect.

  • contact_arn(Option<String>):

    The Amazon Resource Name (ARN) of the contact.

• On failure, responds with SdkError<TransferContactError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_agent_status(&self) -> UpdateAgentStatusFluentBuilder

Constructs a fluent builder for the UpdateAgentStatus operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • agent_status_id(impl Into<String>) / set_agent_status_id(Option<String>):
    required: true
    

    The identifier of the agent status.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the agent status.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the agent status.

    
    
  • state(AgentStatusState) / set_state(Option<AgentStatusState>):
    required: false
    

    The state of the agent status.

    
    
  • display_order(i32) / set_display_order(Option<i32>):
    required: false
    

    The display order of the agent status.

    
    
  • reset_order_number(bool) / set_reset_order_number(Option<bool>):
    required: false
    

    A number indicating the reset order of the agent status.

    
    
• On success, responds with UpdateAgentStatusOutput
• On failure, responds with SdkError<UpdateAgentStatusError>

impl Client

pub fn update_contact(&self) -> UpdateContactFluentBuilder

Constructs a fluent builder for the UpdateContact operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the contact.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the contact.

    
    
  • references(impl Into<String>, Reference) / set_references(Option<HashMap::<String, Reference>>):
    required: false
    

    Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

    
    
• On success, responds with UpdateContactOutput
• On failure, responds with SdkError<UpdateContactError>

impl Client

pub fn update_contact_attributes(&self) -> UpdateContactAttributesFluentBuilder

Constructs a fluent builder for the UpdateContactAttributes operation.

• The fluent builder is configurable:
  • initial_contact_id(impl Into<String>) / set_initial_contact_id(Option<String>):
    required: true
    

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: true
    

    The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.

    You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    
    
• On success, responds with UpdateContactAttributesOutput
• On failure, responds with SdkError<UpdateContactAttributesError>

impl Client

pub fn update_contact_evaluation(&self) -> UpdateContactEvaluationFluentBuilder

Constructs a fluent builder for the UpdateContactEvaluation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_id(impl Into<String>) / set_evaluation_id(Option<String>):
    required: true
    

    A unique identifier for the contact evaluation.

    
    
  • answers(impl Into<String>, EvaluationAnswerInput) / set_answers(Option<HashMap::<String, EvaluationAnswerInput>>):
    required: false
    

    A map of question identifiers to answer value.

    
    
  • notes(impl Into<String>, EvaluationNote) / set_notes(Option<HashMap::<String, EvaluationNote>>):
    required: false
    

    A map of question identifiers to note value.

    
    
• On success, responds with UpdateContactEvaluationOutput with field(s):
  • evaluation_id(String):

    A unique identifier for the contact evaluation.

  • evaluation_arn(String):

    The Amazon Resource Name (ARN) for the contact evaluation resource.

• On failure, responds with SdkError<UpdateContactEvaluationError>

impl Client

pub fn update_contact_flow_content( &self ) -> UpdateContactFlowContentFluentBuilder

Constructs a fluent builder for the UpdateContactFlowContent operation.

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

    The identifier of the Amazon Connect instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

    Length Constraints: Minimum length of 1. Maximum length of 256000.

    
    
• On success, responds with UpdateContactFlowContentOutput
• On failure, responds with SdkError<UpdateContactFlowContentError>

impl Client

pub fn update_contact_flow_metadata( &self ) -> UpdateContactFlowMetadataFluentBuilder

Constructs a fluent builder for the UpdateContactFlowMetadata operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the flow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the flow.

    
    
  • contact_flow_state(ContactFlowState) / set_contact_flow_state(Option<ContactFlowState>):
    required: false
    

    The state of flow.

    
    
• On success, responds with UpdateContactFlowMetadataOutput
• On failure, responds with SdkError<UpdateContactFlowMetadataError>

impl Client

pub fn update_contact_flow_module_content( &self ) -> UpdateContactFlowModuleContentFluentBuilder

Constructs a fluent builder for the UpdateContactFlowModuleContent operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_module_id(impl Into<String>) / set_contact_flow_module_id(Option<String>):
    required: true
    

    The identifier of the flow module.

    
    
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

    
    
• On success, responds with UpdateContactFlowModuleContentOutput
• On failure, responds with SdkError<UpdateContactFlowModuleContentError>

impl Client

pub fn update_contact_flow_module_metadata( &self ) -> UpdateContactFlowModuleMetadataFluentBuilder

Constructs a fluent builder for the UpdateContactFlowModuleMetadata operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_flow_module_id(impl Into<String>) / set_contact_flow_module_id(Option<String>):
    required: true
    

    The identifier of the flow module.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the flow module.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the flow module.

    
    
  • state(ContactFlowModuleState) / set_state(Option<ContactFlowModuleState>):
    required: false
    

    The state of flow module.

    
    
• On success, responds with UpdateContactFlowModuleMetadataOutput
• On failure, responds with SdkError<UpdateContactFlowModuleMetadataError>

impl Client

pub fn update_contact_flow_name(&self) -> UpdateContactFlowNameFluentBuilder

Constructs a fluent builder for the UpdateContactFlowName operation.

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

    The identifier of the Amazon Connect instance.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: true
    

    The identifier of the flow.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the flow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the flow.

    
    
• On success, responds with UpdateContactFlowNameOutput
• On failure, responds with SdkError<UpdateContactFlowNameError>

impl Client

pub fn update_contact_schedule(&self) -> UpdateContactScheduleFluentBuilder

Constructs a fluent builder for the UpdateContactSchedule operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact.

    
    
  • scheduled_time(DateTime) / set_scheduled_time(Option<DateTime>):
    required: true
    

    The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

    
    
• On success, responds with UpdateContactScheduleOutput
• On failure, responds with SdkError<UpdateContactScheduleError>

impl Client

pub fn update_evaluation_form(&self) -> UpdateEvaluationFormFluentBuilder

Constructs a fluent builder for the UpdateEvaluationForm operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • evaluation_form_id(impl Into<String>) / set_evaluation_form_id(Option<String>):
    required: true
    

    The unique identifier for the evaluation form.

    
    
  • evaluation_form_version(i32) / set_evaluation_form_version(Option<i32>):
    required: true
    

    A version of the evaluation form to update.

    
    
  • create_new_version(bool) / set_create_new_version(Option<bool>):
    required: false
    

    A flag indicating whether the operation must create a new version.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    A title of the evaluation form.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the evaluation form.

    
    
  • items(EvaluationFormItem) / set_items(Option<Vec::<EvaluationFormItem>>):
    required: true
    

    Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

    
    
  • scoring_strategy(EvaluationFormScoringStrategy) / set_scoring_strategy(Option<EvaluationFormScoringStrategy>):
    required: false
    

    A scoring strategy of the evaluation form.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with UpdateEvaluationFormOutput with field(s):
  • evaluation_form_id(String):

    The unique identifier for the evaluation form.

  • evaluation_form_arn(String):

    The Amazon Resource Name (ARN) for the contact evaluation resource.

  • evaluation_form_version(i32):

    The version of the updated evaluation form resource.

• On failure, responds with SdkError<UpdateEvaluationFormError>

impl Client

pub fn update_hours_of_operation(&self) -> UpdateHoursOfOperationFluentBuilder

Constructs a fluent builder for the UpdateHoursOfOperation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • hours_of_operation_id(impl Into<String>) / set_hours_of_operation_id(Option<String>):
    required: true
    

    The identifier of the hours of operation.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the hours of operation.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the hours of operation.

    
    
  • time_zone(impl Into<String>) / set_time_zone(Option<String>):
    required: false
    

    The time zone of the hours of operation.

    
    
  • config(HoursOfOperationConfig) / set_config(Option<Vec::<HoursOfOperationConfig>>):
    required: false
    

    Configuration information of the hours of operation.

    
    
• On success, responds with UpdateHoursOfOperationOutput
• On failure, responds with SdkError<UpdateHoursOfOperationError>

impl Client

pub fn update_instance_attribute(&self) -> UpdateInstanceAttributeFluentBuilder

Constructs a fluent builder for the UpdateInstanceAttribute operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • attribute_type(InstanceAttributeType) / set_attribute_type(Option<InstanceAttributeType>):
    required: true
    

    The type of attribute.

    Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.

    
    
  • value(impl Into<String>) / set_value(Option<String>):
    required: true
    

    The value for the attribute. Maximum character limit is 100.

    
    
• On success, responds with UpdateInstanceAttributeOutput
• On failure, responds with SdkError<UpdateInstanceAttributeError>

impl Client

pub fn update_instance_storage_config( &self ) -> UpdateInstanceStorageConfigFluentBuilder

Constructs a fluent builder for the UpdateInstanceStorageConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    
    
  • resource_type(InstanceStorageResourceType) / set_resource_type(Option<InstanceStorageResourceType>):
    required: true
    

    A valid resource type.

    
    
  • storage_config(InstanceStorageConfig) / set_storage_config(Option<InstanceStorageConfig>):
    required: true
    

    The storage configuration for the instance.

    
    
• On success, responds with UpdateInstanceStorageConfigOutput
• On failure, responds with SdkError<UpdateInstanceStorageConfigError>

impl Client

pub fn update_participant_role_config( &self ) -> UpdateParticipantRoleConfigFluentBuilder

Constructs a fluent builder for the UpdateParticipantRoleConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    The identifier of the contact in this instance of Amazon Connect.

    
    
  • channel_configuration(UpdateParticipantRoleConfigChannelInfo) / set_channel_configuration(Option<UpdateParticipantRoleConfigChannelInfo>):
    required: true
    

    The Amazon Connect channel you want to configure.

    
    
• On success, responds with UpdateParticipantRoleConfigOutput
• On failure, responds with SdkError<UpdateParticipantRoleConfigError>

impl Client

pub fn update_phone_number(&self) -> UpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumber operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    A unique identifier for the phone number.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with UpdatePhoneNumberOutput with field(s):
  • phone_number_id(Option<String>):

    A unique identifier for the phone number.

  • phone_number_arn(Option<String>):

    The Amazon Resource Name (ARN) of the phone number.

• On failure, responds with SdkError<UpdatePhoneNumberError>

impl Client

pub fn update_phone_number_metadata( &self ) -> UpdatePhoneNumberMetadataFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumberMetadata operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) or resource ID of the phone number.

    
    
  • phone_number_description(impl Into<String>) / set_phone_number_description(Option<String>):
    required: false
    

    The description of the phone number.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    
    
• On success, responds with UpdatePhoneNumberMetadataOutput
• On failure, responds with SdkError<UpdatePhoneNumberMetadataError>

impl Client

pub fn update_prompt(&self) -> UpdatePromptFluentBuilder

Constructs a fluent builder for the UpdatePrompt operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • prompt_id(impl Into<String>) / set_prompt_id(Option<String>):
    required: true
    

    A unique identifier for the prompt.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the prompt.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the prompt.

    
    
  • s3_uri(impl Into<String>) / set_s3_uri(Option<String>):
    required: false
    

    The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

    
    
• On success, responds with UpdatePromptOutput with field(s):
  • prompt_arn(Option<String>):

    The Amazon Resource Name (ARN) of the prompt.

  • prompt_id(Option<String>):

    A unique identifier for the prompt.

• On failure, responds with SdkError<UpdatePromptError>

impl Client

pub fn update_queue_hours_of_operation( &self ) -> UpdateQueueHoursOfOperationFluentBuilder

Constructs a fluent builder for the UpdateQueueHoursOfOperation operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • hours_of_operation_id(impl Into<String>) / set_hours_of_operation_id(Option<String>):
    required: true
    

    The identifier for the hours of operation.

    
    
• On success, responds with UpdateQueueHoursOfOperationOutput
• On failure, responds with SdkError<UpdateQueueHoursOfOperationError>

impl Client

pub fn update_queue_max_contacts(&self) -> UpdateQueueMaxContactsFluentBuilder

Constructs a fluent builder for the UpdateQueueMaxContacts operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • max_contacts(i32) / set_max_contacts(Option<i32>):
    required: false
    

    The maximum number of contacts that can be in the queue before it is considered full.

    
    
• On success, responds with UpdateQueueMaxContactsOutput
• On failure, responds with SdkError<UpdateQueueMaxContactsError>

impl Client

pub fn update_queue_name(&self) -> UpdateQueueNameFluentBuilder

Constructs a fluent builder for the UpdateQueueName operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the queue.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the queue.

    
    
• On success, responds with UpdateQueueNameOutput
• On failure, responds with SdkError<UpdateQueueNameError>

impl Client

pub fn update_queue_outbound_caller_config( &self ) -> UpdateQueueOutboundCallerConfigFluentBuilder

Constructs a fluent builder for the UpdateQueueOutboundCallerConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • outbound_caller_config(OutboundCallerConfig) / set_outbound_caller_config(Option<OutboundCallerConfig>):
    required: true
    

    The outbound caller ID name, number, and outbound whisper flow.

    
    
• On success, responds with UpdateQueueOutboundCallerConfigOutput
• On failure, responds with SdkError<UpdateQueueOutboundCallerConfigError>

impl Client

pub fn update_queue_status(&self) -> UpdateQueueStatusFluentBuilder

Constructs a fluent builder for the UpdateQueueStatus operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • queue_id(impl Into<String>) / set_queue_id(Option<String>):
    required: true
    

    The identifier for the queue.

    
    
  • status(QueueStatus) / set_status(Option<QueueStatus>):
    required: true
    

    The status of the queue.

    
    
• On success, responds with UpdateQueueStatusOutput
• On failure, responds with SdkError<UpdateQueueStatusError>

impl Client

pub fn update_quick_connect_config( &self ) -> UpdateQuickConnectConfigFluentBuilder

Constructs a fluent builder for the UpdateQuickConnectConfig operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • quick_connect_id(impl Into<String>) / set_quick_connect_id(Option<String>):
    required: true
    

    The identifier for the quick connect.

    
    
  • quick_connect_config(QuickConnectConfig) / set_quick_connect_config(Option<QuickConnectConfig>):
    required: true
    

    Information about the configuration settings for the quick connect.

    
    
• On success, responds with UpdateQuickConnectConfigOutput
• On failure, responds with SdkError<UpdateQuickConnectConfigError>

impl Client

pub fn update_quick_connect_name(&self) -> UpdateQuickConnectNameFluentBuilder

Constructs a fluent builder for the UpdateQuickConnectName operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • quick_connect_id(impl Into<String>) / set_quick_connect_id(Option<String>):
    required: true
    

    The identifier for the quick connect.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the quick connect.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the quick connect.

    
    
• On success, responds with UpdateQuickConnectNameOutput
• On failure, responds with SdkError<UpdateQuickConnectNameError>

impl Client

pub fn update_routing_profile_agent_availability_timer( &self ) -> UpdateRoutingProfileAgentAvailabilityTimerFluentBuilder

Constructs a fluent builder for the UpdateRoutingProfileAgentAvailabilityTimer operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • agent_availability_timer(AgentAvailabilityTimer) / set_agent_availability_timer(Option<AgentAvailabilityTimer>):
    required: true
    

    Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

    
    
• On success, responds with UpdateRoutingProfileAgentAvailabilityTimerOutput
• On failure, responds with SdkError<UpdateRoutingProfileAgentAvailabilityTimerError>

impl Client

pub fn update_routing_profile_concurrency( &self ) -> UpdateRoutingProfileConcurrencyFluentBuilder

Constructs a fluent builder for the UpdateRoutingProfileConcurrency operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • media_concurrencies(MediaConcurrency) / set_media_concurrencies(Option<Vec::<MediaConcurrency>>):
    required: true
    

    The channels that agents can handle in the Contact Control Panel (CCP).

    
    
• On success, responds with UpdateRoutingProfileConcurrencyOutput
• On failure, responds with SdkError<UpdateRoutingProfileConcurrencyError>

impl Client

pub fn update_routing_profile_default_outbound_queue( &self ) -> UpdateRoutingProfileDefaultOutboundQueueFluentBuilder

Constructs a fluent builder for the UpdateRoutingProfileDefaultOutboundQueue operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • default_outbound_queue_id(impl Into<String>) / set_default_outbound_queue_id(Option<String>):
    required: true
    

    The identifier for the default outbound queue.

    
    
• On success, responds with UpdateRoutingProfileDefaultOutboundQueueOutput
• On failure, responds with SdkError<UpdateRoutingProfileDefaultOutboundQueueError>

impl Client

pub fn update_routing_profile_name( &self ) -> UpdateRoutingProfileNameFluentBuilder

Constructs a fluent builder for the UpdateRoutingProfileName operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the routing profile. Must not be more than 127 characters.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the routing profile. Must not be more than 250 characters.

    
    
• On success, responds with UpdateRoutingProfileNameOutput
• On failure, responds with SdkError<UpdateRoutingProfileNameError>

impl Client

pub fn update_routing_profile_queues( &self ) -> UpdateRoutingProfileQueuesFluentBuilder

Constructs a fluent builder for the UpdateRoutingProfileQueues operation.

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

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile.

    
    
  • queue_configs(RoutingProfileQueueConfig) / set_queue_configs(Option<Vec::<RoutingProfileQueueConfig>>):
    required: true
    

    The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.

    
    
• On success, responds with UpdateRoutingProfileQueuesOutput
• On failure, responds with SdkError<UpdateRoutingProfileQueuesError>

impl Client

pub fn update_rule(&self) -> UpdateRuleFluentBuilder

Constructs a fluent builder for the UpdateRule operation.

• The fluent builder is configurable:
  • rule_id(impl Into<String>) / set_rule_id(Option<String>):
    required: true
    

    A unique identifier for the rule.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

    
    
  • function(impl Into<String>) / set_function(Option<String>):
    required: true
    

    The conditions of the rule.

    
    
  • actions(RuleAction) / set_actions(Option<Vec::<RuleAction>>):
    required: true
    

    A list of actions to be run when the rule is triggered.

    
    
  • publish_status(RulePublishStatus) / set_publish_status(Option<RulePublishStatus>):
    required: true
    

    The publish status of the rule.

    
    
• On success, responds with UpdateRuleOutput
• On failure, responds with SdkError<UpdateRuleError>

impl Client

pub fn update_security_profile(&self) -> UpdateSecurityProfileFluentBuilder

Constructs a fluent builder for the UpdateSecurityProfile operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the security profile.

    
    
  • permissions(impl Into<String>) / set_permissions(Option<Vec::<String>>):
    required: false
    

    The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.

    
    
  • security_profile_id(impl Into<String>) / set_security_profile_id(Option<String>):
    required: true
    

    The identifier for the security profle.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • allowed_access_control_tags(impl Into<String>, impl Into<String>) / set_allowed_access_control_tags(Option<HashMap::<String, String>>):
    required: false
    

    The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

    
    
  • tag_restricted_resources(impl Into<String>) / set_tag_restricted_resources(Option<Vec::<String>>):
    required: false
    

    The list of resources that a security profile applies tag restrictions to in Amazon Connect.

    
    
  • applications(Application) / set_applications(Option<Vec::<Application>>):
    required: false
    

    This API is in preview release for Amazon Connect and is subject to change.

    A list of the third-party application’s metadata.

    
    
• On success, responds with UpdateSecurityProfileOutput
• On failure, responds with SdkError<UpdateSecurityProfileError>

impl Client

pub fn update_task_template(&self) -> UpdateTaskTemplateFluentBuilder

Constructs a fluent builder for the UpdateTaskTemplate operation.

• The fluent builder is configurable:
  • task_template_id(impl Into<String>) / set_task_template_id(Option<String>):
    required: true
    

    A unique identifier for the task template.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the task template.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the task template.

    
    
  • contact_flow_id(impl Into<String>) / set_contact_flow_id(Option<String>):
    required: false
    

    The identifier of the flow that runs by default when a task is created by referencing this template.

    
    
  • constraints(TaskTemplateConstraints) / set_constraints(Option<TaskTemplateConstraints>):
    required: false
    

    Constraints that are applicable to the fields listed.

    
    
  • defaults(TaskTemplateDefaults) / set_defaults(Option<TaskTemplateDefaults>):
    required: false
    

    The default values for fields when a task is created by referencing this template.

    
    
  • status(TaskTemplateStatus) / set_status(Option<TaskTemplateStatus>):
    required: false
    

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

    
    
  • fields(TaskTemplateField) / set_fields(Option<Vec::<TaskTemplateField>>):
    required: false
    

    Fields that are part of the template.

    
    
• On success, responds with UpdateTaskTemplateOutput with field(s):
  • instance_id(Option<String>):

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • id(Option<String>):

    The identifier of the task template resource.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the task template resource.

  • name(Option<String>):

    The name of the task template.

  • description(Option<String>):

    The description of the task template.

  • contact_flow_id(Option<String>):

    The identifier of the flow that runs by default when a task is created by referencing this template.

  • constraints(Option<TaskTemplateConstraints>):

    Constraints that are applicable to the fields listed.

  • defaults(Option<TaskTemplateDefaults>):

    The default values for fields when a task is created by referencing this template.

  • fields(Option<Vec::<TaskTemplateField>>):

    Fields that are part of the template.

  • status(Option<TaskTemplateStatus>):

    Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

  • last_modified_time(Option<DateTime>):

    The timestamp when the task template was last modified.

  • created_time(Option<DateTime>):

    The timestamp when the task template was created.

• On failure, responds with SdkError<UpdateTaskTemplateError>

impl Client

pub fn update_traffic_distribution( &self ) -> UpdateTrafficDistributionFluentBuilder

Constructs a fluent builder for the UpdateTrafficDistribution operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

    
    
  • telephony_config(TelephonyConfig) / set_telephony_config(Option<TelephonyConfig>):
    required: false
    

    The distribution of traffic between the instance and its replica(s).

    
    
  • sign_in_config(SignInConfig) / set_sign_in_config(Option<SignInConfig>):
    required: false
    

    The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

    
    
  • agent_config(AgentConfig) / set_agent_config(Option<AgentConfig>):
    required: false
    

    The distribution of agents between the instance and its replica(s).

    
    
• On success, responds with UpdateTrafficDistributionOutput
• On failure, responds with SdkError<UpdateTrafficDistributionError>

impl Client

pub fn update_user_hierarchy(&self) -> UpdateUserHierarchyFluentBuilder

Constructs a fluent builder for the UpdateUserHierarchy operation.

• The fluent builder is configurable:
  • hierarchy_group_id(impl Into<String>) / set_hierarchy_group_id(Option<String>):
    required: false
    

    The identifier of the hierarchy group.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserHierarchyOutput
• On failure, responds with SdkError<UpdateUserHierarchyError>

impl Client

pub fn update_user_hierarchy_group_name( &self ) -> UpdateUserHierarchyGroupNameFluentBuilder

Constructs a fluent builder for the UpdateUserHierarchyGroupName operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the hierarchy group. Must not be more than 100 characters.

    
    
  • hierarchy_group_id(impl Into<String>) / set_hierarchy_group_id(Option<String>):
    required: true
    

    The identifier of the hierarchy group.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserHierarchyGroupNameOutput
• On failure, responds with SdkError<UpdateUserHierarchyGroupNameError>

impl Client

pub fn update_user_hierarchy_structure( &self ) -> UpdateUserHierarchyStructureFluentBuilder

Constructs a fluent builder for the UpdateUserHierarchyStructure operation.

• The fluent builder is configurable:
  • hierarchy_structure(HierarchyStructureUpdate) / set_hierarchy_structure(Option<HierarchyStructureUpdate>):
    required: true
    

    The hierarchy levels to update.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserHierarchyStructureOutput
• On failure, responds with SdkError<UpdateUserHierarchyStructureError>

impl Client

pub fn update_user_identity_info(&self) -> UpdateUserIdentityInfoFluentBuilder

Constructs a fluent builder for the UpdateUserIdentityInfo operation.

• The fluent builder is configurable:
  • identity_info(UserIdentityInfo) / set_identity_info(Option<UserIdentityInfo>):
    required: true
    

    The identity information for the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserIdentityInfoOutput
• On failure, responds with SdkError<UpdateUserIdentityInfoError>

impl Client

pub fn update_user_phone_config(&self) -> UpdateUserPhoneConfigFluentBuilder

Constructs a fluent builder for the UpdateUserPhoneConfig operation.

• The fluent builder is configurable:
  • phone_config(UserPhoneConfig) / set_phone_config(Option<UserPhoneConfig>):
    required: true
    

    Information about phone configuration settings for the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserPhoneConfigOutput
• On failure, responds with SdkError<UpdateUserPhoneConfigError>

impl Client

pub fn update_user_routing_profile( &self ) -> UpdateUserRoutingProfileFluentBuilder

Constructs a fluent builder for the UpdateUserRoutingProfile operation.

• The fluent builder is configurable:
  • routing_profile_id(impl Into<String>) / set_routing_profile_id(Option<String>):
    required: true
    

    The identifier of the routing profile for the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserRoutingProfileOutput
• On failure, responds with SdkError<UpdateUserRoutingProfileError>

impl Client

pub fn update_user_security_profiles( &self ) -> UpdateUserSecurityProfilesFluentBuilder

Constructs a fluent builder for the UpdateUserSecurityProfiles operation.

• The fluent builder is configurable:
  • security_profile_ids(impl Into<String>) / set_security_profile_ids(Option<Vec::<String>>):
    required: true
    

    The identifiers of the security profiles for the user.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user account.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    
    
• On success, responds with UpdateUserSecurityProfilesOutput
• On failure, responds with SdkError<UpdateUserSecurityProfilesError>

impl Client

pub fn update_view_content(&self) -> UpdateViewContentFluentBuilder

Constructs a fluent builder for the UpdateViewContent operation.

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The identifier of the view. Both ViewArn and ViewId can be used.

    
    
  • status(ViewStatus) / set_status(Option<ViewStatus>):
    required: true
    

    Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

    
    
  • content(ViewInputContent) / set_content(Option<ViewInputContent>):
    required: true
    

    View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.

    The total uncompressed content has a maximum file size of 400kB.

    
    
• On success, responds with UpdateViewContentOutput with field(s):
  • view(Option<View>):

    A view resource object. Contains metadata and content necessary to render the view.

• On failure, responds with SdkError<UpdateViewContentError>

impl Client

pub fn update_view_metadata(&self) -> UpdateViewMetadataFluentBuilder

Constructs a fluent builder for the UpdateViewMetadata operation.

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

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

    
    
  • view_id(impl Into<String>) / set_view_id(Option<String>):
    required: true
    

    The identifier of the view. Both ViewArn and ViewId can be used.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the view.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the view.

    
    
• On success, responds with UpdateViewMetadataOutput
• On failure, responds with SdkError<UpdateViewMetadataError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.