aws-elixir

View Source AWS.ConnectCampaignsV2 (aws-elixir v1.0.4)

Provide APIs to create and manage Amazon Connect Campaigns.

Link to this section Summary

Functions

create_campaign(client, input, options \\ [])

Creates a campaign for the specified Amazon Connect account.

delete_campaign(client, id, input, options \\ [])

Deletes a campaign from the specified Amazon Connect account.

delete_campaign_channel_subtype_config(client, id, input, options \\ [])

Deletes the channel subtype config of a campaign.

delete_campaign_communication_limits(client, id, input, options \\ [])

Deletes the communication limits config for a campaign.

delete_campaign_communication_time(client, id, input, options \\ [])

Deletes the communication time config for a campaign.

delete_connect_instance_config(client, connect_instance_id, input, options \\ [])

Deletes a connect instance config from the specified AWS account.

delete_connect_instance_integration(client, connect_instance_id, input, options \\ [])

Delete the integration for the specified Amazon Connect instance.

delete_instance_onboarding_job(client, connect_instance_id, input, options \\ [])

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

describe_campaign(client, id, options \\ [])

Describes the specific campaign.

get_campaign_state(client, id, options \\ [])

Get state of a campaign for the specified Amazon Connect account.

get_campaign_state_batch(client, input, options \\ [])

Get state of campaigns for the specified Amazon Connect account.

get_connect_instance_config(client, connect_instance_id, options \\ [])

Get the specific Connect instance config.

get_instance_onboarding_job_status(client, connect_instance_id, options \\ [])

Get the specific instance onboarding job status.

list_campaigns(client, input, options \\ [])

Provides summary information about the campaigns under the specified Amazon Connect account.

