We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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.

Class: AWS.ConnectCampaigns

Inherits:
AWS.Service show all
Identifier:
connectcampaigns
API Version:
2021-01-30
Defined in:
(unknown)

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();

Version:

  • 2021-01-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a ConnectCampaigns object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ConnectCampaigns.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ConnectCampaigns.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ConnectCampaigns.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the createCampaign operation

var params = {
  connectInstanceId: 'STRING_VALUE', /* required */
  dialerConfig: { /* required */
    agentlessDialerConfig: {
      dialingCapacity: 'NUMBER_VALUE'
    },
    predictiveDialerConfig: {
      bandwidthAllocation: 'NUMBER_VALUE', /* required */
      dialingCapacity: 'NUMBER_VALUE'
    },
    progressiveDialerConfig: {
      bandwidthAllocation: 'NUMBER_VALUE', /* required */
      dialingCapacity: 'NUMBER_VALUE'
    }
  },
  name: 'STRING_VALUE', /* required */
  outboundCallConfig: { /* required */
    connectContactFlowId: 'STRING_VALUE', /* required */
    answerMachineDetectionConfig: {
      enableAnswerMachineDetection: true || false, /* required */
      awaitAnswerMachinePrompt: true || false
    },
    connectQueueId: 'STRING_VALUE',
    connectSourcePhoneNumber: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connectcampaigns.createCampaign(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: {})
    • name — (String)

      The name of an Amazon Connect Campaign name.

    • connectInstanceId — (String)

      Amazon Connect Instance Id

    • dialerConfig — (map)

      The possible types of dialer config parameters

      • progressiveDialerConfig — (map)

        Progressive Dialer config

        • bandwidthAllocationrequired — (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

        • bandwidthAllocationrequired — (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 — (map)

      The configuration used for outbound calls.

      • connectContactFlowIdrequired — (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

        • enableAnswerMachineDetectionrequired — (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.

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:

      • id — (String)

        Identifier representing a Campaign

      • arn — (String)

        The resource name of an Amazon Connect campaign.

      • tags — (map<String>)

        Tag map with key and value.

Returns:

  • (AWS.Request)

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

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

Deletes a campaign from the specified Amazon Connect account.

Service Reference:

Examples:

Calling the deleteCampaign operation

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.

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

Deletes a connect instance config from the specified AWS account.

Service Reference:

Examples:

Calling the deleteConnectInstanceConfig operation

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.

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

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

Service Reference:

Examples:

Calling the deleteInstanceOnboardingJob operation

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.

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

Describes the specific campaign.

Service Reference:

Examples:

Calling the describeCampaign operation

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.

        • idrequired — (String)

          Identifier representing a Campaign

        • arnrequired — (String)

          The resource name of an Amazon Connect campaign.

        • namerequired — (String)

          The name of an Amazon Connect Campaign name.

        • connectInstanceIdrequired — (String)

          Amazon Connect Instance Id

        • dialerConfigrequired — (map)

          The possible types of dialer config parameters

          • progressiveDialerConfig — (map)

            Progressive Dialer config

            • bandwidthAllocationrequired — (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

            • bandwidthAllocationrequired — (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

        • outboundCallConfigrequired — (map)

          The configuration used for outbound calls.

          • connectContactFlowIdrequired — (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

            • enableAnswerMachineDetectionrequired — (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.

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

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

Service Reference:

Examples:

Calling the getCampaignState operation

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.

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

Get state of campaigns for the specified Amazon Connect account.

Service Reference:

Examples:

Calling the getCampaignStateBatch operation

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.

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

Get the specific Connect instance config.

Service Reference:

Examples:

Calling the getConnectInstanceConfig operation

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

        • connectInstanceIdrequired — (String)

          Amazon Connect Instance Id

        • serviceLinkedRoleArnrequired — (String)

          Service linked role arn

        • encryptionConfigrequired — (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

          • enabledrequired — (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.

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

Get the specific instance onboarding job status.

Service Reference:

Examples:

Calling the getInstanceOnboardingJobStatus operation

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

        • connectInstanceIdrequired — (String)

          Amazon Connect Instance Id

        • statusrequired — (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.

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

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

Service Reference:

Examples:

Calling the listCampaigns operation

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

        • valuerequired — (String)

          Amazon Connect Instance Id

        • operatorrequired — (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.

        • idrequired — (String)

          Identifier representing a Campaign

        • arnrequired — (String)

          The resource name of an Amazon Connect campaign.

        • namerequired — (String)

          The name of an Amazon Connect Campaign name.

        • connectInstanceIdrequired — (String)

          Amazon Connect Instance Id

Returns:

  • (AWS.Request)

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

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

List tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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.

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

Pauses a campaign for the specified Amazon Connect account.

Service Reference:

Examples:

Calling the pauseCampaign operation

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.

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

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

Service Reference:

Examples:

Calling the putDialRequestBatch operation

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.

      • clientTokenrequired — (String)

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

      • phoneNumberrequired — (String)

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

      • expirationTimerequired — (Date)

        Timestamp with no UTC offset or timezone

      • attributesrequired — (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.

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

Stops a campaign for the specified Amazon Connect account.

Service Reference:

Examples:

Calling the resumeCampaign operation

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.

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

Starts a campaign for the specified Amazon Connect account.

Service Reference:

Examples:

Calling the startCampaign operation

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.

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

Onboard the specific Amazon Connect instance to Connect Campaigns.

Service Reference:

Examples:

Calling the startInstanceOnboardingJob operation

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

      • enabledrequired — (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

        • connectInstanceIdrequired — (String)

          Amazon Connect Instance Id

        • statusrequired — (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.

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

Stops a campaign for the specified Amazon Connect account.

Service Reference:

Examples:

Calling the stopCampaign operation

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.

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

Tag a resource.

Service Reference:

Examples:

Calling the tagResource operation

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.

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

Untag a resource.

Service Reference:

Examples:

Calling the untagResource operation

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.

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

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

Service Reference:

Examples:

Calling the updateCampaignDialerConfig operation

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

        • bandwidthAllocationrequired — (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

        • bandwidthAllocationrequired — (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.

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

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

Service Reference:

Examples:

Calling the updateCampaignName operation

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.

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

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

Examples:

Calling the updateCampaignOutboundCallConfig operation

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

      • enableAnswerMachineDetectionrequired — (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.