Struct Client

pub struct Client { /* private fields */ }

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

impl Client

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 Id
    
  • channel_subtype_config(ChannelSubtypeConfig) / set_channel_subtype_config(Option<ChannelSubtypeConfig>):
    required: true
    Campaign Channel Subtype config
    
  • source(Source) / set_source(Option<Source>):
    required: false
    Source of the campaign
    
  • connect_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 schedule
    
  • communication_time_config(CommunicationTimeConfig) / set_communication_time_config(Option<CommunicationTimeConfig>):
    required: false
    Campaign communication time config
    
  • communication_limits_override(CommunicationLimitsConfig) / set_communication_limits_override(Option<CommunicationLimitsConfig>):
    required: false
    Communication limits config
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    Tag map with key and value.
    
• On success, responds with CreateCampaignOutput with field(s):
  • id(Option<String>): Identifier representing a Campaign
  • arn(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>

impl Client

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>

impl Client

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 Campaign
    
  • channel_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>

impl Client

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 Campaign
    
  • config(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>

impl Client

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 Campaign
    
  • config(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>

impl Client

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 Id
    
  • campaign_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>

impl Client

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 Id
    
  • integration_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>

impl Client

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>

impl Client

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 DescribeCampaignOutput with field(s):
  • campaign(Option<Campaign>): An Amazon Connect campaign.
• On failure, responds with SdkError<DescribeCampaignError>

impl Client

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 GetCampaignStateOutput with field(s):
  • state(Option<CampaignState>): State of a campaign
• On failure, responds with SdkError<GetCampaignStateError>

impl Client

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 GetCampaignStateBatchOutput with field(s):
  • successful_requests(Option<Vec::<SuccessfulCampaignStateResponse>>): List of successful response of campaign state
  • failed_requests(Option<Vec::<FailedCampaignStateResponse>>): List of failed requests of campaign state
• On failure, responds with SdkError<GetCampaignStateBatchError>

impl Client

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 GetConnectInstanceConfigOutput with field(s):
  • connect_instance_config(Option<InstanceConfig>): Instance config object
• On failure, responds with SdkError<GetConnectInstanceConfigError>

impl Client

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 GetInstanceOnboardingJobStatusOutput with field(s):
  • connect_instance_onboarding_job_status(Option<InstanceOnboardingJobStatus>): Instance onboarding job status object
• On failure, responds with SdkError<GetInstanceOnboardingJobStatusError>

impl Client

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 ListCampaignsOutput with 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>

impl Client

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 Id
    
  • 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.
    
• On success, responds with ListConnectInstanceIntegrationsOutput with 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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

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 ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>): Tag map with key and value.
• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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>

impl Client

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 Id
    
  • integration_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>

impl Client

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 Campaign
    
  • outbound_requests(OutboundRequest) / set_outbound_requests(Option<Vec::<OutboundRequest>>):
    required: true
    A list of outbound requests.
    
• On success, responds with PutOutboundRequestBatchOutput with 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>

impl Client

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 Campaign
    
  • profile_outbound_requests(ProfileOutboundRequest) / set_profile_outbound_requests(Option<Vec::<ProfileOutboundRequest>>):
    required: true
    List of profile outbound requests
    
• On success, responds with PutProfileOutboundRequestBatchOutput with field(s):
  • successful_requests(Option<Vec::<SuccessfulProfileOutboundRequest>>): List of successful profile outbound requests
  • failed_requests(Option<Vec::<FailedProfileOutboundRequest>>): List of failed profile outbound requests
• On failure, responds with SdkError<PutProfileOutboundRequestBatchError>

impl Client

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>

impl Client

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>

impl Client

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 Id
    
  • encryption_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 StartInstanceOnboardingJobOutput with field(s):
  • connect_instance_onboarding_job_status(Option<InstanceOnboardingJobStatus>): Instance onboarding job status object
• On failure, responds with SdkError<StartInstanceOnboardingJobError>

impl Client

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>

impl Client

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>

impl Client

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>

impl Client

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 Campaign
    
  • channel_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>

impl Client

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 Campaign
    
  • communication_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>

impl Client

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 Campaign
    
  • communication_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>

impl Client

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 Campaign
    
  • connect_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>

impl Client

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 Campaign
    
  • name(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>

impl Client

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 Campaign
    
  • schedule(Schedule) / set_schedule(Option<Schedule>):
    required: true
    Campaign schedule
    
• On success, responds with UpdateCampaignScheduleOutput
• On failure, responds with SdkError<UpdateCampaignScheduleError>

impl Client

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 Campaign
    
  • source(Source) / set_source(Option<Source>):
    required: true
    Source of the campaign
    
• On success, responds with UpdateCampaignSourceOutput
• On failure, responds with SdkError<UpdateCampaignSourceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.