list_connect_instance_integrations(client, connect_instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

Provides summary information about the integration under the specified Connect instance.

list_tags_for_resource(client, arn, options \\ [])

List tags for a resource.

metadata()
pause_campaign(client, id, input, options \\ [])

Pauses a campaign for the specified Amazon Connect account.

put_connect_instance_integration(client, connect_instance_id, input, options \\ [])

Put or update the integration for the specified Amazon Connect instance.

put_outbound_request_batch(client, id, input, options \\ [])

Creates outbound requests for the specified campaign Amazon Connect account.

put_profile_outbound_request_batch(client, id, input, options \\ [])

Takes in a list of profile outbound requests to be placed as part of an outbound campaign.

resume_campaign(client, id, input, options \\ [])

Stops a campaign for the specified Amazon Connect account.

start_campaign(client, id, input, options \\ [])

Starts a campaign for the specified Amazon Connect account.

start_instance_onboarding_job(client, connect_instance_id, input, options \\ [])

Onboard the specific Amazon Connect instance to Connect Campaigns.

stop_campaign(client, id, input, options \\ [])

Stops a campaign for the specified Amazon Connect account.

tag_resource(client, arn, input, options \\ [])

Tag a resource.

untag_resource(client, arn, input, options \\ [])

Untag a resource.

update_campaign_channel_subtype_config(client, id, input, options \\ [])

Updates the channel subtype config of a campaign.

update_campaign_communication_limits(client, id, input, options \\ [])

Updates the communication limits config for a campaign.

update_campaign_communication_time(client, id, input, options \\ [])

Updates the communication time config for a campaign.

update_campaign_flow_association(client, id, input, options \\ [])

Updates the campaign flow associated with a campaign.

update_campaign_name(client, id, input, options \\ [])

Updates the name of a campaign.

update_campaign_schedule(client, id, input, options \\ [])

Updates the schedule for a campaign.

update_campaign_source(client, id, input, options \\ [])

Updates the campaign source with a campaign.

Link to this section Functions

Link to this function

create_campaign(client, input, options \\ [])

View Source

Creates a campaign for the specified Amazon Connect account.

This API is idempotent.

Link to this function

delete_campaign(client, id, input, options \\ [])

View Source

Deletes a campaign from the specified Amazon Connect account.

Link to this function

delete_campaign_channel_subtype_config(client, id, input, options \\ [])

View Source

Deletes the channel subtype config of a campaign.

This API is idempotent.

Link to this function

delete_campaign_communication_limits(client, id, input, options \\ [])

View Source

Deletes the communication limits config for a campaign.

This API is idempotent.

Link to this function

delete_campaign_communication_time(client, id, input, options \\ [])

View Source

Deletes the communication time config for a campaign.

This API is idempotent.

Link to this function

delete_connect_instance_config(client, connect_instance_id, input, options \\ [])

View Source

Deletes a connect instance config from the specified AWS account.

Link to this function

delete_connect_instance_integration(client, connect_instance_id, input, options \\ [])

View Source

Delete the integration for the specified Amazon Connect instance.

Link to this function

delete_instance_onboarding_job(client, connect_instance_id, input, options \\ [])

View Source

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

Link to this function

describe_campaign(client, id, options \\ [])

View Source

Describes the specific campaign.

Link to this function

get_campaign_state(client, id, options \\ [])

View Source

Get state of a campaign for the specified Amazon Connect account.

Link to this function

get_campaign_state_batch(client, input, options \\ [])

View Source

Get state of campaigns for the specified Amazon Connect account.

Link to this function

get_connect_instance_config(client, connect_instance_id, options \\ [])

View Source

Get the specific Connect instance config.

Link to this function

get_instance_onboarding_job_status(client, connect_instance_id, options \\ [])

View Source

Get the specific instance onboarding job status.

Link to this function

list_campaigns(client, input, options \\ [])

View Source

Provides summary information about the campaigns under the specified Amazon Connect account.

Link to this function

list_connect_instance_integrations(client, connect_instance_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Provides summary information about the integration under the specified Connect instance.

Link to this function

list_tags_for_resource(client, arn, options \\ [])

View Source

List tags for a resource.

Link to this function

metadata()

View Source
Link to this function

pause_campaign(client, id, input, options \\ [])

View Source

Pauses a campaign for the specified Amazon Connect account.

Link to this function

put_connect_instance_integration(client, connect_instance_id, input, options \\ [])

View Source

Put or update the integration for the specified Amazon Connect instance.

Link to this function

put_outbound_request_batch(client, id, input, options \\ [])

View Source

Creates outbound requests for the specified campaign Amazon Connect account.

This API is idempotent.

Link to this function

put_profile_outbound_request_batch(client, id, input, options \\ [])

View Source

Takes in a list of profile outbound requests to be placed as part of an outbound campaign.

This API is idempotent.

Link to this function

resume_campaign(client, id, input, options \\ [])

View Source

Stops a campaign for the specified Amazon Connect account.

Link to this function

start_campaign(client, id, input, options \\ [])

View Source

Starts a campaign for the specified Amazon Connect account.

Link to this function

start_instance_onboarding_job(client, connect_instance_id, input, options \\ [])

View Source

Onboard the specific Amazon Connect instance to Connect Campaigns.

Link to this function

stop_campaign(client, id, input, options \\ [])

View Source

Stops a campaign for the specified Amazon Connect account.

Link to this function

tag_resource(client, arn, input, options \\ [])

View Source

Tag a resource.

Link to this function

untag_resource(client, arn, input, options \\ [])

View Source

Untag a resource.

Link to this function

update_campaign_channel_subtype_config(client, id, input, options \\ [])

View Source

Updates the channel subtype config of a campaign.

This API is idempotent.

Link to this function

update_campaign_communication_limits(client, id, input, options \\ [])

View Source

Updates the communication limits config for a campaign.

This API is idempotent.

Link to this function

update_campaign_communication_time(client, id, input, options \\ [])

View Source

Updates the communication time config for a campaign.

This API is idempotent.

Link to this function

update_campaign_flow_association(client, id, input, options \\ [])

View Source

Updates the campaign flow associated with a campaign.

This API is idempotent.

Link to this function

update_campaign_name(client, id, input, options \\ [])

View Source

Updates the name of a campaign.

This API is idempotent.

Link to this function

update_campaign_schedule(client, id, input, options \\ [])

View Source

Updates the schedule for a campaign.

This API is idempotent.

Link to this function

update_campaign_source(client, id, input, options \\ [])

View Source

Updates the campaign source with a campaign.

This API is idempotent.