pub struct Client { /* private fields */ }Expand description
Client for AmazonConnectCampaignServiceV2
Client for invoking operations on AmazonConnectCampaignServiceV2. Each operation on AmazonConnectCampaignServiceV2 is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env() instead, which returns a ConfigLoader that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_connectcampaignsv2::Client::new(&config);Occasionally, SDKs may have additional service-specific values that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Builder struct implements From<&SdkConfig>, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_connectcampaignsv2::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();See the aws-config docs and Config for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateCampaign operation has
a Client::create_campaign, function which returns a builder for that operation.
The fluent builder ultimately has a send() function that returns an async future that
returns a result, as illustrated below:
let result = client.create_campaign()
.name("example")
.send()
.await;The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn create_campaign(&self) -> CreateCampaignFluentBuilder
pub fn create_campaign(&self) -> CreateCampaignFluentBuilder
Constructs a fluent builder for the CreateCampaign operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):
required: true
The name of an Amazon Connect Campaign name.connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idchannel_subtype_config(ChannelSubtypeConfig)/set_channel_subtype_config(Option<ChannelSubtypeConfig>):
required: false
Campaign Channel Subtype configr#type(ExternalCampaignType)/set_type(Option<ExternalCampaignType>):
required: false
The type of campaign externally exposed in APIs.source(Source)/set_source(Option<Source>):
required: false
Source of the campaignconnect_campaign_flow_arn(impl Into<String>)/set_connect_campaign_flow_arn(Option<String>):
required: false
Amazon Resource Names(ARN)schedule(Schedule)/set_schedule(Option<Schedule>):
required: false
Campaign schedulecommunication_time_config(CommunicationTimeConfig)/set_communication_time_config(Option<CommunicationTimeConfig>):
required: false
Campaign communication time configcommunication_limits_override(CommunicationLimitsConfig)/set_communication_limits_override(Option<CommunicationLimitsConfig>):
required: false
Communication limits configtags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: false
Tag map with key and value.
- On success, responds with
CreateCampaignOutputwith field(s):id(Option<String>): Identifier representing a Campaignarn(Option<String>): The resource name of an Amazon Connect campaign.tags(Option<HashMap::<String, String>>): Tag map with key and value.
- On failure, responds with
SdkError<CreateCampaignError>
Source§impl Client
impl Client
Sourcepub fn delete_campaign(&self) -> DeleteCampaignFluentBuilder
pub fn delete_campaign(&self) -> DeleteCampaignFluentBuilder
Constructs a fluent builder for the DeleteCampaign operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
DeleteCampaignOutput - On failure, responds with
SdkError<DeleteCampaignError>
Source§impl Client
impl Client
Sourcepub fn delete_campaign_channel_subtype_config(
&self,
) -> DeleteCampaignChannelSubtypeConfigFluentBuilder
pub fn delete_campaign_channel_subtype_config( &self, ) -> DeleteCampaignChannelSubtypeConfigFluentBuilder
Constructs a fluent builder for the DeleteCampaignChannelSubtypeConfig operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignchannel_subtype(ChannelSubtype)/set_channel_subtype(Option<ChannelSubtype>):
required: true
The type of campaign channel subtype.
- On success, responds with
DeleteCampaignChannelSubtypeConfigOutput - On failure, responds with
SdkError<DeleteCampaignChannelSubtypeConfigError>
Source§impl Client
impl Client
Sourcepub fn delete_campaign_communication_limits(
&self,
) -> DeleteCampaignCommunicationLimitsFluentBuilder
pub fn delete_campaign_communication_limits( &self, ) -> DeleteCampaignCommunicationLimitsFluentBuilder
Constructs a fluent builder for the DeleteCampaignCommunicationLimits operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignconfig(CommunicationLimitsConfigType)/set_config(Option<CommunicationLimitsConfigType>):
required: true
The type of campaign communication limits config.
- On success, responds with
DeleteCampaignCommunicationLimitsOutput - On failure, responds with
SdkError<DeleteCampaignCommunicationLimitsError>
Source§impl Client
impl Client
Sourcepub fn delete_campaign_communication_time(
&self,
) -> DeleteCampaignCommunicationTimeFluentBuilder
pub fn delete_campaign_communication_time( &self, ) -> DeleteCampaignCommunicationTimeFluentBuilder
Constructs a fluent builder for the DeleteCampaignCommunicationTime operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignconfig(CommunicationTimeConfigType)/set_config(Option<CommunicationTimeConfigType>):
required: true
The type of campaign communication time config
- On success, responds with
DeleteCampaignCommunicationTimeOutput - On failure, responds with
SdkError<DeleteCampaignCommunicationTimeError>
Source§impl Client
impl Client
Sourcepub fn delete_connect_instance_config(
&self,
) -> DeleteConnectInstanceConfigFluentBuilder
pub fn delete_connect_instance_config( &self, ) -> DeleteConnectInstanceConfigFluentBuilder
Constructs a fluent builder for the DeleteConnectInstanceConfig operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idcampaign_deletion_policy(CampaignDeletionPolicy)/set_campaign_deletion_policy(Option<CampaignDeletionPolicy>):
required: false
Enumeration of the policies to enact on existing campaigns during instance config deletion
- On success, responds with
DeleteConnectInstanceConfigOutput - On failure, responds with
SdkError<DeleteConnectInstanceConfigError>
Source§impl Client
impl Client
Sourcepub fn delete_connect_instance_integration(
&self,
) -> DeleteConnectInstanceIntegrationFluentBuilder
pub fn delete_connect_instance_integration( &self, ) -> DeleteConnectInstanceIntegrationFluentBuilder
Constructs a fluent builder for the DeleteConnectInstanceIntegration operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idintegration_identifier(IntegrationIdentifier)/set_integration_identifier(Option<IntegrationIdentifier>):
required: true
Integration identifier for Connect instance
- On success, responds with
DeleteConnectInstanceIntegrationOutput - On failure, responds with
SdkError<DeleteConnectInstanceIntegrationError>
Source§impl Client
impl Client
Sourcepub fn delete_instance_onboarding_job(
&self,
) -> DeleteInstanceOnboardingJobFluentBuilder
pub fn delete_instance_onboarding_job( &self, ) -> DeleteInstanceOnboardingJobFluentBuilder
Constructs a fluent builder for the DeleteInstanceOnboardingJob operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Id
- On success, responds with
DeleteInstanceOnboardingJobOutput - On failure, responds with
SdkError<DeleteInstanceOnboardingJobError>
Source§impl Client
impl Client
Sourcepub fn describe_campaign(&self) -> DescribeCampaignFluentBuilder
pub fn describe_campaign(&self) -> DescribeCampaignFluentBuilder
Constructs a fluent builder for the DescribeCampaign operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
DescribeCampaignOutputwith field(s):campaign(Option<Campaign>): An Amazon Connect campaign.
- On failure, responds with
SdkError<DescribeCampaignError>
Source§impl Client
impl Client
Sourcepub fn get_campaign_state(&self) -> GetCampaignStateFluentBuilder
pub fn get_campaign_state(&self) -> GetCampaignStateFluentBuilder
Constructs a fluent builder for the GetCampaignState operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
GetCampaignStateOutputwith field(s):state(Option<CampaignState>): State of a campaign
- On failure, responds with
SdkError<GetCampaignStateError>
Source§impl Client
impl Client
Sourcepub fn get_campaign_state_batch(&self) -> GetCampaignStateBatchFluentBuilder
pub fn get_campaign_state_batch(&self) -> GetCampaignStateBatchFluentBuilder
Constructs a fluent builder for the GetCampaignStateBatch operation.
- The fluent builder is configurable:
campaign_ids(impl Into<String>)/set_campaign_ids(Option<Vec::<String>>):
required: true
List of CampaignId
- On success, responds with
GetCampaignStateBatchOutputwith field(s):successful_requests(Option<Vec::<SuccessfulCampaignStateResponse>>): List of successful response of campaign statefailed_requests(Option<Vec::<FailedCampaignStateResponse>>): List of failed requests of campaign state
- On failure, responds with
SdkError<GetCampaignStateBatchError>
Source§impl Client
impl Client
Sourcepub fn get_connect_instance_config(
&self,
) -> GetConnectInstanceConfigFluentBuilder
pub fn get_connect_instance_config( &self, ) -> GetConnectInstanceConfigFluentBuilder
Constructs a fluent builder for the GetConnectInstanceConfig operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Id
- On success, responds with
GetConnectInstanceConfigOutputwith field(s):connect_instance_config(Option<InstanceConfig>): Instance config object
- On failure, responds with
SdkError<GetConnectInstanceConfigError>
Source§impl Client
impl Client
Sourcepub fn get_instance_communication_limits(
&self,
) -> GetInstanceCommunicationLimitsFluentBuilder
pub fn get_instance_communication_limits( &self, ) -> GetInstanceCommunicationLimitsFluentBuilder
Constructs a fluent builder for the GetInstanceCommunicationLimits operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Id
- On success, responds with
GetInstanceCommunicationLimitsOutputwith field(s):communication_limits_config(Option<InstanceCommunicationLimitsConfig>): Instance Communication limits config
- On failure, responds with
SdkError<GetInstanceCommunicationLimitsError>
Source§impl Client
impl Client
Sourcepub fn get_instance_onboarding_job_status(
&self,
) -> GetInstanceOnboardingJobStatusFluentBuilder
pub fn get_instance_onboarding_job_status( &self, ) -> GetInstanceOnboardingJobStatusFluentBuilder
Constructs a fluent builder for the GetInstanceOnboardingJobStatus operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Id
- On success, responds with
GetInstanceOnboardingJobStatusOutputwith field(s):connect_instance_onboarding_job_status(Option<InstanceOnboardingJobStatus>): Instance onboarding job status object
- On failure, responds with
SdkError<GetInstanceOnboardingJobStatusError>
Source§impl Client
impl Client
Sourcepub fn list_campaigns(&self) -> ListCampaignsFluentBuilder
pub fn list_campaigns(&self) -> ListCampaignsFluentBuilder
Constructs a fluent builder for the ListCampaigns operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: false
The maximum number of results to return per page.next_token(impl Into<String>)/set_next_token(Option<String>):
required: false
The token for the next set of results.filters(CampaignFilters)/set_filters(Option<CampaignFilters>):
required: false
Filter model by type
- On success, responds with
ListCampaignsOutputwith field(s):next_token(Option<String>): The token for the next set of results.campaign_summary_list(Option<Vec::<CampaignSummary>>): A list of Amazon Connect campaigns.
- On failure, responds with
SdkError<ListCampaignsError>
Source§impl Client
impl Client
Sourcepub fn list_connect_instance_integrations(
&self,
) -> ListConnectInstanceIntegrationsFluentBuilder
pub fn list_connect_instance_integrations( &self, ) -> ListConnectInstanceIntegrationsFluentBuilder
Constructs a fluent builder for the ListConnectInstanceIntegrations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idmax_results(i32)/set_max_results(Option<i32>):
required: false
The maximum number of results to return per page.next_token(impl Into<String>)/set_next_token(Option<String>):
required: false
The token for the next set of results.
- On success, responds with
ListConnectInstanceIntegrationsOutputwith field(s):next_token(Option<String>): The token for the next set of results.integration_summary_list(Option<Vec::<IntegrationSummary>>): A list of Amazon Connect Instance Integrations.
- On failure, responds with
SdkError<ListConnectInstanceIntegrationsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: true
Amazon Resource Names(ARN)
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap::<String, String>>): Tag map with key and value.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn pause_campaign(&self) -> PauseCampaignFluentBuilder
pub fn pause_campaign(&self) -> PauseCampaignFluentBuilder
Constructs a fluent builder for the PauseCampaign operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
PauseCampaignOutput - On failure, responds with
SdkError<PauseCampaignError>
Source§impl Client
impl Client
Sourcepub fn put_connect_instance_integration(
&self,
) -> PutConnectInstanceIntegrationFluentBuilder
pub fn put_connect_instance_integration( &self, ) -> PutConnectInstanceIntegrationFluentBuilder
Constructs a fluent builder for the PutConnectInstanceIntegration operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idintegration_config(IntegrationConfig)/set_integration_config(Option<IntegrationConfig>):
required: true
Integration config for Connect Instance
- On success, responds with
PutConnectInstanceIntegrationOutput - On failure, responds with
SdkError<PutConnectInstanceIntegrationError>
Source§impl Client
impl Client
Sourcepub fn put_instance_communication_limits(
&self,
) -> PutInstanceCommunicationLimitsFluentBuilder
pub fn put_instance_communication_limits( &self, ) -> PutInstanceCommunicationLimitsFluentBuilder
Constructs a fluent builder for the PutInstanceCommunicationLimits operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idcommunication_limits_config(InstanceCommunicationLimitsConfig)/set_communication_limits_config(Option<InstanceCommunicationLimitsConfig>):
required: true
Instance Communication limits config
- On success, responds with
PutInstanceCommunicationLimitsOutput - On failure, responds with
SdkError<PutInstanceCommunicationLimitsError>
Source§impl Client
impl Client
Sourcepub fn put_outbound_request_batch(&self) -> PutOutboundRequestBatchFluentBuilder
pub fn put_outbound_request_batch(&self) -> PutOutboundRequestBatchFluentBuilder
Constructs a fluent builder for the PutOutboundRequestBatch operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignoutbound_requests(OutboundRequest)/set_outbound_requests(Option<Vec::<OutboundRequest>>):
required: true
A list of outbound requests.
- On success, responds with
PutOutboundRequestBatchOutputwith field(s):successful_requests(Option<Vec::<SuccessfulRequest>>): A list of successful requests identified by the unique client token.failed_requests(Option<Vec::<FailedRequest>>): A list of failed requests.
- On failure, responds with
SdkError<PutOutboundRequestBatchError>
Source§impl Client
impl Client
Sourcepub fn put_profile_outbound_request_batch(
&self,
) -> PutProfileOutboundRequestBatchFluentBuilder
pub fn put_profile_outbound_request_batch( &self, ) -> PutProfileOutboundRequestBatchFluentBuilder
Constructs a fluent builder for the PutProfileOutboundRequestBatch operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignprofile_outbound_requests(ProfileOutboundRequest)/set_profile_outbound_requests(Option<Vec::<ProfileOutboundRequest>>):
required: true
List of profile outbound requests
- On success, responds with
PutProfileOutboundRequestBatchOutputwith field(s):successful_requests(Option<Vec::<SuccessfulProfileOutboundRequest>>): List of successful profile outbound requestsfailed_requests(Option<Vec::<FailedProfileOutboundRequest>>): List of failed profile outbound requests
- On failure, responds with
SdkError<PutProfileOutboundRequestBatchError>
Source§impl Client
impl Client
Sourcepub fn resume_campaign(&self) -> ResumeCampaignFluentBuilder
pub fn resume_campaign(&self) -> ResumeCampaignFluentBuilder
Constructs a fluent builder for the ResumeCampaign operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
ResumeCampaignOutput - On failure, responds with
SdkError<ResumeCampaignError>
Source§impl Client
impl Client
Sourcepub fn start_campaign(&self) -> StartCampaignFluentBuilder
pub fn start_campaign(&self) -> StartCampaignFluentBuilder
Constructs a fluent builder for the StartCampaign operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
StartCampaignOutput - On failure, responds with
SdkError<StartCampaignError>
Source§impl Client
impl Client
Sourcepub fn start_instance_onboarding_job(
&self,
) -> StartInstanceOnboardingJobFluentBuilder
pub fn start_instance_onboarding_job( &self, ) -> StartInstanceOnboardingJobFluentBuilder
Constructs a fluent builder for the StartInstanceOnboardingJob operation.
- The fluent builder is configurable:
connect_instance_id(impl Into<String>)/set_connect_instance_id(Option<String>):
required: true
Amazon Connect Instance Idencryption_config(EncryptionConfig)/set_encryption_config(Option<EncryptionConfig>):
required: true
Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
- On success, responds with
StartInstanceOnboardingJobOutputwith field(s):connect_instance_onboarding_job_status(Option<InstanceOnboardingJobStatus>): Instance onboarding job status object
- On failure, responds with
SdkError<StartInstanceOnboardingJobError>
Source§impl Client
impl Client
Sourcepub fn stop_campaign(&self) -> StopCampaignFluentBuilder
pub fn stop_campaign(&self) -> StopCampaignFluentBuilder
Constructs a fluent builder for the StopCampaign operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaign
- On success, responds with
StopCampaignOutput - On failure, responds with
SdkError<StopCampaignError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: true
Amazon Resource Names(ARN)tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: true
Tag map with key and value.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
arn(impl Into<String>)/set_arn(Option<String>):
required: true
Amazon Resource Names(ARN)tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: true
List of tag keys.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_channel_subtype_config(
&self,
) -> UpdateCampaignChannelSubtypeConfigFluentBuilder
pub fn update_campaign_channel_subtype_config( &self, ) -> UpdateCampaignChannelSubtypeConfigFluentBuilder
Constructs a fluent builder for the UpdateCampaignChannelSubtypeConfig operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignchannel_subtype_config(ChannelSubtypeConfig)/set_channel_subtype_config(Option<ChannelSubtypeConfig>):
required: true
Campaign Channel Subtype config
- On success, responds with
UpdateCampaignChannelSubtypeConfigOutput - On failure, responds with
SdkError<UpdateCampaignChannelSubtypeConfigError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_communication_limits(
&self,
) -> UpdateCampaignCommunicationLimitsFluentBuilder
pub fn update_campaign_communication_limits( &self, ) -> UpdateCampaignCommunicationLimitsFluentBuilder
Constructs a fluent builder for the UpdateCampaignCommunicationLimits operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaigncommunication_limits_override(CommunicationLimitsConfig)/set_communication_limits_override(Option<CommunicationLimitsConfig>):
required: true
Communication limits config
- On success, responds with
UpdateCampaignCommunicationLimitsOutput - On failure, responds with
SdkError<UpdateCampaignCommunicationLimitsError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_communication_time(
&self,
) -> UpdateCampaignCommunicationTimeFluentBuilder
pub fn update_campaign_communication_time( &self, ) -> UpdateCampaignCommunicationTimeFluentBuilder
Constructs a fluent builder for the UpdateCampaignCommunicationTime operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaigncommunication_time_config(CommunicationTimeConfig)/set_communication_time_config(Option<CommunicationTimeConfig>):
required: true
Campaign communication time config
- On success, responds with
UpdateCampaignCommunicationTimeOutput - On failure, responds with
SdkError<UpdateCampaignCommunicationTimeError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_flow_association(
&self,
) -> UpdateCampaignFlowAssociationFluentBuilder
pub fn update_campaign_flow_association( &self, ) -> UpdateCampaignFlowAssociationFluentBuilder
Constructs a fluent builder for the UpdateCampaignFlowAssociation operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignconnect_campaign_flow_arn(impl Into<String>)/set_connect_campaign_flow_arn(Option<String>):
required: true
Amazon Resource Names(ARN)
- On success, responds with
UpdateCampaignFlowAssociationOutput - On failure, responds with
SdkError<UpdateCampaignFlowAssociationError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_name(&self) -> UpdateCampaignNameFluentBuilder
pub fn update_campaign_name(&self) -> UpdateCampaignNameFluentBuilder
Constructs a fluent builder for the UpdateCampaignName operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignname(impl Into<String>)/set_name(Option<String>):
required: true
The name of an Amazon Connect Campaign name.
- On success, responds with
UpdateCampaignNameOutput - On failure, responds with
SdkError<UpdateCampaignNameError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_schedule(&self) -> UpdateCampaignScheduleFluentBuilder
pub fn update_campaign_schedule(&self) -> UpdateCampaignScheduleFluentBuilder
Constructs a fluent builder for the UpdateCampaignSchedule operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignschedule(Schedule)/set_schedule(Option<Schedule>):
required: true
Campaign schedule
- On success, responds with
UpdateCampaignScheduleOutput - On failure, responds with
SdkError<UpdateCampaignScheduleError>
Source§impl Client
impl Client
Sourcepub fn update_campaign_source(&self) -> UpdateCampaignSourceFluentBuilder
pub fn update_campaign_source(&self) -> UpdateCampaignSourceFluentBuilder
Constructs a fluent builder for the UpdateCampaignSource operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):
required: true
Identifier representing a Campaignsource(Source)/set_source(Option<Source>):
required: true
Source of the campaign
- On success, responds with
UpdateCampaignSourceOutput - On failure, responds with
SdkError<UpdateCampaignSourceError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);