Class: AWS.ConnectCampaigns

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.deleteCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  connectInstanceId: 'STRING_VALUE' /* required */
};
connectcampaigns.deleteConnectInstanceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • connectInstanceId — (String)

    Amazon Connect Instance Id

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  connectInstanceId: 'STRING_VALUE' /* required */
};
connectcampaigns.deleteInstanceOnboardingJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • connectInstanceId — (String)

    Amazon Connect Instance Id

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.describeCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • campaign — (map)

      An Amazon Connect campaign.

      • id — required — (String)

        Identifier representing a Campaign

      • arn — required — (String)

        The resource name of an Amazon Connect campaign.

      • name — required — (String)

        The name of an Amazon Connect Campaign name.

      • connectInstanceId — required — (String)

        Amazon Connect Instance Id

      • dialerConfig — required — (map)

        The possible types of dialer config parameters

        • progressiveDialerConfig — (map)

          Progressive Dialer config

          • bandwidthAllocation — required — (Float)

            The bandwidth allocation of a queue resource.

          • dialingCapacity — (Float)

            Allocates dialing capacity for this campaign between multiple active campaigns

        • predictiveDialerConfig — (map)

          Predictive Dialer config

          • bandwidthAllocation — required — (Float)

            The bandwidth allocation of a queue resource.

          • dialingCapacity — (Float)

            Allocates dialing capacity for this campaign between multiple active campaigns

        • agentlessDialerConfig — (map)

          Agentless Dialer config

          • dialingCapacity — (Float)

            Allocates dialing capacity for this campaign between multiple active campaigns

      • outboundCallConfig — required — (map)

        The configuration used for outbound calls.

        • connectContactFlowId — required — (String)

          The identifier of the contact flow for the outbound call.

        • connectSourcePhoneNumber — (String)

          The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

        • connectQueueId — (String)

          The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

        • answerMachineDetectionConfig — (map)

          Answering Machine Detection config

          • enableAnswerMachineDetection — required — (Boolean)

            Enable or disable answering machine detection

          • awaitAnswerMachinePrompt — (Boolean)

            Enable or disable await answer machine prompt

      • tags — (map<String>)

        Tag map with key and value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.getCampaignState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • state — (String)

      State of a campaign

      Possible values include:
      • "Initialized"
      • "Running"
      • "Paused"
      • "Stopped"
      • "Failed"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  campaignIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connectcampaigns.getCampaignStateBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • campaignIds — (Array<String>)

    List of CampaignId

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • successfulRequests — (Array<map>)

      List of successful response of campaign state

      • campaignId — (String)

        Identifier representing a Campaign

      • state — (String)

        State of a campaign

        Possible values include:
        • "Initialized"
        • "Running"
        • "Paused"
        • "Stopped"
        • "Failed"
    • failedRequests — (Array<map>)

      List of failed requests of campaign state

      • campaignId — (String)

        Identifier representing a Campaign

      • failureCode — (String)

        A predefined code indicating the error that caused the failure in getting state of campaigns

        Possible values include:
        • "ResourceNotFound"
        • "UnknownError"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  connectInstanceId: 'STRING_VALUE' /* required */
};
connectcampaigns.getConnectInstanceConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • connectInstanceId — (String)

    Amazon Connect Instance Id

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • connectInstanceConfig — (map)

      Instance config object

      • connectInstanceId — required — (String)

        Amazon Connect Instance Id

      • serviceLinkedRoleArn — required — (String)

        Service linked role arn

      • encryptionConfig — required — (map)

        Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

        • enabled — required — (Boolean)

          Boolean to indicate if custom encryption has been enabled.

        • encryptionType — (String)

          Server-side encryption type.

          Possible values include:
          • "KMS"
        • keyArn — (String)

          KMS key id/arn for encryption config.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  connectInstanceId: 'STRING_VALUE' /* required */
};
connectcampaigns.getInstanceOnboardingJobStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • connectInstanceId — (String)

    Amazon Connect Instance Id

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • connectInstanceOnboardingJobStatus — (map)

      Instance onboarding job status object

      • connectInstanceId — required — (String)

        Amazon Connect Instance Id

      • status — required — (String)

        Enumeration of the possible states for instance onboarding job

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • failureCode — (String)

        Enumeration of the possible failure codes for instance onboarding job

        Possible values include:
        • "EVENT_BRIDGE_ACCESS_DENIED"
        • "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED"
        • "IAM_ACCESS_DENIED"
        • "KMS_ACCESS_DENIED"
        • "KMS_KEY_NOT_FOUND"
        • "INTERNAL_FAILURE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  filters: {
    instanceIdFilter: {
      operator: Eq, /* required */
      value: 'STRING_VALUE' /* required */
    }
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcampaigns.listCampaigns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results.

  • filters — (map)

    Filter model by type

    • instanceIdFilter — (map)

      Connect instance identifier filter

      • value — required — (String)

        Amazon Connect Instance Id

      • operator — required — (String)

        Operators for Connect instance identifier filter

        Possible values include:
        • "Eq"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token for the next set of results.

    • campaignSummaryList — (Array<map>)

      A list of Amazon Connect campaigns.

      • id — required — (String)

        Identifier representing a Campaign

      • arn — required — (String)

        The resource name of an Amazon Connect campaign.

      • name — required — (String)

        The name of an Amazon Connect Campaign name.

      • connectInstanceId — required — (String)

        Amazon Connect Instance Id

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
connectcampaigns.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    Arn

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      Tag map with key and value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.pauseCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dialRequests: [ /* required */
    {
      attributes: { /* required */
        '<AttributeName>': 'STRING_VALUE',
        /* '<AttributeName>': ... */
      },
      clientToken: 'STRING_VALUE', /* required */
      expirationTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      phoneNumber: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.putDialRequestBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

  • dialRequests — (Array<map>)

    A list of dial requests.

    • clientToken — required — (String)

      Client provided parameter used for idempotency. Its value must be unique for each request.

    • phoneNumber — required — (String)

      The phone number of the customer, in E.164 format.

    • expirationTime — required — (Date)

      Timestamp with no UTC offset or timezone

    • attributes — required — (map<String>)

      A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • successfulRequests — (Array<map>)

      A list of successful requests identified by the unique client token.

      • clientToken — (String)

        Client provided parameter used for idempotency. Its value must be unique for each request.

      • id — (String)

        Identifier representing a Dial request

    • failedRequests — (Array<map>)

      A list of failed requests.

      • clientToken — (String)

        Client provided parameter used for idempotency. Its value must be unique for each request.

      • id — (String)

        Identifier representing a Dial request

      • failureCode — (String)

        A predefined code indicating the error that caused the failure.

        Possible values include:
        • "InvalidInput"
        • "RequestThrottled"
        • "UnknownError"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.resumeCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.startCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  connectInstanceId: 'STRING_VALUE', /* required */
  encryptionConfig: { /* required */
    enabled: true || false, /* required */
    encryptionType: KMS,
    keyArn: 'STRING_VALUE'
  }
};
connectcampaigns.startInstanceOnboardingJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • connectInstanceId — (String)

    Amazon Connect Instance Id

  • encryptionConfig — (map)

    Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

    • enabled — required — (Boolean)

      Boolean to indicate if custom encryption has been enabled.

    • encryptionType — (String)

      Server-side encryption type.

      Possible values include:
      • "KMS"
    • keyArn — (String)

      KMS key id/arn for encryption config.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • connectInstanceOnboardingJobStatus — (map)

      Instance onboarding job status object

      • connectInstanceId — required — (String)

        Amazon Connect Instance Id

      • status — required — (String)

        Enumeration of the possible states for instance onboarding job

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • failureCode — (String)

        Enumeration of the possible failure codes for instance onboarding job

        Possible values include:
        • "EVENT_BRIDGE_ACCESS_DENIED"
        • "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED"
        • "IAM_ACCESS_DENIED"
        • "KMS_ACCESS_DENIED"
        • "KMS_KEY_NOT_FOUND"
        • "INTERNAL_FAILURE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.stopCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connectcampaigns.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    Arn

  • tags — (map<String>)

    Tag map with key and value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connectcampaigns.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    Arn

  • tagKeys — (Array<String>)

    List of tag keys.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dialerConfig: { /* required */
    agentlessDialerConfig: {
      dialingCapacity: 'NUMBER_VALUE'
    },
    predictiveDialerConfig: {
      bandwidthAllocation: 'NUMBER_VALUE', /* required */
      dialingCapacity: 'NUMBER_VALUE'
    },
    progressiveDialerConfig: {
      bandwidthAllocation: 'NUMBER_VALUE', /* required */
      dialingCapacity: 'NUMBER_VALUE'
    }
  },
  id: 'STRING_VALUE' /* required */
};
connectcampaigns.updateCampaignDialerConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

  • dialerConfig — (map)

    The possible types of dialer config parameters

    • progressiveDialerConfig — (map)

      Progressive Dialer config

      • bandwidthAllocation — required — (Float)

        The bandwidth allocation of a queue resource.

      • dialingCapacity — (Float)

        Allocates dialing capacity for this campaign between multiple active campaigns

    • predictiveDialerConfig — (map)

      Predictive Dialer config

      • bandwidthAllocation — required — (Float)

        The bandwidth allocation of a queue resource.

      • dialingCapacity — (Float)

        Allocates dialing capacity for this campaign between multiple active campaigns

    • agentlessDialerConfig — (map)

      Agentless Dialer config

      • dialingCapacity — (Float)

        Allocates dialing capacity for this campaign between multiple active campaigns

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
connectcampaigns.updateCampaignName(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

  • name — (String)

    The name of an Amazon Connect Campaign name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  id: 'STRING_VALUE', /* required */
  answerMachineDetectionConfig: {
    enableAnswerMachineDetection: true || false, /* required */
    awaitAnswerMachinePrompt: true || false
  },
  connectContactFlowId: 'STRING_VALUE',
  connectSourcePhoneNumber: 'STRING_VALUE'
};
connectcampaigns.updateCampaignOutboundCallConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • id — (String)

    Identifier representing a Campaign

  • connectContactFlowId — (String)

    The identifier of the contact flow for the outbound call.

  • connectSourcePhoneNumber — (String)

    The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

  • answerMachineDetectionConfig — (map)

    Answering Machine Detection config

    • enableAnswerMachineDetection — required — (Boolean)

      Enable or disable answering machine detection

    • awaitAnswerMachinePrompt — (Boolean)

      Enable or disable await answer machine prompt

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.