Connectcampaigns

This page documents function available when using the Connectcampaigns module, created with @service Connectcampaigns.

Index

Documentation

Main.Connectcampaigns.create_campaign — Method
create_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 — Method
delete_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 — Method
delete_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 — Method
delete_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.get_campaign_state — Method
get_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 — Method
get_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 — Method
get_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 — Method
get_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 — Method
list_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.pause_campaign — Method
pause_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 — Method
put_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 — Method
resume_campaign(id)
resume_campaign(id, params::Dict{String,<:Any})

Stops a campaign for the specified Amazon Connect account.

Arguments

  • id:
Main.Connectcampaigns.start_campaign — Method
start_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 — Method
start_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 — Method
stop_campaign(id)
stop_campaign(id, params::Dict{String,<:Any})

Stops a campaign for the specified Amazon Connect account.

Arguments

  • id:
Main.Connectcampaigns.update_campaign_dialer_config — Method
update_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 — Method
update_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 — Method
update_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":