Struct aws_sdk_connect::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon Connect Service
Client for invoking operations on Amazon Connect Service. Each operation on Amazon Connect Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_connect::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_connect::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_connect::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_approved_origin(&self) -> AssociateApprovedOrigin
pub fn associate_approved_origin(&self) -> AssociateApprovedOrigin
Constructs a fluent builder for the AssociateApprovedOrigin
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
origin(impl Into<String>)
/set_origin(Option<String>)
:The domain to add to your allow list.
- On success, responds with
AssociateApprovedOriginOutput
- On failure, responds with
SdkError<AssociateApprovedOriginError>
sourcepub fn associate_bot(&self) -> AssociateBot
pub fn associate_bot(&self) -> AssociateBot
Constructs a fluent builder for the AssociateBot
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
lex_bot(LexBot)
/set_lex_bot(Option<LexBot>)
:Configuration information of an Amazon Lex bot.
lex_v2_bot(LexV2Bot)
/set_lex_v2_bot(Option<LexV2Bot>)
:The Amazon Lex V2 bot to associate with the instance.
- On success, responds with
AssociateBotOutput
- On failure, responds with
SdkError<AssociateBotError>
sourcepub fn associate_default_vocabulary(&self) -> AssociateDefaultVocabulary
pub fn associate_default_vocabulary(&self) -> AssociateDefaultVocabulary
Constructs a fluent builder for the AssociateDefaultVocabulary
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
language_code(VocabularyLanguageCode)
/set_language_code(Option<VocabularyLanguageCode>)
: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>)
: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>
sourcepub fn associate_instance_storage_config(
&self
) -> AssociateInstanceStorageConfig
pub fn associate_instance_storage_config(
&self
) -> AssociateInstanceStorageConfig
Constructs a fluent builder for the AssociateInstanceStorageConfig
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
resource_type(InstanceStorageResourceType)
/set_resource_type(Option<InstanceStorageResourceType>)
:A valid resource type.
storage_config(InstanceStorageConfig)
/set_storage_config(Option<InstanceStorageConfig>)
: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>
sourcepub fn associate_lambda_function(&self) -> AssociateLambdaFunction
pub fn associate_lambda_function(&self) -> AssociateLambdaFunction
Constructs a fluent builder for the AssociateLambdaFunction
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
function_arn(impl Into<String>)
/set_function_arn(Option<String>)
: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>
sourcepub fn associate_lex_bot(&self) -> AssociateLexBot
pub fn associate_lex_bot(&self) -> AssociateLexBot
Constructs a fluent builder for the AssociateLexBot
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
lex_bot(LexBot)
/set_lex_bot(Option<LexBot>)
:The Amazon Lex bot to associate with the instance.
- On success, responds with
AssociateLexBotOutput
- On failure, responds with
SdkError<AssociateLexBotError>
sourcepub fn associate_phone_number_contact_flow(
&self
) -> AssociatePhoneNumberContactFlow
pub fn associate_phone_number_contact_flow(
&self
) -> AssociatePhoneNumberContactFlow
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>)
:A unique identifier for the phone number.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
- On success, responds with
AssociatePhoneNumberContactFlowOutput
- On failure, responds with
SdkError<AssociatePhoneNumberContactFlowError>
sourcepub fn associate_queue_quick_connects(&self) -> AssociateQueueQuickConnects
pub fn associate_queue_quick_connects(&self) -> AssociateQueueQuickConnects
Constructs a fluent builder for the AssociateQueueQuickConnects
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
quick_connect_ids(Vec<String>)
/set_quick_connect_ids(Option<Vec<String>>)
:The quick connects to associate with this queue.
- On success, responds with
AssociateQueueQuickConnectsOutput
- On failure, responds with
SdkError<AssociateQueueQuickConnectsError>
sourcepub fn associate_routing_profile_queues(&self) -> AssociateRoutingProfileQueues
pub fn associate_routing_profile_queues(&self) -> AssociateRoutingProfileQueues
Constructs a fluent builder for the AssociateRoutingProfileQueues
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
queue_configs(Vec<RoutingProfileQueueConfig>)
/set_queue_configs(Option<Vec<RoutingProfileQueueConfig>>)
:The queues to associate with this routing profile.
- On success, responds with
AssociateRoutingProfileQueuesOutput
- On failure, responds with
SdkError<AssociateRoutingProfileQueuesError>
sourcepub fn associate_security_key(&self) -> AssociateSecurityKey
pub fn associate_security_key(&self) -> AssociateSecurityKey
Constructs a fluent builder for the AssociateSecurityKey
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
key(impl Into<String>)
/set_key(Option<String>)
: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>
sourcepub fn claim_phone_number(&self) -> ClaimPhoneNumber
pub fn claim_phone_number(&self) -> ClaimPhoneNumber
Constructs a fluent builder for the ClaimPhoneNumber
operation.
- The fluent builder is configurable:
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
phone_number(impl Into<String>)
/set_phone_number(Option<String>)
: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>)
:The description of the phone number.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- 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>
sourcepub fn create_agent_status(&self) -> CreateAgentStatus
pub fn create_agent_status(&self) -> CreateAgentStatus
Constructs a fluent builder for the CreateAgentStatus
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the status.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the status.
state(AgentStatusState)
/set_state(Option<AgentStatusState>)
:The state of the status.
display_order(i32)
/set_display_order(Option<i32>)
:The display order of the status.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_contact_flow(&self) -> CreateContactFlow
pub fn create_contact_flow(&self) -> CreateContactFlow
Constructs a fluent builder for the CreateContactFlow
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the contact flow.
r#type(ContactFlowType)
/set_type(Option<ContactFlowType>)
:The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the contact flow.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the contact flow.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:One or more tags.
- On success, responds with
CreateContactFlowOutput
with field(s):contact_flow_id(Option<String>)
:The identifier of the contact flow.
contact_flow_arn(Option<String>)
:The Amazon Resource Name (ARN) of the contact flow.
- On failure, responds with
SdkError<CreateContactFlowError>
sourcepub fn create_contact_flow_module(&self) -> CreateContactFlowModule
pub fn create_contact_flow_module(&self) -> CreateContactFlowModule
Constructs a fluent builder for the CreateContactFlowModule
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the contact flow module.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the contact flow module.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the contact flow module.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
CreateContactFlowModuleOutput
with field(s):id(Option<String>)
:The identifier of the contact flow module.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the contact flow module.
- On failure, responds with
SdkError<CreateContactFlowModuleError>
sourcepub fn create_hours_of_operation(&self) -> CreateHoursOfOperation
pub fn create_hours_of_operation(&self) -> CreateHoursOfOperation
Constructs a fluent builder for the CreateHoursOfOperation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the hours of operation.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the hours of operation.
time_zone(impl Into<String>)
/set_time_zone(Option<String>)
:The time zone of the hours of operation.
config(Vec<HoursOfOperationConfig>)
/set_config(Option<Vec<HoursOfOperationConfig>>)
:Configuration information for the hours of operation: day, start time, and end time.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_instance(&self) -> CreateInstance
pub fn create_instance(&self) -> CreateInstance
Constructs a fluent builder for the CreateInstance
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The idempotency token.
identity_management_type(DirectoryType)
/set_identity_management_type(Option<DirectoryType>)
:The type of identity management for your Amazon Connect users.
instance_alias(impl Into<String>)
/set_instance_alias(Option<String>)
:The name for your instance.
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier for the directory.
inbound_calls_enabled(bool)
/set_inbound_calls_enabled(Option<bool>)
:Your contact center handles incoming contacts.
outbound_calls_enabled(bool)
/set_outbound_calls_enabled(Option<bool>)
: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>
sourcepub fn create_integration_association(&self) -> CreateIntegrationAssociation
pub fn create_integration_association(&self) -> CreateIntegrationAssociation
Constructs a fluent builder for the CreateIntegrationAssociation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integration_type(IntegrationType)
/set_integration_type(Option<IntegrationType>)
:The type of information to be ingested.
integration_arn(impl Into<String>)
/set_integration_arn(Option<String>)
:The Amazon Resource Name (ARN) of the integration.
source_application_url(impl Into<String>)
/set_source_application_url(Option<String>)
: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>)
:The name of the external application. This field is only required for the EVENT integration type.
source_type(SourceType)
/set_source_type(Option<SourceType>)
:The type of the data source. This field is only required for the EVENT integration type.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_queue(&self) -> CreateQueue
pub fn create_queue(&self) -> CreateQueue
Constructs a fluent builder for the CreateQueue
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the queue.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the queue.
outbound_caller_config(OutboundCallerConfig)
/set_outbound_caller_config(Option<OutboundCallerConfig>)
:The outbound caller ID name, number, and outbound whisper flow.
hours_of_operation_id(impl Into<String>)
/set_hours_of_operation_id(Option<String>)
:The identifier for the hours of operation.
max_contacts(i32)
/set_max_contacts(Option<i32>)
:The maximum number of contacts that can be in the queue before it is considered full.
quick_connect_ids(Vec<String>)
/set_quick_connect_ids(Option<Vec<String>>)
:The quick connects available to agents who are working the queue.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_quick_connect(&self) -> CreateQuickConnect
pub fn create_quick_connect(&self) -> CreateQuickConnect
Constructs a fluent builder for the CreateQuickConnect
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the quick connect.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the quick connect.
quick_connect_config(QuickConnectConfig)
/set_quick_connect_config(Option<QuickConnectConfig>)
:Configuration settings for the quick connect.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_routing_profile(&self) -> CreateRoutingProfile
pub fn create_routing_profile(&self) -> CreateRoutingProfile
Constructs a fluent builder for the CreateRoutingProfile
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the routing profile. Must not be more than 127 characters.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:The default outbound queue for the routing profile.
queue_configs(Vec<RoutingProfileQueueConfig>)
/set_queue_configs(Option<Vec<RoutingProfileQueueConfig>>)
:The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
media_concurrencies(Vec<MediaConcurrency>)
/set_media_concurrencies(Option<Vec<MediaConcurrency>>)
:The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:One or more tags.
- 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>
sourcepub fn create_security_profile(&self) -> CreateSecurityProfile
pub fn create_security_profile(&self) -> CreateSecurityProfile
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>)
:The name of the security profile.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the security profile.
permissions(Vec<String>)
/set_permissions(Option<Vec<String>>)
:Permissions assigned to the security profile.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_task_template(&self) -> CreateTaskTemplate
pub fn create_task_template(&self) -> CreateTaskTemplate
Constructs a fluent builder for the CreateTaskTemplate
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the task template.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the task template.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the flow that runs by default when a task is created by referencing this template.
constraints(TaskTemplateConstraints)
/set_constraints(Option<TaskTemplateConstraints>)
:Constraints that are applicable to the fields listed.
defaults(TaskTemplateDefaults)
/set_defaults(Option<TaskTemplateDefaults>)
:The default values for fields when a task is created by referencing this template.
status(TaskTemplateStatus)
/set_status(Option<TaskTemplateStatus>)
:Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created.fields(Vec<TaskTemplateField>)
/set_fields(Option<Vec<TaskTemplateField>>)
:Fields that are part of the template.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
CreateTaskTemplateOutput
with field(s):id(Option<String>)
:The identifier of the task template resource.
arn(Option<String>)
:The Amazon Resource Name (ARN) for the task template resource.
- On failure, responds with
SdkError<CreateTaskTemplateError>
sourcepub fn create_use_case(&self) -> CreateUseCase
pub fn create_use_case(&self) -> CreateUseCase
Constructs a fluent builder for the CreateUseCase
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integration_association_id(impl Into<String>)
/set_integration_association_id(Option<String>)
:The identifier for the integration association.
use_case_type(UseCaseType)
/set_use_case_type(Option<UseCaseType>)
:The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_user(&self) -> CreateUser
pub fn create_user(&self) -> CreateUser
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
username(impl Into<String>)
/set_username(Option<String>)
: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>)
: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>)
:The information about the identity of the user.
phone_config(UserPhoneConfig)
/set_phone_config(Option<UserPhoneConfig>)
:The phone settings for the user.
directory_user_id(impl Into<String>)
/set_directory_user_id(Option<String>)
: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(Vec<String>)
/set_security_profile_ids(Option<Vec<String>>)
:The identifier of the security profile for the user.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile for the user.
hierarchy_group_id(impl Into<String>)
/set_hierarchy_group_id(Option<String>)
:The identifier of the hierarchy group for the user.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:One or more tags.
- 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>
sourcepub fn create_user_hierarchy_group(&self) -> CreateUserHierarchyGroup
pub fn create_user_hierarchy_group(&self) -> CreateUserHierarchyGroup
Constructs a fluent builder for the CreateUserHierarchyGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
: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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- 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>
sourcepub fn create_vocabulary(&self) -> CreateVocabulary
pub fn create_vocabulary(&self) -> CreateVocabulary
Constructs a fluent builder for the CreateVocabulary
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. 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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
vocabulary_name(impl Into<String>)
/set_vocabulary_name(Option<String>)
:A unique name of the custom vocabulary.
language_code(VocabularyLanguageCode)
/set_language_code(Option<VocabularyLanguageCode>)
: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>)
: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
, andDisplayAs
fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to organize, track, or control access for this resource.
- On success, responds with
CreateVocabularyOutput
with field(s):vocabulary_arn(Option<String>)
:The Amazon Resource Name (ARN) of the custom vocabulary.
vocabulary_id(Option<String>)
:The identifier of the custom vocabulary.
state(Option<VocabularyState>)
:The current state of the custom vocabulary.
- On failure, responds with
SdkError<CreateVocabularyError>
sourcepub fn delete_contact_flow(&self) -> DeleteContactFlow
pub fn delete_contact_flow(&self) -> DeleteContactFlow
Constructs a fluent builder for the DeleteContactFlow
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
- On success, responds with
DeleteContactFlowOutput
- On failure, responds with
SdkError<DeleteContactFlowError>
sourcepub fn delete_contact_flow_module(&self) -> DeleteContactFlowModule
pub fn delete_contact_flow_module(&self) -> DeleteContactFlowModule
Constructs a fluent builder for the DeleteContactFlowModule
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_module_id(impl Into<String>)
/set_contact_flow_module_id(Option<String>)
:The identifier of the contact flow module.
- On success, responds with
DeleteContactFlowModuleOutput
- On failure, responds with
SdkError<DeleteContactFlowModuleError>
sourcepub fn delete_hours_of_operation(&self) -> DeleteHoursOfOperation
pub fn delete_hours_of_operation(&self) -> DeleteHoursOfOperation
Constructs a fluent builder for the DeleteHoursOfOperation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
hours_of_operation_id(impl Into<String>)
/set_hours_of_operation_id(Option<String>)
:The identifier for the hours of operation.
- On success, responds with
DeleteHoursOfOperationOutput
- On failure, responds with
SdkError<DeleteHoursOfOperationError>
sourcepub fn delete_instance(&self) -> DeleteInstance
pub fn delete_instance(&self) -> DeleteInstance
Constructs a fluent builder for the DeleteInstance
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DeleteInstanceOutput
- On failure, responds with
SdkError<DeleteInstanceError>
sourcepub fn delete_integration_association(&self) -> DeleteIntegrationAssociation
pub fn delete_integration_association(&self) -> DeleteIntegrationAssociation
Constructs a fluent builder for the DeleteIntegrationAssociation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integration_association_id(impl Into<String>)
/set_integration_association_id(Option<String>)
:The identifier for the integration association.
- On success, responds with
DeleteIntegrationAssociationOutput
- On failure, responds with
SdkError<DeleteIntegrationAssociationError>
sourcepub fn delete_quick_connect(&self) -> DeleteQuickConnect
pub fn delete_quick_connect(&self) -> DeleteQuickConnect
Constructs a fluent builder for the DeleteQuickConnect
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
quick_connect_id(impl Into<String>)
/set_quick_connect_id(Option<String>)
:The identifier for the quick connect.
- On success, responds with
DeleteQuickConnectOutput
- On failure, responds with
SdkError<DeleteQuickConnectError>
sourcepub fn delete_security_profile(&self) -> DeleteSecurityProfile
pub fn delete_security_profile(&self) -> DeleteSecurityProfile
Constructs a fluent builder for the DeleteSecurityProfile
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
security_profile_id(impl Into<String>)
/set_security_profile_id(Option<String>)
:The identifier for the security profle.
- On success, responds with
DeleteSecurityProfileOutput
- On failure, responds with
SdkError<DeleteSecurityProfileError>
sourcepub fn delete_task_template(&self) -> DeleteTaskTemplate
pub fn delete_task_template(&self) -> DeleteTaskTemplate
Constructs a fluent builder for the DeleteTaskTemplate
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
task_template_id(impl Into<String>)
/set_task_template_id(Option<String>)
:A unique identifier for the task template.
- On success, responds with
DeleteTaskTemplateOutput
- On failure, responds with
SdkError<DeleteTaskTemplateError>
sourcepub fn delete_use_case(&self) -> DeleteUseCase
pub fn delete_use_case(&self) -> DeleteUseCase
Constructs a fluent builder for the DeleteUseCase
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integration_association_id(impl Into<String>)
/set_integration_association_id(Option<String>)
:The identifier for the integration association.
use_case_id(impl Into<String>)
/set_use_case_id(Option<String>)
:The identifier for the use case.
- On success, responds with
DeleteUseCaseOutput
- On failure, responds with
SdkError<DeleteUseCaseError>
sourcepub fn delete_user(&self) -> DeleteUser
pub fn delete_user(&self) -> DeleteUser
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
sourcepub fn delete_user_hierarchy_group(&self) -> DeleteUserHierarchyGroup
pub fn delete_user_hierarchy_group(&self) -> DeleteUserHierarchyGroup
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>)
:The identifier of the hierarchy group.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DeleteUserHierarchyGroupOutput
- On failure, responds with
SdkError<DeleteUserHierarchyGroupError>
sourcepub fn delete_vocabulary(&self) -> DeleteVocabulary
pub fn delete_vocabulary(&self) -> DeleteVocabulary
Constructs a fluent builder for the DeleteVocabulary
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
vocabulary_id(impl Into<String>)
/set_vocabulary_id(Option<String>)
:The identifier of the custom vocabulary.
- On success, responds with
DeleteVocabularyOutput
with field(s):vocabulary_arn(Option<String>)
:The Amazon Resource Name (ARN) of the custom vocabulary.
vocabulary_id(Option<String>)
:The identifier of the custom vocabulary.
state(Option<VocabularyState>)
:The current state of the custom vocabulary.
- On failure, responds with
SdkError<DeleteVocabularyError>
sourcepub fn describe_agent_status(&self) -> DescribeAgentStatus
pub fn describe_agent_status(&self) -> DescribeAgentStatus
Constructs a fluent builder for the DescribeAgentStatus
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
agent_status_id(impl Into<String>)
/set_agent_status_id(Option<String>)
: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>
sourcepub fn describe_contact(&self) -> DescribeContact
pub fn describe_contact(&self) -> DescribeContact
Constructs a fluent builder for the DescribeContact
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
: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>
sourcepub fn describe_contact_flow(&self) -> DescribeContactFlow
pub fn describe_contact_flow(&self) -> DescribeContactFlow
Constructs a fluent builder for the DescribeContactFlow
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
- On success, responds with
DescribeContactFlowOutput
with field(s):contact_flow(Option<ContactFlow>)
:Information about the contact flow.
- On failure, responds with
SdkError<DescribeContactFlowError>
sourcepub fn describe_contact_flow_module(&self) -> DescribeContactFlowModule
pub fn describe_contact_flow_module(&self) -> DescribeContactFlowModule
Constructs a fluent builder for the DescribeContactFlowModule
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_module_id(impl Into<String>)
/set_contact_flow_module_id(Option<String>)
:The identifier of the contact flow module.
- On success, responds with
DescribeContactFlowModuleOutput
with field(s):contact_flow_module(Option<ContactFlowModule>)
:Information about the contact flow module.
- On failure, responds with
SdkError<DescribeContactFlowModuleError>
sourcepub fn describe_hours_of_operation(&self) -> DescribeHoursOfOperation
pub fn describe_hours_of_operation(&self) -> DescribeHoursOfOperation
Constructs a fluent builder for the DescribeHoursOfOperation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
hours_of_operation_id(impl Into<String>)
/set_hours_of_operation_id(Option<String>)
: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>
sourcepub fn describe_instance(&self) -> DescribeInstance
pub fn describe_instance(&self) -> DescribeInstance
Constructs a fluent builder for the DescribeInstance
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DescribeInstanceOutput
with field(s):instance(Option<Instance>)
:The name of the instance.
- On failure, responds with
SdkError<DescribeInstanceError>
sourcepub fn describe_instance_attribute(&self) -> DescribeInstanceAttribute
pub fn describe_instance_attribute(&self) -> DescribeInstanceAttribute
Constructs a fluent builder for the DescribeInstanceAttribute
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
attribute_type(InstanceAttributeType)
/set_attribute_type(Option<InstanceAttributeType>)
: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>
sourcepub fn describe_instance_storage_config(&self) -> DescribeInstanceStorageConfig
pub fn describe_instance_storage_config(&self) -> DescribeInstanceStorageConfig
Constructs a fluent builder for the DescribeInstanceStorageConfig
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
association_id(impl Into<String>)
/set_association_id(Option<String>)
: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>)
: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>
sourcepub fn describe_phone_number(&self) -> DescribePhoneNumber
pub fn describe_phone_number(&self) -> DescribePhoneNumber
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>)
: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.
- On failure, responds with
SdkError<DescribePhoneNumberError>
sourcepub fn describe_queue(&self) -> DescribeQueue
pub fn describe_queue(&self) -> DescribeQueue
Constructs a fluent builder for the DescribeQueue
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
: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>
sourcepub fn describe_quick_connect(&self) -> DescribeQuickConnect
pub fn describe_quick_connect(&self) -> DescribeQuickConnect
Constructs a fluent builder for the DescribeQuickConnect
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
quick_connect_id(impl Into<String>)
/set_quick_connect_id(Option<String>)
: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>
sourcepub fn describe_routing_profile(&self) -> DescribeRoutingProfile
pub fn describe_routing_profile(&self) -> DescribeRoutingProfile
Constructs a fluent builder for the DescribeRoutingProfile
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
: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>
sourcepub fn describe_security_profile(&self) -> DescribeSecurityProfile
pub fn describe_security_profile(&self) -> DescribeSecurityProfile
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>)
:The identifier for the security profle.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DescribeSecurityProfileOutput
with field(s):security_profile(Option<SecurityProfile>)
:The security profile.
- On failure, responds with
SdkError<DescribeSecurityProfileError>
sourcepub fn describe_user(&self) -> DescribeUser
pub fn describe_user(&self) -> DescribeUser
Constructs a fluent builder for the DescribeUser
operation.
- The fluent builder is configurable:
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user account.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- 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>
sourcepub fn describe_user_hierarchy_group(&self) -> DescribeUserHierarchyGroup
pub fn describe_user_hierarchy_group(&self) -> DescribeUserHierarchyGroup
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>)
:The identifier of the hierarchy group.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DescribeUserHierarchyGroupOutput
with field(s):hierarchy_group(Option<HierarchyGroup>)
:Information about the hierarchy group.
- On failure, responds with
SdkError<DescribeUserHierarchyGroupError>
sourcepub fn describe_user_hierarchy_structure(
&self
) -> DescribeUserHierarchyStructure
pub fn describe_user_hierarchy_structure(
&self
) -> DescribeUserHierarchyStructure
Constructs a fluent builder for the DescribeUserHierarchyStructure
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DescribeUserHierarchyStructureOutput
with field(s):hierarchy_structure(Option<HierarchyStructure>)
:Information about the hierarchy structure.
- On failure, responds with
SdkError<DescribeUserHierarchyStructureError>
sourcepub fn describe_vocabulary(&self) -> DescribeVocabulary
pub fn describe_vocabulary(&self) -> DescribeVocabulary
Constructs a fluent builder for the DescribeVocabulary
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
vocabulary_id(impl Into<String>)
/set_vocabulary_id(Option<String>)
: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>
sourcepub fn disassociate_approved_origin(&self) -> DisassociateApprovedOrigin
pub fn disassociate_approved_origin(&self) -> DisassociateApprovedOrigin
Constructs a fluent builder for the DisassociateApprovedOrigin
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
origin(impl Into<String>)
/set_origin(Option<String>)
:The domain URL of the integrated application.
- On success, responds with
DisassociateApprovedOriginOutput
- On failure, responds with
SdkError<DisassociateApprovedOriginError>
sourcepub fn disassociate_bot(&self) -> DisassociateBot
pub fn disassociate_bot(&self) -> DisassociateBot
Constructs a fluent builder for the DisassociateBot
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
lex_bot(LexBot)
/set_lex_bot(Option<LexBot>)
:Configuration information of an Amazon Lex bot.
lex_v2_bot(LexV2Bot)
/set_lex_v2_bot(Option<LexV2Bot>)
:The Amazon Lex V2 bot to disassociate from the instance.
- On success, responds with
DisassociateBotOutput
- On failure, responds with
SdkError<DisassociateBotError>
sourcepub fn disassociate_instance_storage_config(
&self
) -> DisassociateInstanceStorageConfig
pub fn disassociate_instance_storage_config(
&self
) -> DisassociateInstanceStorageConfig
Constructs a fluent builder for the DisassociateInstanceStorageConfig
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
association_id(impl Into<String>)
/set_association_id(Option<String>)
: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>)
:A valid resource type.
- On success, responds with
DisassociateInstanceStorageConfigOutput
- On failure, responds with
SdkError<DisassociateInstanceStorageConfigError>
sourcepub fn disassociate_lambda_function(&self) -> DisassociateLambdaFunction
pub fn disassociate_lambda_function(&self) -> DisassociateLambdaFunction
Constructs a fluent builder for the DisassociateLambdaFunction
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..
function_arn(impl Into<String>)
/set_function_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Lambda function being disassociated.
- On success, responds with
DisassociateLambdaFunctionOutput
- On failure, responds with
SdkError<DisassociateLambdaFunctionError>
sourcepub fn disassociate_lex_bot(&self) -> DisassociateLexBot
pub fn disassociate_lex_bot(&self) -> DisassociateLexBot
Constructs a fluent builder for the DisassociateLexBot
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
bot_name(impl Into<String>)
/set_bot_name(Option<String>)
:The name of the Amazon Lex bot. Maximum character limit of 50.
lex_region(impl Into<String>)
/set_lex_region(Option<String>)
:The Region in which the Amazon Lex bot has been created.
- On success, responds with
DisassociateLexBotOutput
- On failure, responds with
SdkError<DisassociateLexBotError>
sourcepub fn disassociate_phone_number_contact_flow(
&self
) -> DisassociatePhoneNumberContactFlow
pub fn disassociate_phone_number_contact_flow(
&self
) -> DisassociatePhoneNumberContactFlow
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>)
:A unique identifier for the phone number.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
DisassociatePhoneNumberContactFlowOutput
- On failure, responds with
SdkError<DisassociatePhoneNumberContactFlowError>
sourcepub fn disassociate_queue_quick_connects(
&self
) -> DisassociateQueueQuickConnects
pub fn disassociate_queue_quick_connects(
&self
) -> DisassociateQueueQuickConnects
Constructs a fluent builder for the DisassociateQueueQuickConnects
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
quick_connect_ids(Vec<String>)
/set_quick_connect_ids(Option<Vec<String>>)
:The quick connects to disassociate from the queue.
- On success, responds with
DisassociateQueueQuickConnectsOutput
- On failure, responds with
SdkError<DisassociateQueueQuickConnectsError>
sourcepub fn disassociate_routing_profile_queues(
&self
) -> DisassociateRoutingProfileQueues
pub fn disassociate_routing_profile_queues(
&self
) -> DisassociateRoutingProfileQueues
Constructs a fluent builder for the DisassociateRoutingProfileQueues
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
queue_references(Vec<RoutingProfileQueueReference>)
/set_queue_references(Option<Vec<RoutingProfileQueueReference>>)
:The queues to disassociate from this routing profile.
- On success, responds with
DisassociateRoutingProfileQueuesOutput
- On failure, responds with
SdkError<DisassociateRoutingProfileQueuesError>
sourcepub fn disassociate_security_key(&self) -> DisassociateSecurityKey
pub fn disassociate_security_key(&self) -> DisassociateSecurityKey
Constructs a fluent builder for the DisassociateSecurityKey
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
association_id(impl Into<String>)
/set_association_id(Option<String>)
: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>
sourcepub fn get_contact_attributes(&self) -> GetContactAttributes
pub fn get_contact_attributes(&self) -> GetContactAttributes
Constructs a fluent builder for the GetContactAttributes
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance.
initial_contact_id(impl Into<String>)
/set_initial_contact_id(Option<String>)
: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>
sourcepub fn get_current_metric_data(&self) -> GetCurrentMetricData
pub fn get_current_metric_data(&self) -> GetCurrentMetricData
Constructs a fluent builder for the GetCurrentMetricData
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
filters(Filters)
/set_filters(Option<Filters>)
:The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
groupings(Vec<Grouping>)
/set_groupings(Option<Vec<Grouping>>)
:The grouping applied to the metrics returned. For example, when grouped by
QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues. If you group byCHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.If no
Grouping
is included in the request, a summary of metrics is returned.current_metrics(Vec<CurrentMetric>)
/set_current_metrics(Option<Vec<CurrentMetric>>)
:The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ “Metric”: { “Name”: “OLDEST_CONTACT_AGE”, “Unit”: “SECONDS” }, “Value”: 24113.0
}The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
GetCurrentMetricDataOutput
with field(s):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.
- On failure, responds with
SdkError<GetCurrentMetricDataError>
sourcepub fn get_current_user_data(&self) -> GetCurrentUserData
pub fn get_current_user_data(&self) -> GetCurrentUserData
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
filters(UserDataFilters)
/set_filters(Option<UserDataFilters>)
:Filters up to 100
Queues
, or up to 9ContactStates
. The user data is retrieved only for those users who are associated with the queues and have contacts that are in the specifiedContactState
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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.
- On failure, responds with
SdkError<GetCurrentUserDataError>
sourcepub fn get_federation_token(&self) -> GetFederationToken
pub fn get_federation_token(&self) -> GetFederationToken
Constructs a fluent builder for the GetFederationToken
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
GetFederationTokenOutput
with field(s):credentials(Option<Credentials>)
:The credentials to use for federation.
- On failure, responds with
SdkError<GetFederationTokenError>
sourcepub fn get_metric_data(&self) -> GetMetricData
pub fn get_metric_data(&self) -> GetMetricData
Constructs a fluent builder for the GetMetricData
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
filters(Filters)
/set_filters(Option<Filters>)
:The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
To filter by
Queues
, enter the queue ID/ARN, not the name of the queue.groupings(Vec<Grouping>)
/set_groupings(Option<Vec<Grouping>>)
:The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
historical_metrics(Vec<HistoricalMetric>)
/set_historical_metrics(Option<Vec<HistoricalMetric>>)
:The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there’s no CONTACTS_INCOMING metric missing from the documented list).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
- HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For
ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison
, you must enterLT
(for “Less than”).
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
GetMetricDataOutput
with field(s):next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
metric_results(Option<Vec<HistoricalMetricResult>>)
:Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
- On failure, responds with
SdkError<GetMetricDataError>
sourcepub fn get_task_template(&self) -> GetTaskTemplate
pub fn get_task_template(&self) -> GetTaskTemplate
Constructs a fluent builder for the GetTaskTemplate
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
task_template_id(impl Into<String>)
/set_task_template_id(Option<String>)
:A unique identifier for the task template.
snapshot_version(impl Into<String>)
/set_snapshot_version(Option<String>)
: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 instanceId in the ARN of the instance.
id(Option<String>)
:A unique identifier for the task template.
arn(Option<String>)
:The Amazon Resource Name (ARN).
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
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, 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.
- On failure, responds with
SdkError<GetTaskTemplateError>
sourcepub fn list_agent_statuses(&self) -> ListAgentStatuses
pub fn list_agent_statuses(&self) -> ListAgentStatuses
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
agent_status_types(Vec<AgentStatusType>)
/set_agent_status_types(Option<Vec<AgentStatusType>>)
: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>
sourcepub fn list_approved_origins(&self) -> ListApprovedOrigins
pub fn list_approved_origins(&self) -> ListApprovedOrigins
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_bots(&self) -> ListBots
pub fn list_bots(&self) -> ListBots
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
lex_version(LexVersion)
/set_lex_version(Option<LexVersion>)
: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 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>
sourcepub fn list_contact_flow_modules(&self) -> ListContactFlowModules
pub fn list_contact_flow_modules(&self) -> ListContactFlowModules
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
contact_flow_module_state(ContactFlowModuleState)
/set_contact_flow_module_state(Option<ContactFlowModuleState>)
:The state of the contact flow module.
- On success, responds with
ListContactFlowModulesOutput
with field(s):contact_flow_modules_summary_list(Option<Vec<ContactFlowModuleSummary>>)
:Information about the contact 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>
sourcepub fn list_contact_flows(&self) -> ListContactFlows
pub fn list_contact_flows(&self) -> ListContactFlows
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_types(Vec<ContactFlowType>)
/set_contact_flow_types(Option<Vec<ContactFlowType>>)
:The type of contact flow.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return per page.
- On success, responds with
ListContactFlowsOutput
with field(s):contact_flow_summary_list(Option<Vec<ContactFlowSummary>>)
:Information about the contact 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>
sourcepub fn list_contact_references(&self) -> ListContactReferences
pub fn list_contact_references(&self) -> ListContactReferences
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>)
: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>)
:The identifier of the initial contact.
reference_types(Vec<ReferenceType>)
/set_reference_types(Option<Vec<ReferenceType>>)
:The type of reference.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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 contact 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>
sourcepub fn list_default_vocabularies(&self) -> ListDefaultVocabularies
pub fn list_default_vocabularies(&self) -> ListDefaultVocabularies
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
language_code(VocabularyLanguageCode)
/set_language_code(Option<VocabularyLanguageCode>)
: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(i32)
:The maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- On success, responds with
ListDefaultVocabulariesOutput
with field(s):default_vocabulary_list(Option<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>
sourcepub fn list_hours_of_operations(&self) -> ListHoursOfOperations
pub fn list_hours_of_operations(&self) -> ListHoursOfOperations
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return per page.
- 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>
sourcepub fn list_instance_attributes(&self) -> ListInstanceAttributes
pub fn list_instance_attributes(&self) -> ListInstanceAttributes
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_instances(&self) -> ListInstances
pub fn list_instances(&self) -> ListInstances
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>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_instance_storage_configs(&self) -> ListInstanceStorageConfigs
pub fn list_instance_storage_configs(&self) -> ListInstanceStorageConfigs
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
resource_type(InstanceStorageResourceType)
/set_resource_type(Option<InstanceStorageResourceType>)
:A valid resource type.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_integration_associations(&self) -> ListIntegrationAssociations
pub fn list_integration_associations(&self) -> ListIntegrationAssociations
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integration_type(IntegrationType)
/set_integration_type(Option<IntegrationType>)
:The integration type.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_lambda_functions(&self) -> ListLambdaFunctions
pub fn list_lambda_functions(&self) -> ListLambdaFunctions
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_lex_bots(&self) -> ListLexBots
pub fn list_lex_bots(&self) -> ListLexBots
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page. 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 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>
sourcepub fn list_phone_numbers(&self) -> ListPhoneNumbers
pub fn list_phone_numbers(&self) -> ListPhoneNumbers
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
phone_number_types(Vec<PhoneNumberType>)
/set_phone_number_types(Option<Vec<PhoneNumberType>>)
:The type of phone number.
phone_number_country_codes(Vec<PhoneNumberCountryCode>)
/set_phone_number_country_codes(Option<Vec<PhoneNumberCountryCode>>)
:The ISO country code.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return per page.
- 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>
sourcepub fn list_phone_numbers_v2(&self) -> ListPhoneNumbersV2
pub fn list_phone_numbers_v2(&self) -> ListPhoneNumbersV2
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>)
:The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If
TargetArn
input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
phone_number_country_codes(Vec<PhoneNumberCountryCode>)
/set_phone_number_country_codes(Option<Vec<PhoneNumberCountryCode>>)
:The ISO country code.
phone_number_types(Vec<PhoneNumberType>)
/set_phone_number_types(Option<Vec<PhoneNumberType>>)
:The type of phone number.
phone_number_prefix(impl Into<String>)
/set_phone_number_prefix(Option<String>)
: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.
- On failure, responds with
SdkError<ListPhoneNumbersV2Error>
sourcepub fn list_prompts(&self) -> ListPrompts
pub fn list_prompts(&self) -> ListPrompts
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>)
:The identifier of the Amazon Connect instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_queue_quick_connects(&self) -> ListQueueQuickConnects
pub fn list_queue_quick_connects(&self) -> ListQueueQuickConnects
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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.
- On failure, responds with
SdkError<ListQueueQuickConnectsError>
sourcepub fn list_queues(&self) -> ListQueues
pub fn list_queues(&self) -> ListQueues
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_types(Vec<QueueType>)
/set_queue_types(Option<Vec<QueueType>>)
:The type of queue.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return per page.
- 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>
sourcepub fn list_quick_connects(&self) -> ListQuickConnects
pub fn list_quick_connects(&self) -> ListQuickConnects
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
quick_connect_types(Vec<QuickConnectType>)
/set_quick_connect_types(Option<Vec<QuickConnectType>>)
: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>
sourcepub fn list_routing_profile_queues(&self) -> ListRoutingProfileQueues
pub fn list_routing_profile_queues(&self) -> ListRoutingProfileQueues
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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.
- On failure, responds with
SdkError<ListRoutingProfileQueuesError>
sourcepub fn list_routing_profiles(&self) -> ListRoutingProfiles
pub fn list_routing_profiles(&self) -> ListRoutingProfiles
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_security_keys(&self) -> ListSecurityKeys
pub fn list_security_keys(&self) -> ListSecurityKeys
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_security_profile_permissions(
&self
) -> ListSecurityProfilePermissions
pub fn list_security_profile_permissions(
&self
) -> ListSecurityProfilePermissions
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>)
:The identifier for the security profle.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
ListSecurityProfilePermissionsOutput
with field(s):permissions(Option<Vec<String>>)
:The permissions granted to the security profile.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
- On failure, responds with
SdkError<ListSecurityProfilePermissionsError>
sourcepub fn list_security_profiles(&self) -> ListSecurityProfiles
pub fn list_security_profiles(&self) -> ListSecurityProfiles
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:Information about the tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn list_task_templates(&self) -> ListTaskTemplates
pub fn list_task_templates(&self) -> ListTaskTemplates
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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>)
:The maximum number of results to return per page.
It is not expected that you set this.
status(TaskTemplateStatus)
/set_status(Option<TaskTemplateStatus>)
:Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created.name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn list_use_cases(&self) -> ListUseCases
pub fn list_use_cases(&self) -> ListUseCases
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
integration_association_id(impl Into<String>)
/set_integration_association_id(Option<String>)
:The identifier for the integration association.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_user_hierarchy_groups(&self) -> ListUserHierarchyGroups
pub fn list_user_hierarchy_groups(&self) -> ListUserHierarchyGroups
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn list_users(&self) -> ListUsers
pub fn list_users(&self) -> ListUsers
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
- On success, responds with
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>
sourcepub fn put_user_status(&self) -> PutUserStatus
pub fn put_user_status(&self) -> PutUserStatus
Constructs a fluent builder for the PutUserStatus
operation.
- The fluent builder is configurable:
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
agent_status_id(impl Into<String>)
/set_agent_status_id(Option<String>)
:The identifier of the agent status.
- On success, responds with
PutUserStatusOutput
- On failure, responds with
SdkError<PutUserStatusError>
sourcepub fn release_phone_number(&self) -> ReleasePhoneNumber
pub fn release_phone_number(&self) -> ReleasePhoneNumber
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>)
:A unique identifier for the phone number.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
ReleasePhoneNumberOutput
- On failure, responds with
SdkError<ReleasePhoneNumberError>
sourcepub fn resume_contact_recording(&self) -> ResumeContactRecording
pub fn resume_contact_recording(&self) -> ResumeContactRecording
Constructs a fluent builder for the ResumeContactRecording
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The identifier of the contact.
initial_contact_id(impl Into<String>)
/set_initial_contact_id(Option<String>)
: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>
sourcepub fn search_available_phone_numbers(&self) -> SearchAvailablePhoneNumbers
pub fn search_available_phone_numbers(&self) -> SearchAvailablePhoneNumbers
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>)
:The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
phone_number_country_code(PhoneNumberCountryCode)
/set_phone_number_country_code(Option<PhoneNumberCountryCode>)
:The ISO country code.
phone_number_type(PhoneNumberType)
/set_phone_number_type(Option<PhoneNumberType>)
:The type of phone number.
phone_number_prefix(impl Into<String>)
/set_phone_number_prefix(Option<String>)
: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>)
:The maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- 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 for your Amazon Connect instance.
- On failure, responds with
SdkError<SearchAvailablePhoneNumbersError>
sourcepub fn search_users(&self) -> SearchUsers
pub fn search_users(&self) -> SearchUsers
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return per page.
search_filter(UserSearchFilter)
/set_search_filter(Option<UserSearchFilter>)
:Filters to be applied to search results.
search_criteria(UserSearchCriteria)
/set_search_criteria(Option<UserSearchCriteria>)
:The search criteria to be used to return users.
- 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>
sourcepub fn search_vocabularies(&self) -> SearchVocabularies
pub fn search_vocabularies(&self) -> SearchVocabularies
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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
max_results(i32)
/set_max_results(i32)
:The maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
state(VocabularyState)
/set_state(Option<VocabularyState>)
:The current state of the custom vocabulary.
name_starts_with(impl Into<String>)
/set_name_starts_with(Option<String>)
:The starting pattern of the name of the vocabulary.
language_code(VocabularyLanguageCode)
/set_language_code(Option<VocabularyLanguageCode>)
: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>
sourcepub fn start_chat_contact(&self) -> StartChatContact
pub fn start_chat_contact(&self) -> StartChatContact
Constructs a fluent builder for the StartChatContact
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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(HashMap<String, String>)
/set_attributes(Option<HashMap<String, String>>)
:A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact 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>)
:Information identifying the participant.
initial_message(ChatMessage)
/set_initial_message(Option<ChatMessage>)
:The initial message to be sent to the newly created chat.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
chat_duration_in_minutes(i32)
/set_chat_duration_in_minutes(Option<i32>)
:The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
supported_messaging_content_types(Vec<String>)
/set_supported_messaging_content_types(Option<Vec<String>>)
:The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.
- 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.
- On failure, responds with
SdkError<StartChatContactError>
sourcepub fn start_contact_recording(&self) -> StartContactRecording
pub fn start_contact_recording(&self) -> StartContactRecording
Constructs a fluent builder for the StartContactRecording
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The identifier of the contact.
initial_contact_id(impl Into<String>)
/set_initial_contact_id(Option<String>)
: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>)
:The person being recorded.
- On success, responds with
StartContactRecordingOutput
- On failure, responds with
SdkError<StartContactRecordingError>
sourcepub fn start_contact_streaming(&self) -> StartContactStreaming
pub fn start_contact_streaming(&self) -> StartContactStreaming
Constructs a fluent builder for the StartContactStreaming
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
: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>)
:The streaming configuration, such as the Amazon SNS streaming endpoint.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- On success, responds with
StartContactStreamingOutput
with field(s):streaming_id(Option<String>)
:The identifier of the streaming configuration enabled.
- On failure, responds with
SdkError<StartContactStreamingError>
sourcepub fn start_outbound_voice_contact(&self) -> StartOutboundVoiceContact
pub fn start_outbound_voice_contact(&self) -> StartOutboundVoiceContact
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>)
:The phone number of the customer, in E.164 format.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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>)
: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>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. 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>)
: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>)
: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 contact flow is used. If you do not specify a queue, you must specify a source phone number.
attributes(HashMap<String, String>)
/set_attributes(Option<HashMap<String, String>>)
:A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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>)
:Configuration of the answering machine detection for this outbound call.
campaign_id(impl Into<String>)
/set_campaign_id(Option<String>)
:The campaign identifier of the outbound communication.
traffic_type(TrafficType)
/set_traffic_type(Option<TrafficType>)
:Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is
GENERAL
. UseCAMPAIGN
ifEnableAnswerMachineDetection
is set totrue
. For all other cases, useGENERAL
.
- 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>
sourcepub fn start_task_contact(&self) -> StartTaskContact
pub fn start_task_contact(&self) -> StartTaskContact
Constructs a fluent builder for the StartTaskContact
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
previous_contact_id(impl Into<String>)
/set_previous_contact_id(Option<String>)
:The identifier of the previous chat, voice, or task contact.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact 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 contact flow. On the contact flow page, under the name of the contact 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(HashMap<String, String>)
/set_attributes(Option<HashMap<String, String>>)
:A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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>)
:The name of a task that is shown to an agent in the Contact Control Panel (CCP).
references(HashMap<String, Reference>)
/set_references(Option<HashMap<String, Reference>>)
:A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
scheduled_time(DateTime)
/set_scheduled_time(Option<DateTime>)
:The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact 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>)
:A unique identifier for the task template.
quick_connect_id(impl Into<String>)
/set_quick_connect_id(Option<String>)
:The identifier for the quick connect.
- 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>
sourcepub fn stop_contact(&self) -> StopContact
pub fn stop_contact(&self) -> StopContact
Constructs a fluent builder for the StopContact
operation.
- The fluent builder is configurable:
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The ID of the contact.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
StopContactOutput
- On failure, responds with
SdkError<StopContactError>
sourcepub fn stop_contact_recording(&self) -> StopContactRecording
pub fn stop_contact_recording(&self) -> StopContactRecording
Constructs a fluent builder for the StopContactRecording
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The identifier of the contact.
initial_contact_id(impl Into<String>)
/set_initial_contact_id(Option<String>)
: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>
sourcepub fn stop_contact_streaming(&self) -> StopContactStreaming
pub fn stop_contact_streaming(&self) -> StopContactStreaming
Constructs a fluent builder for the StopContactStreaming
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
: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>)
:The identifier of the streaming configuration enabled.
- On success, responds with
StopContactStreamingOutput
- On failure, responds with
SdkError<StopContactStreamingError>
sourcepub fn suspend_contact_recording(&self) -> SuspendContactRecording
pub fn suspend_contact_recording(&self) -> SuspendContactRecording
Constructs a fluent builder for the SuspendContactRecording
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The identifier of the contact.
initial_contact_id(impl Into<String>)
/set_initial_contact_id(Option<String>)
: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>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:One or more tags. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn transfer_contact(&self) -> TransferContact
pub fn transfer_contact(&self) -> TransferContact
Constructs a fluent builder for the TransferContact
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The identifier of the contact in this instance of Amazon Connect.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier for the user.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- 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>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_agent_status(&self) -> UpdateAgentStatus
pub fn update_agent_status(&self) -> UpdateAgentStatus
Constructs a fluent builder for the UpdateAgentStatus
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
agent_status_id(impl Into<String>)
/set_agent_status_id(Option<String>)
:The identifier of the agent status.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the agent status.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the agent status.
state(AgentStatusState)
/set_state(Option<AgentStatusState>)
:The state of the agent status.
display_order(i32)
/set_display_order(Option<i32>)
:The display order of the agent status.
reset_order_number(bool)
/set_reset_order_number(bool)
:A number indicating the reset order of the agent status.
- On success, responds with
UpdateAgentStatusOutput
- On failure, responds with
SdkError<UpdateAgentStatusError>
sourcepub fn update_contact(&self) -> UpdateContact
pub fn update_contact(&self) -> UpdateContact
Constructs a fluent builder for the UpdateContact
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
: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>)
:The name of the contact.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the contact.
references(HashMap<String, Reference>)
/set_references(Option<HashMap<String, Reference>>)
:Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
- On success, responds with
UpdateContactOutput
- On failure, responds with
SdkError<UpdateContactError>
sourcepub fn update_contact_attributes(&self) -> UpdateContactAttributes
pub fn update_contact_attributes(&self) -> UpdateContactAttributes
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>)
: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>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
attributes(HashMap<String, String>)
/set_attributes(Option<HashMap<String, String>>)
:The Amazon Connect attributes. These attributes can be accessed in contact 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>
sourcepub fn update_contact_flow_content(&self) -> UpdateContactFlowContent
pub fn update_contact_flow_content(&self) -> UpdateContactFlowContent
Constructs a fluent builder for the UpdateContactFlowContent
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
content(impl Into<String>)
/set_content(Option<String>)
:The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.
- On success, responds with
UpdateContactFlowContentOutput
- On failure, responds with
SdkError<UpdateContactFlowContentError>
sourcepub fn update_contact_flow_metadata(&self) -> UpdateContactFlowMetadata
pub fn update_contact_flow_metadata(&self) -> UpdateContactFlowMetadata
Constructs a fluent builder for the UpdateContactFlowMetadata
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
name(impl Into<String>)
/set_name(Option<String>)
:TThe name of the contact flow.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the contact flow.
contact_flow_state(ContactFlowState)
/set_contact_flow_state(Option<ContactFlowState>)
:The state of contact flow.
- On success, responds with
UpdateContactFlowMetadataOutput
- On failure, responds with
SdkError<UpdateContactFlowMetadataError>
sourcepub fn update_contact_flow_module_content(
&self
) -> UpdateContactFlowModuleContent
pub fn update_contact_flow_module_content(
&self
) -> UpdateContactFlowModuleContent
Constructs a fluent builder for the UpdateContactFlowModuleContent
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_module_id(impl Into<String>)
/set_contact_flow_module_id(Option<String>)
:The identifier of the contact flow module.
content(impl Into<String>)
/set_content(Option<String>)
:The content of the contact flow module.
- On success, responds with
UpdateContactFlowModuleContentOutput
- On failure, responds with
SdkError<UpdateContactFlowModuleContentError>
sourcepub fn update_contact_flow_module_metadata(
&self
) -> UpdateContactFlowModuleMetadata
pub fn update_contact_flow_module_metadata(
&self
) -> UpdateContactFlowModuleMetadata
Constructs a fluent builder for the UpdateContactFlowModuleMetadata
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_flow_module_id(impl Into<String>)
/set_contact_flow_module_id(Option<String>)
:The identifier of the contact flow module.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the contact flow module.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the contact flow module.
state(ContactFlowModuleState)
/set_state(Option<ContactFlowModuleState>)
:The state of contact flow module.
- On success, responds with
UpdateContactFlowModuleMetadataOutput
- On failure, responds with
SdkError<UpdateContactFlowModuleMetadataError>
sourcepub fn update_contact_flow_name(&self) -> UpdateContactFlowName
pub fn update_contact_flow_name(&self) -> UpdateContactFlowName
Constructs a fluent builder for the UpdateContactFlowName
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the contact flow.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the contact flow.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the contact flow.
- On success, responds with
UpdateContactFlowNameOutput
- On failure, responds with
SdkError<UpdateContactFlowNameError>
sourcepub fn update_contact_schedule(&self) -> UpdateContactSchedule
pub fn update_contact_schedule(&self) -> UpdateContactSchedule
Constructs a fluent builder for the UpdateContactSchedule
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
contact_id(impl Into<String>)
/set_contact_id(Option<String>)
:The identifier of the contact.
scheduled_time(DateTime)
/set_scheduled_time(Option<DateTime>)
:The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact 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>
sourcepub fn update_hours_of_operation(&self) -> UpdateHoursOfOperation
pub fn update_hours_of_operation(&self) -> UpdateHoursOfOperation
Constructs a fluent builder for the UpdateHoursOfOperation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
hours_of_operation_id(impl Into<String>)
/set_hours_of_operation_id(Option<String>)
:The identifier of the hours of operation.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the hours of operation.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the hours of operation.
time_zone(impl Into<String>)
/set_time_zone(Option<String>)
:The time zone of the hours of operation.
config(Vec<HoursOfOperationConfig>)
/set_config(Option<Vec<HoursOfOperationConfig>>)
:Configuration information of the hours of operation.
- On success, responds with
UpdateHoursOfOperationOutput
- On failure, responds with
SdkError<UpdateHoursOfOperationError>
sourcepub fn update_instance_attribute(&self) -> UpdateInstanceAttribute
pub fn update_instance_attribute(&self) -> UpdateInstanceAttribute
Constructs a fluent builder for the UpdateInstanceAttribute
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
attribute_type(InstanceAttributeType)
/set_attribute_type(Option<InstanceAttributeType>)
: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>)
:The value for the attribute. Maximum character limit is 100.
- On success, responds with
UpdateInstanceAttributeOutput
- On failure, responds with
SdkError<UpdateInstanceAttributeError>
sourcepub fn update_instance_storage_config(&self) -> UpdateInstanceStorageConfig
pub fn update_instance_storage_config(&self) -> UpdateInstanceStorageConfig
Constructs a fluent builder for the UpdateInstanceStorageConfig
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
association_id(impl Into<String>)
/set_association_id(Option<String>)
: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>)
:A valid resource type.
storage_config(InstanceStorageConfig)
/set_storage_config(Option<InstanceStorageConfig>)
:The storage configuration for the instance.
- On success, responds with
UpdateInstanceStorageConfigOutput
- On failure, responds with
SdkError<UpdateInstanceStorageConfigError>
sourcepub fn update_phone_number(&self) -> UpdatePhoneNumber
pub fn update_phone_number(&self) -> UpdatePhoneNumber
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>)
:A unique identifier for the phone number.
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- 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>
sourcepub fn update_queue_hours_of_operation(&self) -> UpdateQueueHoursOfOperation
pub fn update_queue_hours_of_operation(&self) -> UpdateQueueHoursOfOperation
Constructs a fluent builder for the UpdateQueueHoursOfOperation
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
hours_of_operation_id(impl Into<String>)
/set_hours_of_operation_id(Option<String>)
:The identifier for the hours of operation.
- On success, responds with
UpdateQueueHoursOfOperationOutput
- On failure, responds with
SdkError<UpdateQueueHoursOfOperationError>
sourcepub fn update_queue_max_contacts(&self) -> UpdateQueueMaxContacts
pub fn update_queue_max_contacts(&self) -> UpdateQueueMaxContacts
Constructs a fluent builder for the UpdateQueueMaxContacts
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
max_contacts(i32)
/set_max_contacts(Option<i32>)
: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>
sourcepub fn update_queue_name(&self) -> UpdateQueueName
pub fn update_queue_name(&self) -> UpdateQueueName
Constructs a fluent builder for the UpdateQueueName
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the queue.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the queue.
- On success, responds with
UpdateQueueNameOutput
- On failure, responds with
SdkError<UpdateQueueNameError>
sourcepub fn update_queue_outbound_caller_config(
&self
) -> UpdateQueueOutboundCallerConfig
pub fn update_queue_outbound_caller_config(
&self
) -> UpdateQueueOutboundCallerConfig
Constructs a fluent builder for the UpdateQueueOutboundCallerConfig
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
outbound_caller_config(OutboundCallerConfig)
/set_outbound_caller_config(Option<OutboundCallerConfig>)
:The outbound caller ID name, number, and outbound whisper flow.
- On success, responds with
UpdateQueueOutboundCallerConfigOutput
- On failure, responds with
SdkError<UpdateQueueOutboundCallerConfigError>
sourcepub fn update_queue_status(&self) -> UpdateQueueStatus
pub fn update_queue_status(&self) -> UpdateQueueStatus
Constructs a fluent builder for the UpdateQueueStatus
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
queue_id(impl Into<String>)
/set_queue_id(Option<String>)
:The identifier for the queue.
status(QueueStatus)
/set_status(Option<QueueStatus>)
:The status of the queue.
- On success, responds with
UpdateQueueStatusOutput
- On failure, responds with
SdkError<UpdateQueueStatusError>
sourcepub fn update_quick_connect_config(&self) -> UpdateQuickConnectConfig
pub fn update_quick_connect_config(&self) -> UpdateQuickConnectConfig
Constructs a fluent builder for the UpdateQuickConnectConfig
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
quick_connect_id(impl Into<String>)
/set_quick_connect_id(Option<String>)
:The identifier for the quick connect.
quick_connect_config(QuickConnectConfig)
/set_quick_connect_config(Option<QuickConnectConfig>)
:Information about the configuration settings for the quick connect.
- On success, responds with
UpdateQuickConnectConfigOutput
- On failure, responds with
SdkError<UpdateQuickConnectConfigError>
sourcepub fn update_quick_connect_name(&self) -> UpdateQuickConnectName
pub fn update_quick_connect_name(&self) -> UpdateQuickConnectName
Constructs a fluent builder for the UpdateQuickConnectName
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
quick_connect_id(impl Into<String>)
/set_quick_connect_id(Option<String>)
:The identifier for the quick connect.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the quick connect.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the quick connect.
- On success, responds with
UpdateQuickConnectNameOutput
- On failure, responds with
SdkError<UpdateQuickConnectNameError>
sourcepub fn update_routing_profile_concurrency(
&self
) -> UpdateRoutingProfileConcurrency
pub fn update_routing_profile_concurrency(
&self
) -> UpdateRoutingProfileConcurrency
Constructs a fluent builder for the UpdateRoutingProfileConcurrency
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
media_concurrencies(Vec<MediaConcurrency>)
/set_media_concurrencies(Option<Vec<MediaConcurrency>>)
:The channels that agents can handle in the Contact Control Panel (CCP).
- On success, responds with
UpdateRoutingProfileConcurrencyOutput
- On failure, responds with
SdkError<UpdateRoutingProfileConcurrencyError>
sourcepub fn update_routing_profile_default_outbound_queue(
&self
) -> UpdateRoutingProfileDefaultOutboundQueue
pub fn update_routing_profile_default_outbound_queue(
&self
) -> UpdateRoutingProfileDefaultOutboundQueue
Constructs a fluent builder for the UpdateRoutingProfileDefaultOutboundQueue
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
default_outbound_queue_id(impl Into<String>)
/set_default_outbound_queue_id(Option<String>)
:The identifier for the default outbound queue.
- On success, responds with
UpdateRoutingProfileDefaultOutboundQueueOutput
- On failure, responds with
SdkError<UpdateRoutingProfileDefaultOutboundQueueError>
sourcepub fn update_routing_profile_name(&self) -> UpdateRoutingProfileName
pub fn update_routing_profile_name(&self) -> UpdateRoutingProfileName
Constructs a fluent builder for the UpdateRoutingProfileName
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the routing profile. Must not be more than 127 characters.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the routing profile. Must not be more than 250 characters.
- On success, responds with
UpdateRoutingProfileNameOutput
- On failure, responds with
SdkError<UpdateRoutingProfileNameError>
sourcepub fn update_routing_profile_queues(&self) -> UpdateRoutingProfileQueues
pub fn update_routing_profile_queues(&self) -> UpdateRoutingProfileQueues
Constructs a fluent builder for the UpdateRoutingProfileQueues
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
routing_profile_id(impl Into<String>)
/set_routing_profile_id(Option<String>)
:The identifier of the routing profile.
queue_configs(Vec<RoutingProfileQueueConfig>)
/set_queue_configs(Option<Vec<RoutingProfileQueueConfig>>)
: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>
sourcepub fn update_security_profile(&self) -> UpdateSecurityProfile
pub fn update_security_profile(&self) -> UpdateSecurityProfile
Constructs a fluent builder for the UpdateSecurityProfile
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:The description of the security profile.
permissions(Vec<String>)
/set_permissions(Option<Vec<String>>)
:The permissions granted to a security profile.
security_profile_id(impl Into<String>)
/set_security_profile_id(Option<String>)
:The identifier for the security profle.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateSecurityProfileOutput
- On failure, responds with
SdkError<UpdateSecurityProfileError>
sourcepub fn update_task_template(&self) -> UpdateTaskTemplate
pub fn update_task_template(&self) -> UpdateTaskTemplate
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>)
:A unique identifier for the task template.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the task template.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the task template.
contact_flow_id(impl Into<String>)
/set_contact_flow_id(Option<String>)
:The identifier of the flow that runs by default when a task is created by referencing this template.
constraints(TaskTemplateConstraints)
/set_constraints(Option<TaskTemplateConstraints>)
:Constraints that are applicable to the fields listed.
defaults(TaskTemplateDefaults)
/set_defaults(Option<TaskTemplateDefaults>)
:The default values for fields when a task is created by referencing this template.
status(TaskTemplateStatus)
/set_status(Option<TaskTemplateStatus>)
:Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created.fields(Vec<TaskTemplateField>)
/set_fields(Option<Vec<TaskTemplateField>>)
: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 instanceId in the 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
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, 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>
sourcepub fn update_user_hierarchy(&self) -> UpdateUserHierarchy
pub fn update_user_hierarchy(&self) -> UpdateUserHierarchy
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>)
:The identifier of the hierarchy group.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user account.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserHierarchyOutput
- On failure, responds with
SdkError<UpdateUserHierarchyError>
sourcepub fn update_user_hierarchy_group_name(&self) -> UpdateUserHierarchyGroupName
pub fn update_user_hierarchy_group_name(&self) -> UpdateUserHierarchyGroupName
Constructs a fluent builder for the UpdateUserHierarchyGroupName
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
:The identifier of the hierarchy group.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserHierarchyGroupNameOutput
- On failure, responds with
SdkError<UpdateUserHierarchyGroupNameError>
sourcepub fn update_user_hierarchy_structure(&self) -> UpdateUserHierarchyStructure
pub fn update_user_hierarchy_structure(&self) -> UpdateUserHierarchyStructure
Constructs a fluent builder for the UpdateUserHierarchyStructure
operation.
- The fluent builder is configurable:
hierarchy_structure(HierarchyStructureUpdate)
/set_hierarchy_structure(Option<HierarchyStructureUpdate>)
:The hierarchy levels to update.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserHierarchyStructureOutput
- On failure, responds with
SdkError<UpdateUserHierarchyStructureError>
sourcepub fn update_user_identity_info(&self) -> UpdateUserIdentityInfo
pub fn update_user_identity_info(&self) -> UpdateUserIdentityInfo
Constructs a fluent builder for the UpdateUserIdentityInfo
operation.
- The fluent builder is configurable:
identity_info(UserIdentityInfo)
/set_identity_info(Option<UserIdentityInfo>)
:The identity information for the user.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user account.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserIdentityInfoOutput
- On failure, responds with
SdkError<UpdateUserIdentityInfoError>
sourcepub fn update_user_phone_config(&self) -> UpdateUserPhoneConfig
pub fn update_user_phone_config(&self) -> UpdateUserPhoneConfig
Constructs a fluent builder for the UpdateUserPhoneConfig
operation.
- The fluent builder is configurable:
phone_config(UserPhoneConfig)
/set_phone_config(Option<UserPhoneConfig>)
:Information about phone configuration settings for the user.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user account.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserPhoneConfigOutput
- On failure, responds with
SdkError<UpdateUserPhoneConfigError>
sourcepub fn update_user_routing_profile(&self) -> UpdateUserRoutingProfile
pub fn update_user_routing_profile(&self) -> UpdateUserRoutingProfile
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>)
:The identifier of the routing profile for the user.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user account.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserRoutingProfileOutput
- On failure, responds with
SdkError<UpdateUserRoutingProfileError>
sourcepub fn update_user_security_profiles(&self) -> UpdateUserSecurityProfiles
pub fn update_user_security_profiles(&self) -> UpdateUserSecurityProfiles
Constructs a fluent builder for the UpdateUserSecurityProfiles
operation.
- The fluent builder is configurable:
security_profile_ids(Vec<String>)
/set_security_profile_ids(Option<Vec<String>>)
:The identifiers of the security profiles for the user.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The identifier of the user account.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- On success, responds with
UpdateUserSecurityProfilesOutput
- On failure, responds with
SdkError<UpdateUserSecurityProfilesError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more