Connectcampaigns
This page documents function available when using the Connectcampaigns module, created with @service Connectcampaigns.
Index
Main.Connectcampaigns.create_campaignMain.Connectcampaigns.delete_campaignMain.Connectcampaigns.delete_connect_instance_configMain.Connectcampaigns.delete_instance_onboarding_jobMain.Connectcampaigns.describe_campaignMain.Connectcampaigns.get_campaign_stateMain.Connectcampaigns.get_campaign_state_batchMain.Connectcampaigns.get_connect_instance_configMain.Connectcampaigns.get_instance_onboarding_job_statusMain.Connectcampaigns.list_campaignsMain.Connectcampaigns.list_tags_for_resourceMain.Connectcampaigns.pause_campaignMain.Connectcampaigns.put_dial_request_batchMain.Connectcampaigns.resume_campaignMain.Connectcampaigns.start_campaignMain.Connectcampaigns.start_instance_onboarding_jobMain.Connectcampaigns.stop_campaignMain.Connectcampaigns.tag_resourceMain.Connectcampaigns.untag_resourceMain.Connectcampaigns.update_campaign_dialer_configMain.Connectcampaigns.update_campaign_nameMain.Connectcampaigns.update_campaign_outbound_call_config
Documentation
Main.Connectcampaigns.create_campaign — Methodcreate_campaign(connect_instance_id, dialer_config, name, outbound_call_config)
create_campaign(connect_instance_id, dialer_config, name, outbound_call_config, params::Dict{String,<:Any})Creates a campaign for the specified Amazon Connect account. This API is idempotent.
Arguments
connect_instance_id:dialer_config:name:outbound_call_config:
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"tags":
Main.Connectcampaigns.delete_campaign — Methoddelete_campaign(id)
delete_campaign(id, params::Dict{String,<:Any})Deletes a campaign from the specified Amazon Connect account.
Arguments
id:
Main.Connectcampaigns.delete_connect_instance_config — Methoddelete_connect_instance_config(connect_instance_id)
delete_connect_instance_config(connect_instance_id, params::Dict{String,<:Any})Deletes a connect instance config from the specified AWS account.
Arguments
connect_instance_id:
Main.Connectcampaigns.delete_instance_onboarding_job — Methoddelete_instance_onboarding_job(connect_instance_id)
delete_instance_onboarding_job(connect_instance_id, params::Dict{String,<:Any})Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
Arguments
connect_instance_id:
Main.Connectcampaigns.describe_campaign — Methoddescribe_campaign(id)
describe_campaign(id, params::Dict{String,<:Any})Describes the specific campaign.
Arguments
id:
Main.Connectcampaigns.get_campaign_state — Methodget_campaign_state(id)
get_campaign_state(id, params::Dict{String,<:Any})Get state of a campaign for the specified Amazon Connect account.
Arguments
id:
Main.Connectcampaigns.get_campaign_state_batch — Methodget_campaign_state_batch(campaign_ids)
get_campaign_state_batch(campaign_ids, params::Dict{String,<:Any})Get state of campaigns for the specified Amazon Connect account.
Arguments
campaign_ids:
Main.Connectcampaigns.get_connect_instance_config — Methodget_connect_instance_config(connect_instance_id)
get_connect_instance_config(connect_instance_id, params::Dict{String,<:Any})Get the specific Connect instance config.
Arguments
connect_instance_id:
Main.Connectcampaigns.get_instance_onboarding_job_status — Methodget_instance_onboarding_job_status(connect_instance_id)
get_instance_onboarding_job_status(connect_instance_id, params::Dict{String,<:Any})Get the specific instance onboarding job status.
Arguments
connect_instance_id:
Main.Connectcampaigns.list_campaigns — Methodlist_campaigns()
list_campaigns(params::Dict{String,<:Any})Provides summary information about the campaigns under the specified Amazon Connect account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"filters":"maxResults":"nextToken":
Main.Connectcampaigns.list_tags_for_resource — Methodlist_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})List tags for a resource.
Arguments
arn:
Main.Connectcampaigns.pause_campaign — Methodpause_campaign(id)
pause_campaign(id, params::Dict{String,<:Any})Pauses a campaign for the specified Amazon Connect account.
Arguments
id:
Main.Connectcampaigns.put_dial_request_batch — Methodput_dial_request_batch(dial_requests, id)
put_dial_request_batch(dial_requests, id, params::Dict{String,<:Any})Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
Arguments
dial_requests:id:
Main.Connectcampaigns.resume_campaign — Methodresume_campaign(id)
resume_campaign(id, params::Dict{String,<:Any})Stops a campaign for the specified Amazon Connect account.
Arguments
id:
Main.Connectcampaigns.start_campaign — Methodstart_campaign(id)
start_campaign(id, params::Dict{String,<:Any})Starts a campaign for the specified Amazon Connect account.
Arguments
id:
Main.Connectcampaigns.start_instance_onboarding_job — Methodstart_instance_onboarding_job(connect_instance_id, encryption_config)
start_instance_onboarding_job(connect_instance_id, encryption_config, params::Dict{String,<:Any})Onboard the specific Amazon Connect instance to Connect Campaigns.
Arguments
connect_instance_id:encryption_config:
Main.Connectcampaigns.stop_campaign — Methodstop_campaign(id)
stop_campaign(id, params::Dict{String,<:Any})Stops a campaign for the specified Amazon Connect account.
Arguments
id:
Main.Connectcampaigns.tag_resource — Methodtag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})Tag a resource.
Arguments
arn:tags:
Main.Connectcampaigns.untag_resource — Methoduntag_resource(arn, tag_keys)
untag_resource(arn, tag_keys, params::Dict{String,<:Any})Untag a resource.
Arguments
arn:tag_keys:
Main.Connectcampaigns.update_campaign_dialer_config — Methodupdate_campaign_dialer_config(dialer_config, id)
update_campaign_dialer_config(dialer_config, id, params::Dict{String,<:Any})Updates the dialer config of a campaign. This API is idempotent.
Arguments
dialer_config:id:
Main.Connectcampaigns.update_campaign_name — Methodupdate_campaign_name(id, name)
update_campaign_name(id, name, params::Dict{String,<:Any})Updates the name of a campaign. This API is idempotent.
Arguments
id:name:
Main.Connectcampaigns.update_campaign_outbound_call_config — Methodupdate_campaign_outbound_call_config(id)
update_campaign_outbound_call_config(id, params::Dict{String,<:Any})Updates the outbound call config of a campaign. This API is idempotent.
Arguments
id:
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"answerMachineDetectionConfig":"connectContactFlowId":"connectSourcePhoneNumber":