AWS.ConnectCampaigns — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Provide APIs to create and manage Amazon Connect Campaigns.

Sending a Request Using ConnectCampaigns

var connectcampaigns = new AWS.ConnectCampaigns();
connectcampaigns.createCampaign(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ConnectCampaigns object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var connectcampaigns = new AWS.ConnectCampaigns({apiVersion: '2021-01-30'});

You can also set the API version globally in AWS.config.apiVersions using the connectcampaigns service identifier:

AWS.config.apiVersions = {
  connectcampaigns: '2021-01-30',
  // other service API versions
};

var connectcampaigns = new AWS.ConnectCampaigns();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ConnectCampaigns(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createCampaign(params = {}, callback) ⇒ AWS.Request

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

deleteCampaign(params = {}, callback) ⇒ AWS.Request

Deletes a campaign from the specified Amazon Connect account.

deleteConnectInstanceConfig(params = {}, callback) ⇒ AWS.Request

Deletes a connect instance config from the specified AWS account.

deleteInstanceOnboardingJob(params = {}, callback) ⇒ AWS.Request

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

describeCampaign(params = {}, callback) ⇒ AWS.Request

Describes the specific campaign.

getCampaignState(params = {}, callback) ⇒ AWS.Request

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

getCampaignStateBatch(params = {}, callback) ⇒ AWS.Request

Get state of campaigns for the specified Amazon Connect account.

getConnectInstanceConfig(params = {}, callback) ⇒ AWS.Request

Get the specific Connect instance config.

getInstanceOnboardingJobStatus(params = {}, callback) ⇒ AWS.Request

Get the specific instance onboarding job status.

listCampaigns(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List tags for a resource.

pauseCampaign(params = {}, callback) ⇒ AWS.Request

Pauses a campaign for the specified Amazon Connect account.

putDialRequestBatch(params = {}, callback) ⇒ AWS.Request

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

resumeCampaign(params = {}, callback) ⇒ AWS.Request

Stops a campaign for the specified Amazon Connect account.

startCampaign(params = {}, callback) ⇒ AWS.Request

Starts a campaign for the specified Amazon Connect account.

startInstanceOnboardingJob(params = {}, callback) ⇒ AWS.Request

Onboard the specific Amazon Connect instance to Connect Campaigns.

stopCampaign(params = {}, callback) ⇒ AWS.Request

Stops a campaign for the specified Amazon Connect account.

untagResource(params = {}, callback) ⇒ AWS.Request

updateCampaignDialerConfig(params = {}, callback) ⇒ AWS.Request

Updates the dialer config of a campaign. This API is idempotent.

updateCampaignName(params = {}, callback) ⇒ AWS.Request

Updates the name of a campaign. This API is idempotent.

updateCampaignOutboundCallConfig(params = {}, callback) ⇒ AWS.Request

Updates the outbound call config of a campaign. This API is idempotent.