Class: Aws::ConnectCampaignService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConnectCampaignService::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb
Overview
An API client for ConnectCampaignService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ConnectCampaignService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates a campaign for the specified Amazon Connect account.
-
#delete_campaign(params = {}) ⇒ Struct
Deletes a campaign from the specified Amazon Connect account.
-
#delete_connect_instance_config(params = {}) ⇒ Struct
Deletes a connect instance config from the specified AWS account.
-
#delete_instance_onboarding_job(params = {}) ⇒ Struct
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
-
#describe_campaign(params = {}) ⇒ Types::DescribeCampaignResponse
Describes the specific campaign.
-
#get_campaign_state(params = {}) ⇒ Types::GetCampaignStateResponse
Get state of a campaign for the specified Amazon Connect account.
-
#get_campaign_state_batch(params = {}) ⇒ Types::GetCampaignStateBatchResponse
Get state of campaigns for the specified Amazon Connect account.
-
#get_connect_instance_config(params = {}) ⇒ Types::GetConnectInstanceConfigResponse
Get the specific Connect instance config.
-
#get_instance_onboarding_job_status(params = {}) ⇒ Types::GetInstanceOnboardingJobStatusResponse
Get the specific instance onboarding job status.
-
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Provides summary information about the campaigns under the specified Amazon Connect account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags for a resource.
-
#pause_campaign(params = {}) ⇒ Struct
Pauses a campaign for the specified Amazon Connect account.
-
#put_dial_request_batch(params = {}) ⇒ Types::PutDialRequestBatchResponse
Creates dials requests for the specified campaign Amazon Connect account.
-
#resume_campaign(params = {}) ⇒ Struct
Stops a campaign for the specified Amazon Connect account.
-
#start_campaign(params = {}) ⇒ Struct
Starts a campaign for the specified Amazon Connect account.
-
#start_instance_onboarding_job(params = {}) ⇒ Types::StartInstanceOnboardingJobResponse
Onboard the specific Amazon Connect instance to Connect Campaigns.
-
#stop_campaign(params = {}) ⇒ Struct
Stops a campaign for the specified Amazon Connect account.
-
#tag_resource(params = {}) ⇒ Struct
Tag a resource.
-
#untag_resource(params = {}) ⇒ Struct
Untag a resource.
-
#update_campaign_dialer_config(params = {}) ⇒ Struct
Updates the dialer config of a campaign.
-
#update_campaign_name(params = {}) ⇒ Struct
Updates the name of a campaign.
-
#update_campaign_outbound_call_config(params = {}) ⇒ Struct
Updates the outbound call config of a campaign.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_campaign(params = {}) ⇒ Types::CreateCampaignResponse
Creates a campaign for the specified Amazon Connect account. This API is idempotent.
483 484 485 486 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 483 def create_campaign(params = {}, = {}) req = build_request(:create_campaign, params) req.send_request() end |
#delete_campaign(params = {}) ⇒ Struct
Deletes a campaign from the specified Amazon Connect account.
505 506 507 508 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 505 def delete_campaign(params = {}, = {}) req = build_request(:delete_campaign, params) req.send_request() end |
#delete_connect_instance_config(params = {}) ⇒ Struct
Deletes a connect instance config from the specified AWS account.
527 528 529 530 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 527 def delete_connect_instance_config(params = {}, = {}) req = build_request(:delete_connect_instance_config, params) req.send_request() end |
#delete_instance_onboarding_job(params = {}) ⇒ Struct
Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
550 551 552 553 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 550 def delete_instance_onboarding_job(params = {}, = {}) req = build_request(:delete_instance_onboarding_job, params) req.send_request() end |
#describe_campaign(params = {}) ⇒ Types::DescribeCampaignResponse
Describes the specific campaign.
593 594 595 596 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 593 def describe_campaign(params = {}, = {}) req = build_request(:describe_campaign, params) req.send_request() end |
#get_campaign_state(params = {}) ⇒ Types::GetCampaignStateResponse
Get state of a campaign for the specified Amazon Connect account.
621 622 623 624 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 621 def get_campaign_state(params = {}, = {}) req = build_request(:get_campaign_state, params) req.send_request() end |
#get_campaign_state_batch(params = {}) ⇒ Types::GetCampaignStateBatchResponse
Get state of campaigns for the specified Amazon Connect account.
655 656 657 658 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 655 def get_campaign_state_batch(params = {}, = {}) req = build_request(:get_campaign_state_batch, params) req.send_request() end |
#get_connect_instance_config(params = {}) ⇒ Types::GetConnectInstanceConfigResponse
Get the specific Connect instance config.
687 688 689 690 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 687 def get_connect_instance_config(params = {}, = {}) req = build_request(:get_connect_instance_config, params) req.send_request() end |
#get_instance_onboarding_job_status(params = {}) ⇒ Types::GetInstanceOnboardingJobStatusResponse
Get the specific instance onboarding job status.
717 718 719 720 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 717 def get_instance_onboarding_job_status(params = {}, = {}) req = build_request(:get_instance_onboarding_job_status, params) req.send_request() end |
#list_campaigns(params = {}) ⇒ Types::ListCampaignsResponse
Provides summary information about the campaigns under the specified Amazon Connect account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
767 768 769 770 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 767 def list_campaigns(params = {}, = {}) req = build_request(:list_campaigns, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags for a resource.
796 797 798 799 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 796 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#pause_campaign(params = {}) ⇒ Struct
Pauses a campaign for the specified Amazon Connect account.
818 819 820 821 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 818 def pause_campaign(params = {}, = {}) req = build_request(:pause_campaign, params) req.send_request() end |
#put_dial_request_batch(params = {}) ⇒ Types::PutDialRequestBatchResponse
Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
867 868 869 870 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 867 def put_dial_request_batch(params = {}, = {}) req = build_request(:put_dial_request_batch, params) req.send_request() end |
#resume_campaign(params = {}) ⇒ Struct
Stops a campaign for the specified Amazon Connect account.
889 890 891 892 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 889 def resume_campaign(params = {}, = {}) req = build_request(:resume_campaign, params) req.send_request() end |
#start_campaign(params = {}) ⇒ Struct
Starts a campaign for the specified Amazon Connect account.
911 912 913 914 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 911 def start_campaign(params = {}, = {}) req = build_request(:start_campaign, params) req.send_request() end |
#start_instance_onboarding_job(params = {}) ⇒ Types::StartInstanceOnboardingJobResponse
Onboard the specific Amazon Connect instance to Connect Campaigns.
952 953 954 955 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 952 def start_instance_onboarding_job(params = {}, = {}) req = build_request(:start_instance_onboarding_job, params) req.send_request() end |
#stop_campaign(params = {}) ⇒ Struct
Stops a campaign for the specified Amazon Connect account.
974 975 976 977 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 974 def stop_campaign(params = {}, = {}) req = build_request(:stop_campaign, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tag a resource.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1002 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untag a resource.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1028 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_campaign_dialer_config(params = {}) ⇒ Struct
Updates the dialer config of a campaign. This API is idempotent.
1066 1067 1068 1069 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1066 def update_campaign_dialer_config(params = {}, = {}) req = build_request(:update_campaign_dialer_config, params) req.send_request() end |
#update_campaign_name(params = {}) ⇒ Struct
Updates the name of a campaign. This API is idempotent.
1092 1093 1094 1095 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1092 def update_campaign_name(params = {}, = {}) req = build_request(:update_campaign_name, params) req.send_request() end |
#update_campaign_outbound_call_config(params = {}) ⇒ Struct
Updates the outbound call config of a campaign. This API is idempotent.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-connectcampaignservice/lib/aws-sdk-connectcampaignservice/client.rb', line 1132 def update_campaign_outbound_call_config(params = {}, = {}) req = build_request(:update_campaign_outbound_call_config, params) req.send_request() end |