You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Connect

Inherits:
AWS.Service show all
Identifier:
connect
API Version:
2017-08-08
Defined in:
(unknown)

Overview

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

Service Description

Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.

There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

Note: Working with flows? Check out the Amazon Connect Flow language.

Sending a Request Using Connect

var connect = new AWS.Connect();
connect.associateApprovedOrigin(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 Connect object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var connect = new AWS.Connect({apiVersion: '2017-08-08'});

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

AWS.config.apiVersions = {
  connect: '2017-08-08',
  // other service API versions
};

var connect = new AWS.Connect();

Version:

  • 2017-08-08

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.Connect(options = {}) ⇒ Object

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

Examples:

Constructing a Connect object

var connect = new AWS.Connect({apiVersion: '2017-08-08'});

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.Connect.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Connect.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

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

This API is in preview release for Amazon Connect and is subject to change.

Associates an approved origin to an Amazon Connect instance.

Service Reference:

Examples:

Calling the associateApprovedOrigin operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Origin: 'STRING_VALUE' /* required */
};
connect.associateApprovedOrigin(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Origin — (String)

      The domain to add to your allow list.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Service Reference:

Examples:

Calling the associateBot operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: {
    LexRegion: 'STRING_VALUE',
    Name: 'STRING_VALUE'
  },
  LexV2Bot: {
    AliasArn: 'STRING_VALUE'
  }
};
connect.associateBot(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • LexBot — (map)

      Configuration information of an Amazon Lex bot.

      • Name — (String)

        The name of the Amazon Lex bot.

      • LexRegion — (String)

        The Amazon Web Services Region where the Amazon Lex bot was created.

    • LexV2Bot — (map)

      The Amazon Lex V2 bot to associate with the instance.

      • AliasArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

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.

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

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

Service Reference:

Examples:

Calling the associateDefaultVocabulary operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LanguageCode: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN, /* required */
  VocabularyId: 'STRING_VALUE'
};
connect.associateDefaultVocabulary(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • LanguageCode — (String)

      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

      Possible values include:
      • "ar-AE"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fr-CA"
      • "fr-FR"
      • "hi-IN"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "pt-BR"
      • "pt-PT"
      • "zh-CN"
    • VocabularyId — (String)

      The identifier of the custom vocabulary. If this is empty, the default is set to none.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

Service Reference:

Examples:

Calling the associateInstanceStorageConfig operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, /* required */
  StorageConfig: { /* required */
    StorageType: S3 | KINESIS_VIDEO_STREAM | KINESIS_STREAM | KINESIS_FIREHOSE, /* required */
    AssociationId: 'STRING_VALUE',
    KinesisFirehoseConfig: {
      FirehoseArn: 'STRING_VALUE' /* required */
    },
    KinesisStreamConfig: {
      StreamArn: 'STRING_VALUE' /* required */
    },
    KinesisVideoStreamConfig: {
      EncryptionConfig: { /* required */
        EncryptionType: KMS, /* required */
        KeyId: 'STRING_VALUE' /* required */
      },
      Prefix: 'STRING_VALUE', /* required */
      RetentionPeriodHours: 'NUMBER_VALUE' /* required */
    },
    S3Config: {
      BucketName: 'STRING_VALUE', /* required */
      BucketPrefix: 'STRING_VALUE', /* required */
      EncryptionConfig: {
        EncryptionType: KMS, /* required */
        KeyId: 'STRING_VALUE' /* required */
      }
    }
  }
};
connect.associateInstanceStorageConfig(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "CHAT_TRANSCRIPTS"
      • "CALL_RECORDINGS"
      • "SCHEDULED_REPORTS"
      • "MEDIA_STREAMS"
      • "CONTACT_TRACE_RECORDS"
      • "AGENT_EVENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"
    • StorageConfig — (map)

      A valid storage type.

      • AssociationId — (String)

        The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

      • StorageTyperequired — (String)

        A valid storage type.

        Possible values include:
        • "S3"
        • "KINESIS_VIDEO_STREAM"
        • "KINESIS_STREAM"
        • "KINESIS_FIREHOSE"
      • S3Config — (map)

        The S3 bucket configuration.

        • BucketNamerequired — (String)

          The S3 bucket name.

        • BucketPrefixrequired — (String)

          The S3 bucket prefix.

        • EncryptionConfig — (map)

          The Amazon S3 encryption configuration.

          • EncryptionTyperequired — (String)

            The type of encryption.

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

            The full ARN of the encryption key.

            Note: Be sure to provide the full ARN of the encryption key, not just the ID.
      • KinesisVideoStreamConfig — (map)

        The configuration of the Kinesis video stream.

        • Prefixrequired — (String)

          The prefix of the video stream.

        • RetentionPeriodHoursrequired — (Integer)

          The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

          The default value is 0, indicating that the stream does not persist data.

        • EncryptionConfigrequired — (map)

          The encryption configuration.

          • EncryptionTyperequired — (String)

            The type of encryption.

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

            The full ARN of the encryption key.

            Note: Be sure to provide the full ARN of the encryption key, not just the ID.
      • KinesisStreamConfig — (map)

        The configuration of the Kinesis data stream.

        • StreamArnrequired — (String)

          The Amazon Resource Name (ARN) of the data stream.

      • KinesisFirehoseConfig — (map)

        The configuration of the Kinesis Firehose delivery stream.

        • FirehoseArnrequired — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

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:

      • AssociationId — (String)

        The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Lambda function.

Service Reference:

Examples:

Calling the associateLambdaFunction operation

var params = {
  FunctionArn: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.associateLambdaFunction(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • FunctionArn — (String)

      The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

Service Reference:

Examples:

Calling the associateLexBot operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: { /* required */
    LexRegion: 'STRING_VALUE',
    Name: 'STRING_VALUE'
  }
};
connect.associateLexBot(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • LexBot — (map)

      The Amazon Lex bot to associate with the instance.

      • Name — (String)

        The name of the Amazon Lex bot.

      • LexRegion — (String)

        The Amazon Web Services Region where the Amazon Lex bot was created.

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.

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

Associates a flow with a phone number claimed to your Amazon Connect instance.

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Service Reference:

Examples:

Calling the associatePhoneNumberContactFlow operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  PhoneNumberId: 'STRING_VALUE' /* required */
};
connect.associatePhoneNumberContactFlow(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: {})
    • PhoneNumberId — (String)

      A unique identifier for the phone number.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowId — (String)

      The identifier of the flow.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Associates a set of quick connects with a queue.

Service Reference:

Examples:

Calling the associateQueueQuickConnects operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  QuickConnectIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connect.associateQueueQuickConnects(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • QuickConnectIds — (Array<String>)

      The quick connects to associate with this queue.

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.

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

Associates a set of queues with a routing profile.

Service Reference:

Examples:

Calling the associateRoutingProfileQueues operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueConfigs: [ /* required */
    {
      Delay: 'NUMBER_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      QueueReference: { /* required */
        Channel: VOICE | CHAT | TASK, /* required */
        QueueId: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.associateRoutingProfileQueues(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • QueueConfigs — (Array<map>)

      The queues to associate with this routing profile.

      • QueueReferencerequired — (map)

        Contains information about a queue resource.

        • QueueIdrequired — (String)

          The identifier for the queue.

        • Channelrequired — (String)

          The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

          Possible values include:
          • "VOICE"
          • "CHAT"
          • "TASK"
      • Priorityrequired — (Integer)

        The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

      • Delayrequired — (Integer)

        The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Associates a security key to the instance.

Service Reference:

Examples:

Calling the associateSecurityKey operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Key: 'STRING_VALUE' /* required */
};
connect.associateSecurityKey(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Key — (String)

      A valid security key in PEM format.

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:

      • AssociationId — (String)

        The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Returns:

  • (AWS.Request)

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

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

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

You can call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

Service Reference:

Examples:

Calling the claimPhoneNumber operation

var params = {
  PhoneNumber: 'STRING_VALUE', /* required */
  TargetArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  PhoneNumberDescription: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.claimPhoneNumber(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: {})
    • TargetArn — (String)

      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

    • PhoneNumber — (String)

      The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

    • PhoneNumberDescription — (String)

      The description of the phone number.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • PhoneNumberId — (String)

        A unique identifier for the phone number.

      • PhoneNumberArn — (String)

        The Amazon Resource Name (ARN) of the phone number.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Creates an agent status for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the createAgentStatus operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  State: ENABLED | DISABLED, /* required */
  Description: 'STRING_VALUE',
  DisplayOrder: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createAgentStatus(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the status.

    • Description — (String)

      The description of the status.

    • State — (String)

      The state of the status.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • DisplayOrder — (Integer)

      The display order of the status.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • AgentStatusARN — (String)

        The Amazon Resource Name (ARN) of the agent status.

      • AgentStatusId — (String)

        The identifier of the agent status.

Returns:

  • (AWS.Request)

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

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

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

Service Reference:

Examples:

Calling the createContactFlow operation

var params = {
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Type: CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER, /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createContactFlow(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • Name — (String)

      The name of the flow.

    • Type — (String)

      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

      Possible values include:
      • "CONTACT_FLOW"
      • "CUSTOMER_QUEUE"
      • "CUSTOMER_HOLD"
      • "CUSTOMER_WHISPER"
      • "AGENT_HOLD"
      • "AGENT_WHISPER"
      • "OUTBOUND_WHISPER"
      • "AGENT_TRANSFER"
      • "QUEUE_TRANSFER"
    • Description — (String)

      The description of the flow.

    • Content — (String)

      The content of the flow.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • ContactFlowId — (String)

        The identifier of the flow.

      • ContactFlowArn — (String)

        The Amazon Resource Name (ARN) of the flow.

Returns:

  • (AWS.Request)

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

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

Creates a flow module for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the createContactFlowModule operation

var params = {
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createContactFlowModule(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the flow module.

    • Description — (String)

      The description of the flow module.

    • Content — (String)

      The content of the flow module.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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)

        The identifier of the flow module.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the flow module.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Creates hours of operation.

Service Reference:

Examples:

Calling the createHoursOfOperation operation

var params = {
  Config: [ /* required */
    {
      Day: SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY, /* required */
      EndTime: { /* required */
        Hours: 'NUMBER_VALUE', /* required */
        Minutes: 'NUMBER_VALUE' /* required */
      },
      StartTime: { /* required */
        Hours: 'NUMBER_VALUE', /* required */
        Minutes: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  TimeZone: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createHoursOfOperation(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the hours of operation.

    • Description — (String)

      The description of the hours of operation.

    • TimeZone — (String)

      The time zone of the hours of operation.

    • Config — (Array<map>)

      Configuration information for the hours of operation: day, start time, and end time.

      • Dayrequired — (String)

        The day that the hours of operation applies to.

        Possible values include:
        • "SUNDAY"
        • "MONDAY"
        • "TUESDAY"
        • "WEDNESDAY"
        • "THURSDAY"
        • "FRIDAY"
        • "SATURDAY"
      • StartTimerequired — (map)

        The start time that your contact center opens.

        • Hoursrequired — (Integer)

          The hours.

        • Minutesrequired — (Integer)

          The minutes.

      • EndTimerequired — (map)

        The end time that your contact center closes.

        • Hoursrequired — (Integer)

          The hours.

        • Minutesrequired — (Integer)

          The minutes.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • HoursOfOperationId — (String)

        The identifier for the hours of operation.

      • HoursOfOperationArn — (String)

        The Amazon Resource Name (ARN) for the hours of operation.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Service Reference:

Examples:

Calling the createInstance operation

var params = {
  IdentityManagementType: SAML | CONNECT_MANAGED | EXISTING_DIRECTORY, /* required */
  InboundCallsEnabled: true || false, /* required */
  OutboundCallsEnabled: true || false, /* required */
  ClientToken: 'STRING_VALUE',
  DirectoryId: 'STRING_VALUE',
  InstanceAlias: 'STRING_VALUE'
};
connect.createInstance(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: {})
    • ClientToken — (String)

      The idempotency token.

    • IdentityManagementType — (String)

      The type of identity management for your Amazon Connect users.

      Possible values include:
      • "SAML"
      • "CONNECT_MANAGED"
      • "EXISTING_DIRECTORY"
    • InstanceAlias — (String)

      The name for your instance.

    • DirectoryId — (String)

      The identifier for the directory.

    • InboundCallsEnabled — (Boolean)

      Your contact center handles incoming contacts.

    • OutboundCallsEnabled — (Boolean)

      Your contact center allows outbound calls.

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)

        The identifier for the instance.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the instance.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon Web Services resource association with an Amazon Connect instance.

Service Reference:

Examples:

Calling the createIntegrationAssociation operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationArn: 'STRING_VALUE', /* required */
  IntegrationType: EVENT | VOICE_ID | PINPOINT_APP | WISDOM_ASSISTANT | WISDOM_KNOWLEDGE_BASE | CASES_DOMAIN, /* required */
  SourceApplicationName: 'STRING_VALUE',
  SourceApplicationUrl: 'STRING_VALUE',
  SourceType: SALESFORCE | ZENDESK,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createIntegrationAssociation(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • IntegrationType — (String)

      The type of information to be ingested.

      Possible values include:
      • "EVENT"
      • "VOICE_ID"
      • "PINPOINT_APP"
      • "WISDOM_ASSISTANT"
      • "WISDOM_KNOWLEDGE_BASE"
      • "CASES_DOMAIN"
    • IntegrationArn — (String)

      The Amazon Resource Name (ARN) of the integration.

      Note: When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
    • SourceApplicationUrl — (String)

      The URL for the external application. This field is only required for the EVENT integration type.

    • SourceApplicationName — (String)

      The name of the external application. This field is only required for the EVENT integration type.

    • SourceType — (String)

      The type of the data source. This field is only required for the EVENT integration type.

      Possible values include:
      • "SALESFORCE"
      • "ZENDESK"
    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • IntegrationAssociationId — (String)

        The identifier for the integration association.

      • IntegrationAssociationArn — (String)

        The Amazon Resource Name (ARN) for the association.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Creates a new queue for the specified Amazon Connect instance.

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Service Reference:

Examples:

Calling the createQueue operation

var params = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  MaxContacts: 'NUMBER_VALUE',
  OutboundCallerConfig: {
    OutboundCallerIdName: 'STRING_VALUE',
    OutboundCallerIdNumberId: 'STRING_VALUE',
    OutboundFlowId: 'STRING_VALUE'
  },
  QuickConnectIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createQueue(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the queue.

    • Description — (String)

      The description of the queue.

    • OutboundCallerConfig — (map)

      The outbound caller ID name, number, and outbound whisper flow.

      • OutboundCallerIdName — (String)

        The caller ID name.

      • OutboundCallerIdNumberId — (String)

        The caller ID number.

      • OutboundFlowId — (String)

        The outbound whisper flow to be used during an outbound call.

    • HoursOfOperationId — (String)

      The identifier for the hours of operation.

    • MaxContacts — (Integer)

      The maximum number of contacts that can be in the queue before it is considered full.

    • QuickConnectIds — (Array<String>)

      The quick connects available to agents who are working the queue.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • QueueArn — (String)

        The Amazon Resource Name (ARN) of the queue.

      • QueueId — (String)

        The identifier for the queue.

Returns:

  • (AWS.Request)

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

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

Creates a quick connect for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the createQuickConnect operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  QuickConnectConfig: { /* required */
    QuickConnectType: USER | QUEUE | PHONE_NUMBER, /* required */
    PhoneConfig: {
      PhoneNumber: 'STRING_VALUE' /* required */
    },
    QueueConfig: {
      ContactFlowId: 'STRING_VALUE', /* required */
      QueueId: 'STRING_VALUE' /* required */
    },
    UserConfig: {
      ContactFlowId: 'STRING_VALUE', /* required */
      UserId: 'STRING_VALUE' /* required */
    }
  },
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createQuickConnect(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the quick connect.

    • Description — (String)

      The description of the quick connect.

    • QuickConnectConfig — (map)

      Configuration settings for the quick connect.

      • QuickConnectTyperequired — (String)

        The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

        Possible values include:
        • "USER"
        • "QUEUE"
        • "PHONE_NUMBER"
      • UserConfig — (map)

        The user configuration. This is required only if QuickConnectType is USER.

        • UserIdrequired — (String)

          The identifier of the user.

        • ContactFlowIdrequired — (String)

          The identifier of the flow.

      • QueueConfig — (map)

        The queue configuration. This is required only if QuickConnectType is QUEUE.

        • QueueIdrequired — (String)

          The identifier for the queue.

        • ContactFlowIdrequired — (String)

          The identifier of the flow.

      • PhoneConfig — (map)

        The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

        • PhoneNumberrequired — (String)

          The phone number in E.164 format.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • QuickConnectARN — (String)

        The Amazon Resource Name (ARN) for the quick connect.

      • QuickConnectId — (String)

        The identifier for the quick connect.

Returns:

  • (AWS.Request)

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

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

Creates a new routing profile.

Service Reference:

Examples:

Calling the createRoutingProfile operation

var params = {
  DefaultOutboundQueueId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  MediaConcurrencies: [ /* required */
    {
      Channel: VOICE | CHAT | TASK, /* required */
      Concurrency: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  QueueConfigs: [
    {
      Delay: 'NUMBER_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      QueueReference: { /* required */
        Channel: VOICE | CHAT | TASK, /* required */
        QueueId: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createRoutingProfile(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the routing profile. Must not be more than 127 characters.

    • Description — (String)

      Description of the routing profile. Must not be more than 250 characters.

    • DefaultOutboundQueueId — (String)

      The default outbound queue for the routing profile.

    • QueueConfigs — (Array<map>)

      The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

      • QueueReferencerequired — (map)

        Contains information about a queue resource.

        • QueueIdrequired — (String)

          The identifier for the queue.

        • Channelrequired — (String)

          The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

          Possible values include:
          • "VOICE"
          • "CHAT"
          • "TASK"
      • Priorityrequired — (Integer)

        The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

      • Delayrequired — (Integer)

        The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

    • MediaConcurrencies — (Array<map>)

      The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.

      • Channelrequired — (String)

        The channels that agents can handle in the Contact Control Panel (CCP).

        Possible values include:
        • "VOICE"
        • "CHAT"
        • "TASK"
      • Concurrencyrequired — (Integer)

        The number of contacts an agent can have on a channel simultaneously.

        Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

        Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

        Valid Range for TASK: Minimum value of 1. Maximum value of 10.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • RoutingProfileArn — (String)

        The Amazon Resource Name (ARN) of the routing profile.

      • RoutingProfileId — (String)

        The identifier of the routing profile.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Creates a security profile.

Service Reference:

Examples:

Calling the createSecurityProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileName: 'STRING_VALUE', /* required */
  AllowedAccessControlTags: {
    '<SecurityProfilePolicyKey>': 'STRING_VALUE',
    /* '<SecurityProfilePolicyKey>': ... */
  },
  Description: 'STRING_VALUE',
  Permissions: [
    'STRING_VALUE',
    /* more items */
  ],
  TagRestrictedResources: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createSecurityProfile(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: {})
    • SecurityProfileName — (String)

      The name of the security profile.

    • Description — (String)

      The description of the security profile.

    • Permissions — (Array<String>)

      Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

    • AllowedAccessControlTags — (map<String>)

      The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

    • TagRestrictedResources — (Array<String>)

      The list of resources that a security profile applies tag restrictions to in Amazon Connect.

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:

      • SecurityProfileId — (String)

        The identifier for the security profle.

      • SecurityProfileArn — (String)

        The Amazon Resource Name (ARN) for the security profile.

Returns:

  • (AWS.Request)

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

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

Creates a new task template in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the createTaskTemplate operation

var params = {
  Fields: [ /* required */
    {
      Id: { /* required */
        Name: 'STRING_VALUE'
      },
      Description: 'STRING_VALUE',
      SingleSelectOptions: [
        'STRING_VALUE',
        /* more items */
      ],
      Type: NAME | DESCRIPTION | SCHEDULED_TIME | QUICK_CONNECT | URL | NUMBER | TEXT | TEXT_AREA | DATE_TIME | BOOLEAN | SINGLE_SELECT | EMAIL
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Constraints: {
    InvisibleFields: [
      {
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    ReadOnlyFields: [
      {
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    RequiredFields: [
      {
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  ContactFlowId: 'STRING_VALUE',
  Defaults: {
    DefaultFieldValues: [
      {
        DefaultValue: 'STRING_VALUE',
        Id: {
          Name: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  Description: 'STRING_VALUE',
  Status: ACTIVE | INACTIVE
};
connect.createTaskTemplate(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Name — (String)

      The name of the task template.

    • Description — (String)

      The description of the task template.

    • ContactFlowId — (String)

      The identifier of the flow that runs by default when a task is created by referencing this template.

    • Constraints — (map)

      Constraints that are applicable to the fields listed.

      • RequiredFields — (Array<map>)

        Lists the fields that are required to be filled by agents.

        • Id — (map)

          The unique identifier for the field.

          • Name — (String)

            The name of the task template field.

      • ReadOnlyFields — (Array<map>)

        Lists the fields that are read-only to agents, and cannot be edited.

        • Id — (map)

          Identifier of the read-only field.

          • Name — (String)

            The name of the task template field.

      • InvisibleFields — (Array<map>)

        Lists the fields that are invisible to agents.

        • Id — (map)

          Identifier of the invisible field.

          • Name — (String)

            The name of the task template field.

    • Defaults — (map)

      The default values for fields when a task is created by referencing this template.

      • DefaultFieldValues — (Array<map>)

        Default value for the field.

        • Id — (map)

          Identifier of a field.

          • Name — (String)

            The name of the task template field.

        • DefaultValue — (String)

          Default value for the field.

    • Status — (String)

      Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • Fields — (Array<map>)

      Fields that are part of the template.

      • Idrequired — (map)

        The unique identifier for the field.

        • Name — (String)

          The name of the task template field.

      • Description — (String)

        The description of the field.

      • Type — (String)

        Indicates the type of field.

        Possible values include:
        • "NAME"
        • "DESCRIPTION"
        • "SCHEDULED_TIME"
        • "QUICK_CONNECT"
        • "URL"
        • "NUMBER"
        • "TEXT"
        • "TEXT_AREA"
        • "DATE_TIME"
        • "BOOLEAN"
        • "SINGLE_SELECT"
        • "EMAIL"
      • SingleSelectOptions — (Array<String>)

        A list of options for a single select field.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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)

        The identifier of the task template resource.

      • Arn — (String)

        The Amazon Resource Name (ARN) for the task template resource.

Returns:

  • (AWS.Request)

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

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

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the createTrafficDistributionGroup operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createTrafficDistributionGroup(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 for the traffic distribution group.

    • Description — (String)

      A description for the traffic distribution group.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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)

        The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the traffic distribution group.

Returns:

  • (AWS.Request)

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

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

Creates a use case for an integration association.

Service Reference:

Examples:

Calling the createUseCase operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationAssociationId: 'STRING_VALUE', /* required */
  UseCaseType: RULES_EVALUATION | CONNECT_CAMPAIGNS, /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUseCase(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • IntegrationAssociationId — (String)

      The identifier for the integration association.

    • UseCaseType — (String)

      The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

      Possible values include:
      • "RULES_EVALUATION"
      • "CONNECT_CAMPAIGNS"
    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • UseCaseId — (String)

        The identifier of the use case.

      • UseCaseArn — (String)

        The Amazon Resource Name (ARN) for the use case.

Returns:

  • (AWS.Request)

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

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

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the createUser operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PhoneConfig: { /* required */
    PhoneType: SOFT_PHONE | DESK_PHONE, /* required */
    AfterContactWorkTimeLimit: 'NUMBER_VALUE',
    AutoAccept: true || false,
    DeskPhoneNumber: 'STRING_VALUE'
  },
  RoutingProfileId: 'STRING_VALUE', /* required */
  SecurityProfileIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Username: 'STRING_VALUE', /* required */
  DirectoryUserId: 'STRING_VALUE',
  HierarchyGroupId: 'STRING_VALUE',
  IdentityInfo: {
    Email: 'STRING_VALUE',
    FirstName: 'STRING_VALUE',
    LastName: 'STRING_VALUE',
    Mobile: 'STRING_VALUE',
    SecondaryEmail: 'STRING_VALUE'
  },
  Password: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUser(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: {})
    • Username — (String)

      The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

    • Password — (String)

      The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

    • IdentityInfo — (map)

      The information about the identity of the user.

      • FirstName — (String)

        The first name. This is required if you are using Amazon Connect or SAML for identity management.

      • LastName — (String)

        The last name. This is required if you are using Amazon Connect or SAML for identity management.

      • Email — (String)

        The email address. If you are using SAML for identity management and include this parameter, an error is returned.

      • SecondaryEmail — (String)

        The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

        Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,63}

      • Mobile — (String)

        The user's mobile number.

    • PhoneConfig — (map)

      The phone settings for the user.

      • PhoneTyperequired — (String)

        The phone type.

        Possible values include:
        • "SOFT_PHONE"
        • "DESK_PHONE"
      • AutoAccept — (Boolean)

        The Auto accept setting.

      • AfterContactWorkTimeLimit — (Integer)

        The After Call Work (ACW) timeout setting, in seconds.

        Note: When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
      • DeskPhoneNumber — (String)

        The phone number for the user's desk phone.

    • DirectoryUserId — (String)

      The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

      This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

    • SecurityProfileIds — (Array<String>)

      The identifier of the security profile for the user.

    • RoutingProfileId — (String)

      The identifier of the routing profile for the user.

    • HierarchyGroupId — (String)

      The identifier of the hierarchy group for the user.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • UserId — (String)

        The identifier of the user account.

      • UserArn — (String)

        The Amazon Resource Name (ARN) of the user account.

Returns:

  • (AWS.Request)

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

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

Creates a new user hierarchy group.

Service Reference:

Examples:

Calling the createUserHierarchyGroup operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ParentGroupId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUserHierarchyGroup(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 the user hierarchy group. Must not be more than 100 characters.

    • ParentGroupId — (String)

      The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • HierarchyGroupId — (String)

        The identifier of the hierarchy group.

      • HierarchyGroupArn — (String)

        The Amazon Resource Name (ARN) of the hierarchy group.

Returns:

  • (AWS.Request)

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

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

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Service Reference:

Examples:

Calling the createVocabulary operation

var params = {
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  LanguageCode: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN, /* required */
  VocabularyName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createVocabulary(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: {})
    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.

      If a token is not provided, the SDK will use a version 4 UUID.
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • VocabularyName — (String)

      A unique name of the custom vocabulary.

    • LanguageCode — (String)

      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

      Possible values include:
      • "ar-AE"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fr-CA"
      • "fr-FR"
      • "hi-IN"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "pt-BR"
      • "pt-PT"
      • "zh-CN"
    • Content — (String)

      The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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:

      • VocabularyArn — (String)

        The Amazon Resource Name (ARN) of the custom vocabulary.

      • VocabularyId — (String)

        The identifier of the custom vocabulary.

      • State — (String)

        The current state of the custom vocabulary.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "ACTIVE"
        • "CREATION_FAILED"
        • "DELETE_IN_PROGRESS"

Returns:

  • (AWS.Request)

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

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

Deletes a flow for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the deleteContactFlow operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteContactFlow(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowId — (String)

      The identifier of the flow.

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.

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

Deletes the specified flow module.

Service Reference:

Examples:

Calling the deleteContactFlowModule operation

var params = {
  ContactFlowModuleId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteContactFlowModule(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowModuleId — (String)

      The identifier of the flow module.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Deletes an hours of operation.

Service Reference:

Examples:

Calling the deleteHoursOfOperation operation

var params = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteHoursOfOperation(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • HoursOfOperationId — (String)

      The identifier for the hours of operation.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Deletes the Amazon Connect instance.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Service Reference:

Examples:

Calling the deleteInstance operation

var params = {
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteInstance(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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.

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

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

Service Reference:

Examples:

Calling the deleteIntegrationAssociation operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationAssociationId: 'STRING_VALUE' /* required */
};
connect.deleteIntegrationAssociation(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • IntegrationAssociationId — (String)

      The identifier for the integration association.

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.

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

Deletes a quick connect.

Service Reference:

Examples:

Calling the deleteQuickConnect operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QuickConnectId: 'STRING_VALUE' /* required */
};
connect.deleteQuickConnect(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QuickConnectId — (String)

      The identifier for the quick connect.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Deletes a security profile.

Service Reference:

Examples:

Calling the deleteSecurityProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileId: 'STRING_VALUE' /* required */
};
connect.deleteSecurityProfile(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • SecurityProfileId — (String)

      The identifier for the security profle.

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.

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

Deletes the task template.

Service Reference:

Examples:

Calling the deleteTaskTemplate operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TaskTemplateId: 'STRING_VALUE' /* required */
};
connect.deleteTaskTemplate(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • TaskTemplateId — (String)

      A unique identifier for the task template.

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.

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

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the deleteTrafficDistributionGroup operation

var params = {
  TrafficDistributionGroupId: 'STRING_VALUE' /* required */
};
connect.deleteTrafficDistributionGroup(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: {})
    • TrafficDistributionGroupId — (String)

      The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

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.

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

Deletes a use case from an integration association.

Service Reference:

Examples:

Calling the deleteUseCase operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationAssociationId: 'STRING_VALUE', /* required */
  UseCaseId: 'STRING_VALUE' /* required */
};
connect.deleteUseCase(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • IntegrationAssociationId — (String)

      The identifier for the integration association.

    • UseCaseId — (String)

      The identifier for the use case.

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.

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

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.deleteUser(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • UserId — (String)

      The identifier of the user.

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.

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

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

Service Reference:

Examples:

Calling the deleteUserHierarchyGroup operation

var params = {
  HierarchyGroupId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteUserHierarchyGroup(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: {})
    • HierarchyGroupId — (String)

      The identifier of the hierarchy group.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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.

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

Deletes the vocabulary that has the given identifier.

Service Reference:

Examples:

Calling the deleteVocabulary operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  VocabularyId: 'STRING_VALUE' /* required */
};
connect.deleteVocabulary(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • VocabularyId — (String)

      The identifier of the custom vocabulary.

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:

      • VocabularyArn — (String)

        The Amazon Resource Name (ARN) of the custom vocabulary.

      • VocabularyId — (String)

        The identifier of the custom vocabulary.

      • State — (String)

        The current state of the custom vocabulary.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "ACTIVE"
        • "CREATION_FAILED"
        • "DELETE_IN_PROGRESS"

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Describes an agent status.

Service Reference:

Examples:

Calling the describeAgentStatus operation

var params = {
  AgentStatusId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeAgentStatus(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AgentStatusId — (String)

      The identifier for the agent status.

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:

      • AgentStatus — (map)

        The agent status.

        • AgentStatusARN — (String)

          The Amazon Resource Name (ARN) of the agent status.

        • AgentStatusId — (String)

          The identifier of the agent status.

        • Name — (String)

          The name of the agent status.

        • Description — (String)

          The description of the agent status.

        • Type — (String)

          The type of agent status.

          Possible values include:
          • "ROUTABLE"
          • "CUSTOM"
          • "OFFLINE"
        • DisplayOrder — (Integer)

          The display order of the agent status.

        • State — (String)

          The state of the agent status.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified contact.

Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

Only data from November 12, 2021, and later is returned by this API.

Service Reference:

Examples:

Calling the describeContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeContact(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

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:

      • Contact — (map)

        Information about the contact.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the contact.

        • Id — (String)

          The identifier for the contact.

        • InitialContactId — (String)

          If this contact is related to other contacts, this is the ID of the initial contact.

        • PreviousContactId — (String)

          If this contact is not the first contact, this is the ID of the previous contact.

        • InitiationMethod — (String)

          Indicates how the contact was initiated.

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
          • "TRANSFER"
          • "QUEUE_TRANSFER"
          • "CALLBACK"
          • "API"
        • Name — (String)

          The name of the contact.

        • Description — (String)

          The description of the contact.

        • Channel — (String)

          How the contact reached your contact center.

          Possible values include:
          • "VOICE"
          • "CHAT"
          • "TASK"
        • QueueInfo — (map)

          If this contact was queued, this contains information about the queue.

          • Id — (String)

            The unique identifier for the queue.

          • EnqueueTimestamp — (Date)

            The timestamp when the contact was added to the queue.

        • AgentInfo — (map)

          Information about the agent who accepted the contact.

          • Id — (String)

            The identifier of the agent who accepted the contact.

          • ConnectedToAgentTimestamp — (Date)

            The timestamp when the contact was connected to the agent.

        • InitiationTimestamp — (Date)

          The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived.

        • DisconnectTimestamp — (Date)

          The timestamp when the customer endpoint disconnected from Amazon Connect.

        • LastUpdateTimestamp — (Date)

          The timestamp when contact was last updated.

        • ScheduledTimestamp — (Date)

          The timestamp, in Unix epoch time format, at which to start running the inbound flow.

Returns:

  • (AWS.Request)

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

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

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

Service Reference:

Examples:

Calling the describeContactFlow operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeContactFlow(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • ContactFlowId — (String)

      The identifier of the flow.

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:

      • ContactFlow — (map)

        Information about the flow.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the flow.

        • Id — (String)

          The identifier of the flow.

        • Name — (String)

          The name of the flow.

        • Type — (String)

          The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

          Possible values include:
          • "CONTACT_FLOW"
          • "CUSTOMER_QUEUE"
          • "CUSTOMER_HOLD"
          • "CUSTOMER_WHISPER"
          • "AGENT_HOLD"
          • "AGENT_WHISPER"
          • "OUTBOUND_WHISPER"
          • "AGENT_TRANSFER"
          • "QUEUE_TRANSFER"
        • State — (String)

          The type of flow.

          Possible values include:
          • "ACTIVE"
          • "ARCHIVED"
        • Description — (String)

          The description of the flow.

        • Content — (String)

          The content of the flow.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

Describes the specified flow module.

Service Reference:

Examples:

Calling the describeContactFlowModule operation

var params = {
  ContactFlowModuleId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeContactFlowModule(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowModuleId — (String)

      The identifier of the flow module.

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:

      • ContactFlowModule — (map)

        Information about the flow module.

        • Arn — (String)

          The Amazon Resource Name (ARN).

        • Id — (String)

          The identifier of the flow module.

        • Name — (String)

          The name of the flow module.

        • Content — (String)

          The content of the flow module.

        • Description — (String)

          The description of the flow module.

        • State — (String)

          The type of flow module.

          Possible values include:
          • "ACTIVE"
          • "ARCHIVED"
        • Status — (String)

          The status of the flow module.

          Possible values include:
          • "PUBLISHED"
          • "SAVED"
        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Describes the hours of operation.

Service Reference:

Examples:

Calling the describeHoursOfOperation operation

var params = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeHoursOfOperation(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • HoursOfOperationId — (String)

      The identifier for the hours of operation.

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:

      • HoursOfOperation — (map)

        The hours of operation.

        • HoursOfOperationId — (String)

          The identifier for the hours of operation.

        • HoursOfOperationArn — (String)

          The Amazon Resource Name (ARN) for the hours of operation.

        • Name — (String)

          The name for the hours of operation.

        • Description — (String)

          The description for the hours of operation.

        • TimeZone — (String)

          The time zone for the hours of operation.

        • Config — (Array<map>)

          Configuration information for the hours of operation.

          • Dayrequired — (String)

            The day that the hours of operation applies to.

            Possible values include:
            • "SUNDAY"
            • "MONDAY"
            • "TUESDAY"
            • "WEDNESDAY"
            • "THURSDAY"
            • "FRIDAY"
            • "SATURDAY"
          • StartTimerequired — (map)

            The start time that your contact center opens.

            • Hoursrequired — (Integer)

              The hours.

            • Minutesrequired — (Integer)

              The minutes.

          • EndTimerequired — (map)

            The end time that your contact center closes.

            • Hoursrequired — (Integer)

              The hours.

            • Minutesrequired — (Integer)

              The minutes.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Service Reference:

Examples:

Calling the describeInstance operation

var params = {
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeInstance(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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:

      • Instance — (map)

        The name of the instance.

        • Id — (String)

          The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the instance.

        • IdentityManagementType — (String)

          The identity management type.

          Possible values include:
          • "SAML"
          • "CONNECT_MANAGED"
          • "EXISTING_DIRECTORY"
        • InstanceAlias — (String)

          The alias of instance.

        • CreatedTime — (Date)

          When the instance was created.

        • ServiceRole — (String)

          The service role of the instance.

        • InstanceStatus — (String)

          The state of the instance.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "ACTIVE"
          • "CREATION_FAILED"
        • StatusReason — (map)

          Relevant details why the instance was not successfully created.

          • Message — (String)

            The message.

        • InboundCallsEnabled — (Boolean)

          Whether inbound calls are enabled.

        • OutboundCallsEnabled — (Boolean)

          Whether outbound calls are enabled.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified instance attribute.

Service Reference:

Examples:

Calling the describeInstanceAttribute operation

var params = {
  AttributeType: INBOUND_CALLS | OUTBOUND_CALLS | CONTACTFLOW_LOGS | CONTACT_LENS | AUTO_RESOLVE_BEST_VOICES | USE_CUSTOM_TTS_VOICES | EARLY_MEDIA | MULTI_PARTY_CONFERENCE | HIGH_VOLUME_OUTBOUND | ENHANCED_CONTACT_MONITORING, /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeInstanceAttribute(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AttributeType — (String)

      The type of attribute.

      Possible values include:
      • "INBOUND_CALLS"
      • "OUTBOUND_CALLS"
      • "CONTACTFLOW_LOGS"
      • "CONTACT_LENS"
      • "AUTO_RESOLVE_BEST_VOICES"
      • "USE_CUSTOM_TTS_VOICES"
      • "EARLY_MEDIA"
      • "MULTI_PARTY_CONFERENCE"
      • "HIGH_VOLUME_OUTBOUND"
      • "ENHANCED_CONTACT_MONITORING"

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:

      • Attribute — (map)

        The type of attribute.

        • AttributeType — (String)

          The type of attribute.

          Possible values include:
          • "INBOUND_CALLS"
          • "OUTBOUND_CALLS"
          • "CONTACTFLOW_LOGS"
          • "CONTACT_LENS"
          • "AUTO_RESOLVE_BEST_VOICES"
          • "USE_CUSTOM_TTS_VOICES"
          • "EARLY_MEDIA"
          • "MULTI_PARTY_CONFERENCE"
          • "HIGH_VOLUME_OUTBOUND"
          • "ENHANCED_CONTACT_MONITORING"
        • Value — (String)

          The value of the attribute.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Service Reference:

Examples:

Calling the describeInstanceStorageConfig operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS /* required */
};
connect.describeInstanceStorageConfig(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "CHAT_TRANSCRIPTS"
      • "CALL_RECORDINGS"
      • "SCHEDULED_REPORTS"
      • "MEDIA_STREAMS"
      • "CONTACT_TRACE_RECORDS"
      • "AGENT_EVENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"

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:

      • StorageConfig — (map)

        A valid storage type.

        • AssociationId — (String)

          The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

        • StorageTyperequired — (String)

          A valid storage type.

          Possible values include:
          • "S3"
          • "KINESIS_VIDEO_STREAM"
          • "KINESIS_STREAM"
          • "KINESIS_FIREHOSE"
        • S3Config — (map)

          The S3 bucket configuration.

          • BucketNamerequired — (String)

            The S3 bucket name.

          • BucketPrefixrequired — (String)

            The S3 bucket prefix.

          • EncryptionConfig — (map)

            The Amazon S3 encryption configuration.

            • EncryptionTyperequired — (String)

              The type of encryption.

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

              The full ARN of the encryption key.

              Note: Be sure to provide the full ARN of the encryption key, not just the ID.
        • KinesisVideoStreamConfig — (map)

          The configuration of the Kinesis video stream.

          • Prefixrequired — (String)

            The prefix of the video stream.

          • RetentionPeriodHoursrequired — (Integer)

            The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

            The default value is 0, indicating that the stream does not persist data.

          • EncryptionConfigrequired — (map)

            The encryption configuration.

            • EncryptionTyperequired — (String)

              The type of encryption.

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

              The full ARN of the encryption key.

              Note: Be sure to provide the full ARN of the encryption key, not just the ID.
        • KinesisStreamConfig — (map)

          The configuration of the Kinesis data stream.

          • StreamArnrequired — (String)

            The Amazon Resource Name (ARN) of the data stream.

        • KinesisFirehoseConfig — (map)

          The configuration of the Kinesis Firehose delivery stream.

          • FirehoseArnrequired — (String)

            The Amazon Resource Name (ARN) of the delivery stream.

Returns:

  • (AWS.Request)

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

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

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Service Reference:

Examples:

Calling the describePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE' /* required */
};
connect.describePhoneNumber(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: {})
    • PhoneNumberId — (String)

      A unique identifier for the phone number.

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:

      • ClaimedPhoneNumberSummary — (map)

        Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.

        • PhoneNumberId — (String)

          A unique identifier for the phone number.

        • PhoneNumberArn — (String)

          The Amazon Resource Name (ARN) of the phone number.

        • PhoneNumber — (String)

          The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

        • PhoneNumberCountryCode — (String)

          The ISO country code.

          Possible values include:
          • "AF"
          • "AL"
          • "DZ"
          • "AS"
          • "AD"
          • "AO"
          • "AI"
          • "AQ"
          • "AG"
          • "AR"
          • "AM"
          • "AW"
          • "AU"
          • "AT"
          • "AZ"
          • "BS"
          • "BH"
          • "BD"
          • "BB"
          • "BY"
          • "BE"
          • "BZ"
          • "BJ"
          • "BM"
          • "BT"
          • "BO"
          • "BA"
          • "BW"
          • "BR"
          • "IO"
          • "VG"
          • "BN"
          • "BG"
          • "BF"
          • "BI"
          • "KH"
          • "CM"
          • "CA"
          • "CV"
          • "KY"
          • "CF"
          • "TD"
          • "CL"
          • "CN"
          • "CX"
          • "CC"
          • "CO"
          • "KM"
          • "CK"
          • "CR"
          • "HR"
          • "CU"
          • "CW"
          • "CY"
          • "CZ"
          • "CD"
          • "DK"
          • "DJ"
          • "DM"
          • "DO"
          • "TL"
          • "EC"
          • "EG"
          • "SV"
          • "GQ"
          • "ER"
          • "EE"
          • "ET"
          • "FK"
          • "FO"
          • "FJ"
          • "FI"
          • "FR"
          • "PF"
          • "GA"
          • "GM"
          • "GE"
          • "DE"
          • "GH"
          • "GI"
          • "GR"
          • "GL"
          • "GD"
          • "GU"
          • "GT"
          • "GG"
          • "GN"
          • "GW"
          • "GY"
          • "HT"
          • "HN"
          • "HK"
          • "HU"
          • "IS"
          • "IN"
          • "ID"
          • "IR"
          • "IQ"
          • "IE"
          • "IM"
          • "IL"
          • "IT"
          • "CI"
          • "JM"
          • "JP"
          • "JE"
          • "JO"
          • "KZ"
          • "KE"
          • "KI"
          • "KW"
          • "KG"
          • "LA"
          • "LV"
          • "LB"
          • "LS"
          • "LR"
          • "LY"
          • "LI"
          • "LT"
          • "LU"
          • "MO"
          • "MK"
          • "MG"
          • "MW"
          • "MY"
          • "MV"
          • "ML"
          • "MT"
          • "MH"
          • "MR"
          • "MU"
          • "YT"
          • "MX"
          • "FM"
          • "MD"
          • "MC"
          • "MN"
          • "ME"
          • "MS"
          • "MA"
          • "MZ"
          • "MM"
          • "NA"
          • "NR"
          • "NP"
          • "NL"
          • "AN"
          • "NC"
          • "NZ"
          • "NI"
          • "NE"
          • "NG"
          • "NU"
          • "KP"
          • "MP"
          • "NO"
          • "OM"
          • "PK"
          • "PW"
          • "PA"
          • "PG"
          • "PY"
          • "PE"
          • "PH"
          • "PN"
          • "PL"
          • "PT"
          • "PR"
          • "QA"
          • "CG"
          • "RE"
          • "RO"
          • "RU"
          • "RW"
          • "BL"
          • "SH"
          • "KN"
          • "LC"
          • "MF"
          • "PM"
          • "VC"
          • "WS"
          • "SM"
          • "ST"
          • "SA"
          • "SN"
          • "RS"
          • "SC"
          • "SL"
          • "SG"
          • "SX"
          • "SK"
          • "SI"
          • "SB"
          • "SO"
          • "ZA"
          • "KR"
          • "ES"
          • "LK"
          • "SD"
          • "SR"
          • "SJ"
          • "SZ"
          • "SE"
          • "CH"
          • "SY"
          • "TW"
          • "TJ"
          • "TZ"
          • "TH"
          • "TG"
          • "TK"
          • "TO"
          • "TT"
          • "TN"
          • "TR"
          • "TM"
          • "TC"
          • "TV"
          • "VI"
          • "UG"
          • "UA"
          • "AE"
          • "GB"
          • "US"
          • "UY"
          • "UZ"
          • "VU"
          • "VA"
          • "VE"
          • "VN"
          • "WF"
          • "EH"
          • "YE"
          • "ZM"
          • "ZW"
        • PhoneNumberType — (String)

          The type of phone number.

          Possible values include:
          • "TOLL_FREE"
          • "DID"
        • PhoneNumberDescription — (String)

          The description of the phone number.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

        • PhoneNumberStatus — (map)

          The status of the phone number.

          • CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.

          • IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

          • FAILED indicates that the previous ClaimedPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

          Note: You will not be billed for the phone number during the 1-day period if number claiming fails.
          • Status — (String)

            The status.

            Possible values include:
            • "CLAIMED"
            • "IN_PROGRESS"
            • "FAILED"
          • Message — (String)

            The status message.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified queue.

Service Reference:

Examples:

Calling the describeQueue operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE' /* required */
};
connect.describeQueue(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QueueId — (String)

      The identifier for the queue.

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:

      • Queue — (map)

        The name of the queue.

        • Name — (String)

          The name of the queue.

        • QueueArn — (String)

          The Amazon Resource Name (ARN) for the queue.

        • QueueId — (String)

          The identifier for the queue.

        • Description — (String)

          The description of the queue.

        • OutboundCallerConfig — (map)

          The outbound caller ID name, number, and outbound whisper flow.

          • OutboundCallerIdName — (String)

            The caller ID name.

          • OutboundCallerIdNumberId — (String)

            The caller ID number.

          • OutboundFlowId — (String)

            The outbound whisper flow to be used during an outbound call.

        • HoursOfOperationId — (String)

          The identifier for the hours of operation.

        • MaxContacts — (Integer)

          The maximum number of contacts that can be in the queue before it is considered full.

        • Status — (String)

          The status of the queue.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

Describes the quick connect.

Service Reference:

Examples:

Calling the describeQuickConnect operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QuickConnectId: 'STRING_VALUE' /* required */
};
connect.describeQuickConnect(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QuickConnectId — (String)

      The identifier for the quick connect.

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:

      • QuickConnect — (map)

        Information about the quick connect.

        • QuickConnectARN — (String)

          The Amazon Resource Name (ARN) of the quick connect.

        • QuickConnectId — (String)

          The identifier for the quick connect.

        • Name — (String)

          The name of the quick connect.

        • Description — (String)

          The description.

        • QuickConnectConfig — (map)

          Contains information about the quick connect.

          • QuickConnectTyperequired — (String)

            The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

            Possible values include:
            • "USER"
            • "QUEUE"
            • "PHONE_NUMBER"
          • UserConfig — (map)

            The user configuration. This is required only if QuickConnectType is USER.

            • UserIdrequired — (String)

              The identifier of the user.

            • ContactFlowIdrequired — (String)

              The identifier of the flow.

          • QueueConfig — (map)

            The queue configuration. This is required only if QuickConnectType is QUEUE.

            • QueueIdrequired — (String)

              The identifier for the queue.

            • ContactFlowIdrequired — (String)

              The identifier of the flow.

          • PhoneConfig — (map)

            The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

            • PhoneNumberrequired — (String)

              The phone number in E.164 format.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

Describes the specified routing profile.

Service Reference:

Examples:

Calling the describeRoutingProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.describeRoutingProfile(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

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:

      • RoutingProfile — (map)

        The routing profile.

        • InstanceId — (String)

          The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • Name — (String)

          The name of the routing profile.

        • RoutingProfileArn — (String)

          The Amazon Resource Name (ARN) of the routing profile.

        • RoutingProfileId — (String)

          The identifier of the routing profile.

        • Description — (String)

          The description of the routing profile.

        • MediaConcurrencies — (Array<map>)

          The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

          • Channelrequired — (String)

            The channels that agents can handle in the Contact Control Panel (CCP).

            Possible values include:
            • "VOICE"
            • "CHAT"
            • "TASK"
          • Concurrencyrequired — (Integer)

            The number of contacts an agent can have on a channel simultaneously.

            Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

            Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

            Valid Range for TASK: Minimum value of 1. Maximum value of 10.

        • DefaultOutboundQueueId — (String)

          The identifier of the default outbound queue for this routing profile.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

        • NumberOfAssociatedQueues — (Integer)

          The number of associated queues in routing profile.

        • NumberOfAssociatedUsers — (Integer)

          The number of associated users in routing profile.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Gets basic information about the security profle.

Service Reference:

Examples:

Calling the describeSecurityProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileId: 'STRING_VALUE' /* required */
};
connect.describeSecurityProfile(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: {})
    • SecurityProfileId — (String)

      The identifier for the security profle.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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:

      • SecurityProfile — (map)

        The security profile.

        • Id — (String)

          The identifier for the security profile.

        • OrganizationResourceId — (String)

          The organization resource identifier for the security profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the secruity profile.

        • SecurityProfileName — (String)

          The name for the security profile.

        • Description — (String)

          The description of the security profile.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

        • AllowedAccessControlTags — (map<String>)

          The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

        • TagRestrictedResources — (Array<String>)

          The list of resources that a security profile applies tag restrictions to in Amazon Connect.

Returns:

  • (AWS.Request)

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

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

Gets details and status of a traffic distribution group.

Examples:

Calling the describeTrafficDistributionGroup operation

var params = {
  TrafficDistributionGroupId: 'STRING_VALUE' /* required */
};
connect.describeTrafficDistributionGroup(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: {})
    • TrafficDistributionGroupId — (String)

      The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

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:

      • TrafficDistributionGroup — (map)

        Information about the traffic distribution group.

        • Id — (String)

          The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the traffic distribution group.

        • Name — (String)

          The name of the traffic distribution group.

        • Description — (String)

          The description of the traffic distribution group.

        • InstanceArn — (String)

          The Amazon Resource Name (ARN).

        • Status — (String)

          The status of the traffic distribution group.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "ACTIVE"
          • "CREATION_FAILED"
          • "PENDING_DELETION"
          • "DELETION_FAILED"
          • "UPDATE_IN_PROGRESS"
        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Service Reference:

Examples:

Calling the describeUser operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.describeUser(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: {})
    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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:

      • User — (map)

        Information about the user account and configuration settings.

        • Id — (String)

          The identifier of the user account.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the user account.

        • Username — (String)

          The user name assigned to the user account.

        • IdentityInfo — (map)

          Information about the user identity.

          • FirstName — (String)

            The first name. This is required if you are using Amazon Connect or SAML for identity management.

          • LastName — (String)

            The last name. This is required if you are using Amazon Connect or SAML for identity management.

          • Email — (String)

            The email address. If you are using SAML for identity management and include this parameter, an error is returned.

          • SecondaryEmail — (String)

            The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

            Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,63}

          • Mobile — (String)

            The user's mobile number.

        • PhoneConfig — (map)

          Information about the phone configuration for the user.

          • PhoneTyperequired — (String)

            The phone type.

            Possible values include:
            • "SOFT_PHONE"
            • "DESK_PHONE"
          • AutoAccept — (Boolean)

            The Auto accept setting.

          • AfterContactWorkTimeLimit — (Integer)

            The After Call Work (ACW) timeout setting, in seconds.

            Note: When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
          • DeskPhoneNumber — (String)

            The phone number for the user's desk phone.

        • DirectoryUserId — (String)

          The identifier of the user account in the directory used for identity management.

        • SecurityProfileIds — (Array<String>)

          The identifiers of the security profiles for the user.

        • RoutingProfileId — (String)

          The identifier of the routing profile for the user.

        • HierarchyGroupId — (String)

          The identifier of the hierarchy group for the user.

        • Tags — (map<String>)

          The tags.

Returns:

  • (AWS.Request)

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

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

Describes the specified hierarchy group.

Service Reference:

Examples:

Calling the describeUserHierarchyGroup operation

var params = {
  HierarchyGroupId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeUserHierarchyGroup(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: {})
    • HierarchyGroupId — (String)

      The identifier of the hierarchy group.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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:

      • HierarchyGroup — (map)

        Information about the hierarchy group.

        • Id — (String)

          The identifier of the hierarchy group.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the hierarchy group.

        • Name — (String)

          The name of the hierarchy group.

        • LevelId — (String)

          The identifier of the level in the hierarchy group.

        • HierarchyPath — (map)

          Information about the levels in the hierarchy group.

          • LevelOne — (map)

            Information about level one.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelTwo — (map)

            Information about level two.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelThree — (map)

            Information about level three.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelFour — (map)

            Information about level four.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelFive — (map)

            Information about level five.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

Describes the hierarchy structure of the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the describeUserHierarchyStructure operation

var params = {
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeUserHierarchyStructure(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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:

      • HierarchyStructure — (map)

        Information about the hierarchy structure.

        • LevelOne — (map)

          Information about level one.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the hierarchy level.

          • Name — (String)

            The name of the hierarchy level.

        • LevelTwo — (map)

          Information about level two.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the hierarchy level.

          • Name — (String)

            The name of the hierarchy level.

        • LevelThree — (map)

          Information about level three.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the hierarchy level.

          • Name — (String)

            The name of the hierarchy level.

        • LevelFour — (map)

          Information about level four.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the hierarchy level.

          • Name — (String)

            The name of the hierarchy level.

        • LevelFive — (map)

          Information about level five.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the hierarchy level.

          • Name — (String)

            The name of the hierarchy level.

Returns:

  • (AWS.Request)

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

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

Describes the specified vocabulary.

Service Reference:

Examples:

Calling the describeVocabulary operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  VocabularyId: 'STRING_VALUE' /* required */
};
connect.describeVocabulary(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • VocabularyId — (String)

      The identifier of the custom vocabulary.

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:

      • Vocabulary — (map)

        A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.

        • Namerequired — (String)

          A unique name of the custom vocabulary.

        • Idrequired — (String)

          The identifier of the custom vocabulary.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the custom vocabulary.

        • LanguageCoderequired — (String)

          The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

          Possible values include:
          • "ar-AE"
          • "de-CH"
          • "de-DE"
          • "en-AB"
          • "en-AU"
          • "en-GB"
          • "en-IE"
          • "en-IN"
          • "en-US"
          • "en-WL"
          • "es-ES"
          • "es-US"
          • "fr-CA"
          • "fr-FR"
          • "hi-IN"
          • "it-IT"
          • "ja-JP"
          • "ko-KR"
          • "pt-BR"
          • "pt-PT"
          • "zh-CN"
        • Staterequired — (String)

          The current state of the custom vocabulary.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "ACTIVE"
          • "CREATION_FAILED"
          • "DELETE_IN_PROGRESS"
        • LastModifiedTimerequired — (Date)

          The timestamp when the custom vocabulary was last modified.

        • FailureReason — (String)

          The reason why the custom vocabulary was not created.

        • Content — (String)

          The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Revokes access to integrated applications from Amazon Connect.

Service Reference:

Examples:

Calling the disassociateApprovedOrigin operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Origin: 'STRING_VALUE' /* required */
};
connect.disassociateApprovedOrigin(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Origin — (String)

      The domain URL of the integrated application.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Service Reference:

Examples:

Calling the disassociateBot operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: {
    LexRegion: 'STRING_VALUE',
    Name: 'STRING_VALUE'
  },
  LexV2Bot: {
    AliasArn: 'STRING_VALUE'
  }
};
connect.disassociateBot(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • LexBot — (map)

      Configuration information of an Amazon Lex bot.

      • Name — (String)

        The name of the Amazon Lex bot.

      • LexRegion — (String)

        The Amazon Web Services Region where the Amazon Lex bot was created.

    • LexV2Bot — (map)

      The Amazon Lex V2 bot to disassociate from the instance.

      • AliasArn — (String)

        The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Removes the storage type configurations for the specified resource type and association ID.

Examples:

Calling the disassociateInstanceStorageConfig operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS /* required */
};
connect.disassociateInstanceStorageConfig(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "CHAT_TRANSCRIPTS"
      • "CALL_RECORDINGS"
      • "SCHEDULED_REPORTS"
      • "MEDIA_STREAMS"
      • "CONTACT_TRACE_RECORDS"
      • "AGENT_EVENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Remove the Lambda function from the dropdown options available in the relevant flow blocks.

Service Reference:

Examples:

Calling the disassociateLambdaFunction operation

var params = {
  FunctionArn: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.disassociateLambdaFunction(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..

    • FunctionArn — (String)

      The Amazon Resource Name (ARN) of the Lambda function being disassociated.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Service Reference:

Examples:

Calling the disassociateLexBot operation

var params = {
  BotName: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  LexRegion: 'STRING_VALUE' /* required */
};
connect.disassociateLexBot(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • BotName — (String)

      The name of the Amazon Lex bot. Maximum character limit of 50.

    • LexRegion — (String)

      The Amazon Web Services Region in which the Amazon Lex bot has been created.

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.

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

Removes the flow association from a phone number claimed to your Amazon Connect instance.

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Examples:

Calling the disassociatePhoneNumberContactFlow operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PhoneNumberId: 'STRING_VALUE' /* required */
};
connect.disassociatePhoneNumberContactFlow(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: {})
    • PhoneNumberId — (String)

      A unique identifier for the phone number.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Disassociates a set of quick connects from a queue.

Service Reference:

Examples:

Calling the disassociateQueueQuickConnects operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  QuickConnectIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connect.disassociateQueueQuickConnects(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • QuickConnectIds — (Array<String>)

      The quick connects to disassociate from the queue.

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.

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

Disassociates a set of queues from a routing profile.

Examples:

Calling the disassociateRoutingProfileQueues operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueReferences: [ /* required */
    {
      Channel: VOICE | CHAT | TASK, /* required */
      QueueId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.disassociateRoutingProfileQueues(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • QueueReferences — (Array<map>)

      The queues to disassociate from this routing profile.

      • QueueIdrequired — (String)

        The identifier for the queue.

      • Channelrequired — (String)

        The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

        Possible values include:
        • "VOICE"
        • "CHAT"
        • "TASK"

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Deletes the specified security key.

Service Reference:

Examples:

Calling the disassociateSecurityKey operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.disassociateSecurityKey(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given 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.

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

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

Service Reference:

Examples:

Calling the dismissUserContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.dismissUserContact(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: {})
    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

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.

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

Retrieves the contact attributes for the specified contact.

Service Reference:

Examples:

Calling the getContactAttributes operation

var params = {
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.getContactAttributes(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • InitialContactId — (String)

      The identifier of the initial contact.

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:

      • Attributes — (map<String>)

        Information about the attributes.

Returns:

  • (AWS.Request)

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

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

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the getCurrentMetricData operation

var params = {
  CurrentMetrics: [ /* required */
    {
      Name: AGENTS_ONLINE | AGENTS_AVAILABLE | AGENTS_ON_CALL | AGENTS_NON_PRODUCTIVE | AGENTS_AFTER_CONTACT_WORK | AGENTS_ERROR | AGENTS_STAFFED | CONTACTS_IN_QUEUE | OLDEST_CONTACT_AGE | CONTACTS_SCHEDULED | AGENTS_ON_CONTACT | SLOTS_ACTIVE | SLOTS_AVAILABLE,
      Unit: SECONDS | COUNT | PERCENT
    },
    /* more items */
  ],
  Filters: { /* required */
    Channels: [
      VOICE | CHAT | TASK,
      /* more items */
    ],
    Queues: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  InstanceId: 'STRING_VALUE', /* required */
  Groupings: [
    QUEUE | CHANNEL,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.getCurrentMetricData(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Filters — (map)

      The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

      • Queues — (Array<String>)

        The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.

      • Channels — (Array<String>)

        The channel to use to filter the metrics.

    • Groupings — (Array<String>)

      The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.

      • If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.

      • If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter.

      • If no Grouping is included in the request, a summary of metrics is returned.

    • CurrentMetrics — (Array<map>)

      The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

      AGENTS_AFTER_CONTACT_WORK

      Unit: COUNT

      Name in real-time metrics report: ACW

      AGENTS_AVAILABLE

      Unit: COUNT

      Name in real-time metrics report: Available

      AGENTS_ERROR

      Unit: COUNT

      Name in real-time metrics report: Error

      AGENTS_NON_PRODUCTIVE

      Unit: COUNT

      Name in real-time metrics report: NPT (Non-Productive Time)

      AGENTS_ON_CALL

      Unit: COUNT

      Name in real-time metrics report: On contact

      AGENTS_ON_CONTACT

      Unit: COUNT

      Name in real-time metrics report: On contact

      AGENTS_ONLINE

      Unit: COUNT

      Name in real-time metrics report: Online

      AGENTS_STAFFED

      Unit: COUNT

      Name in real-time metrics report: Staffed

      CONTACTS_IN_QUEUE

      Unit: COUNT

      Name in real-time metrics report: In queue

      CONTACTS_SCHEDULED

      Unit: COUNT

      Name in real-time metrics report: Scheduled

      OLDEST_CONTACT_AGE

      Unit: SECONDS

      When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

      When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

      { "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 }

      The actual OLDEST_CONTACT_AGE is 24 seconds.

      Name in real-time metrics report: Oldest

      SLOTS_ACTIVE

      Unit: COUNT

      Name in real-time metrics report: Active

      SLOTS_AVAILABLE

      Unit: COUNT

      Name in real-time metrics report: Availability

      • Name — (String)

        The name of the metric.

        Possible values include:
        • "AGENTS_ONLINE"
        • "AGENTS_AVAILABLE"
        • "AGENTS_ON_CALL"
        • "AGENTS_NON_PRODUCTIVE"
        • "AGENTS_AFTER_CONTACT_WORK"
        • "AGENTS_ERROR"
        • "AGENTS_STAFFED"
        • "CONTACTS_IN_QUEUE"
        • "OLDEST_CONTACT_AGE"
        • "CONTACTS_SCHEDULED"
        • "AGENTS_ON_CONTACT"
        • "SLOTS_ACTIVE"
        • "SLOTS_AVAILABLE"
      • Unit — (String)

        The unit for the metric.

        Possible values include:
        • "SECONDS"
        • "COUNT"
        • "PERCENT"
    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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)

        If there are additional results, this is the token for the next set of results.

        The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

      • MetricResults — (Array<map>)

        Information about the real-time metrics.

        • Dimensions — (map)

          The dimensions for the metrics.

          • Queue — (map)

            Information about the queue for which metrics are returned.

            • Id — (String)

              The identifier of the queue.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the queue.

          • Channel — (String)

            The channel used for grouping and filters.

            Possible values include:
            • "VOICE"
            • "CHAT"
            • "TASK"
        • Collections — (Array<map>)

          The set of metrics.

          • Metric — (map)

            Information about the metric.

            • Name — (String)

              The name of the metric.

              Possible values include:
              • "AGENTS_ONLINE"
              • "AGENTS_AVAILABLE"
              • "AGENTS_ON_CALL"
              • "AGENTS_NON_PRODUCTIVE"
              • "AGENTS_AFTER_CONTACT_WORK"
              • "AGENTS_ERROR"
              • "AGENTS_STAFFED"
              • "CONTACTS_IN_QUEUE"
              • "OLDEST_CONTACT_AGE"
              • "CONTACTS_SCHEDULED"
              • "AGENTS_ON_CONTACT"
              • "SLOTS_ACTIVE"
              • "SLOTS_AVAILABLE"
            • Unit — (String)

              The unit for the metric.

              Possible values include:
              • "SECONDS"
              • "COUNT"
              • "PERCENT"
          • Value — (Float)

            The value of the metric.

      • DataSnapshotTime — (Date)

        The time at which the metrics were retrieved and cached for pagination.

Returns:

  • (AWS.Request)

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

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

Gets the real-time active user data from the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the getCurrentUserData operation

var params = {
  Filters: { /* required */
    ContactFilter: {
      ContactStates: [
        INCOMING | PENDING | CONNECTING | CONNECTED | CONNECTED_ONHOLD | MISSED | ERROR | ENDED | REJECTED,
        /* more items */
      ]
    },
    Queues: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.getCurrentUserData(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Filters — (map)

      Filters up to 100 Queues, or up to 9 ContactStates. The user data is retrieved only for those users who are associated with the queues and have contacts that are in the specified ContactState.

      • Queues — (Array<String>)

        Contains information about a queue resource for which metrics are returned.

      • ContactFilter — (map)

        A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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)

        If there are additional results, this is the token for the next set of results.

      • UserDataList — (Array<map>)

        A list of the user data that is returned.

        • User — (map)

          Information about the user for the data that is returned. It contains the resourceId and ARN of the user.

          • Id — (String)

            The unique identifier for the user.

          • Arn — (String)

            The Amazon Resource Name (ARN) for the user.

        • RoutingProfile — (map)

          Information about the routing profile that is assigned to the user.

          • Id — (String)

            The identifier of the routing profile.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the routing profile.

        • HierarchyPath — (map)

          Contains information about the levels of a hierarchy group assigned to a user.

          • LevelOne — (map)

            Information about level one.

            • Id — (String)

              The unique identifier for the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) for the hierarchy group.

          • LevelTwo — (map)

            Information about level two.

            • Id — (String)

              The unique identifier for the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) for the hierarchy group.

          • LevelThree — (map)

            Information about level three.

            • Id — (String)

              The unique identifier for the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) for the hierarchy group.

          • LevelFour — (map)

            Information about level four.

            • Id — (String)

              The unique identifier for the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) for the hierarchy group.

          • LevelFive — (map)

            Information about level five.

            • Id — (String)

              The unique identifier for the hierarchy group.

            • Arn — (String)

              The Amazon Resource Name (ARN) for the hierarchy group.

        • Status — (map)

          The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.

          • StatusStartTimestamp — (Date)

            The start timestamp of the agent's status.

          • StatusArn — (String)

            The Amazon Resource Name (ARN) of the agent's status.

        • AvailableSlotsByChannel — (map<Integer>)

          A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.

        • MaxSlotsByChannel — (map<Integer>)

          A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.

        • ActiveSlotsByChannel — (map<Integer>)

          A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.

        • Contacts — (Array<map>)

          A list of contact reference information.

          • ContactId — (String)

            The identifier of the contact in this instance of Amazon Connect.

          • Channel — (String)

            The channel of the contact.

            Possible values include:
            • "VOICE"
            • "CHAT"
            • "TASK"
          • InitiationMethod — (String)

            How the contact was initiated.

            Possible values include:
            • "INBOUND"
            • "OUTBOUND"
            • "TRANSFER"
            • "QUEUE_TRANSFER"
            • "CALLBACK"
            • "API"
          • AgentContactState — (String)

            The state of the contact.

            Possible values include:
            • "INCOMING"
            • "PENDING"
            • "CONNECTING"
            • "CONNECTED"
            • "CONNECTED_ONHOLD"
            • "MISSED"
            • "ERROR"
            • "ENDED"
            • "REJECTED"
          • StateStartTimestamp — (Date)

            The epoch timestamp when the contact state started.

          • ConnectedToAgentTimestamp — (Date)

            The time at which the contact was connected to an agent.

          • Queue — (map)

            Contains information about a queue resource for which metrics are returned.

            • Id — (String)

              The identifier of the queue.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the queue.

Returns:

  • (AWS.Request)

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

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

Retrieves a token for federation.

Note: This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

Service Reference:

Examples:

Calling the getFederationToken operation

var params = {
  InstanceId: 'STRING_VALUE' /* required */
};
connect.getFederationToken(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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:

      • Credentials — (map)

        The credentials to use for federation.

        • AccessToken — (String)

          An access token generated for a federated user to access Amazon Connect.

        • AccessTokenExpiration — (Date)

          A token generated with an expiration time for the session a user is logged in to Amazon Connect.

        • RefreshToken — (String)

          Renews a token generated for a user to access the Amazon Connect instance.

        • RefreshTokenExpiration — (Date)

          Renews the expiration timer for a generated token.

      • SignInUrl — (String)

        The URL to sign into the user's instance.

      • UserArn — (String)

        The Amazon Resource Name (ARN) of the user.

      • UserId — (String)

        The identifier for the user.

Returns:

  • (AWS.Request)

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

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

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the getMetricData operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Filters: { /* required */
    Channels: [
      VOICE | CHAT | TASK,
      /* more items */
    ],
    Queues: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  HistoricalMetrics: [ /* required */
    {
      Name: CONTACTS_QUEUED | CONTACTS_HANDLED | CONTACTS_ABANDONED | CONTACTS_CONSULTED | CONTACTS_AGENT_HUNG_UP_FIRST | CONTACTS_HANDLED_INCOMING | CONTACTS_HANDLED_OUTBOUND | CONTACTS_HOLD_ABANDONS | CONTACTS_TRANSFERRED_IN | CONTACTS_TRANSFERRED_OUT | CONTACTS_TRANSFERRED_IN_FROM_QUEUE | CONTACTS_TRANSFERRED_OUT_FROM_QUEUE | CONTACTS_MISSED | CALLBACK_CONTACTS_HANDLED | API_CONTACTS_HANDLED | OCCUPANCY | HANDLE_TIME | AFTER_CONTACT_WORK_TIME | QUEUED_TIME | ABANDON_TIME | QUEUE_ANSWER_TIME | HOLD_TIME | INTERACTION_TIME | INTERACTION_AND_HOLD_TIME | SERVICE_LEVEL,
      Statistic: SUM | MAX | AVG,
      Threshold: {
        Comparison: LT,
        ThresholdValue: 'NUMBER_VALUE'
      },
      Unit: SECONDS | COUNT | PERCENT
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Groupings: [
    QUEUE | CHANNEL,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.getMetricData(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • StartTime — (Date)

      The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

      The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

    • EndTime — (Date)

      The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

      The time range between the start and end time must be less than 24 hours.

    • Filters — (map)

      The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

      Note: To filter by Queues, enter the queue ID/ARN, not the name of the queue.
      • Queues — (Array<String>)

        The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.

      • Channels — (Array<String>)

        The channel to use to filter the metrics.

    • Groupings — (Array<String>)

      The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

    • HistoricalMetrics — (Array<map>)

      The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      Note: This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

      • Name — (String)

        The name of the metric.

        Possible values include:
        • "CONTACTS_QUEUED"
        • "CONTACTS_HANDLED"
        • "CONTACTS_ABANDONED"
        • "CONTACTS_CONSULTED"
        • "CONTACTS_AGENT_HUNG_UP_FIRST"
        • "CONTACTS_HANDLED_INCOMING"
        • "CONTACTS_HANDLED_OUTBOUND"
        • "CONTACTS_HOLD_ABANDONS"
        • "CONTACTS_TRANSFERRED_IN"
        • "CONTACTS_TRANSFERRED_OUT"
        • "CONTACTS_TRANSFERRED_IN_FROM_QUEUE"
        • "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"
        • "CONTACTS_MISSED"
        • "CALLBACK_CONTACTS_HANDLED"
        • "API_CONTACTS_HANDLED"
        • "OCCUPANCY"
        • "HANDLE_TIME"
        • "AFTER_CONTACT_WORK_TIME"
        • "QUEUED_TIME"
        • "ABANDON_TIME"
        • "QUEUE_ANSWER_TIME"
        • "HOLD_TIME"
        • "INTERACTION_TIME"
        • "INTERACTION_AND_HOLD_TIME"
        • "SERVICE_LEVEL"
      • Threshold — (map)

        The threshold for the metric, used with service level metrics.

        • Comparison — (String)

          The type of comparison. Only "less than" (LT) comparisons are supported.

          Possible values include:
          • "LT"
        • ThresholdValue — (Float)

          The threshold value to compare.

      • Statistic — (String)

        The statistic for the metric.

        Possible values include:
        • "SUM"
        • "MAX"
        • "AVG"
      • Unit — (String)

        The unit for the metric.

        Possible values include:
        • "SECONDS"
        • "COUNT"
        • "PERCENT"
    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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)

        If there are additional results, this is the token for the next set of results.

        The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

      • MetricResults — (Array<map>)

        Information about the historical metrics.

        If no grouping is specified, a summary of metric data is returned.

        • Dimensions — (map)

          The dimension for the metrics.

          • Queue — (map)

            Information about the queue for which metrics are returned.

            • Id — (String)

              The identifier of the queue.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the queue.

          • Channel — (String)

            The channel used for grouping and filters.

            Possible values include:
            • "VOICE"
            • "CHAT"
            • "TASK"
        • Collections — (Array<map>)

          The set of metrics.

          • Metric — (map)

            Information about the metric.

            • Name — (String)

              The name of the metric.

              Possible values include:
              • "CONTACTS_QUEUED"
              • "CONTACTS_HANDLED"
              • "CONTACTS_ABANDONED"
              • "CONTACTS_CONSULTED"
              • "CONTACTS_AGENT_HUNG_UP_FIRST"
              • "CONTACTS_HANDLED_INCOMING"
              • "CONTACTS_HANDLED_OUTBOUND"
              • "CONTACTS_HOLD_ABANDONS"
              • "CONTACTS_TRANSFERRED_IN"
              • "CONTACTS_TRANSFERRED_OUT"
              • "CONTACTS_TRANSFERRED_IN_FROM_QUEUE"
              • "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE"
              • "CONTACTS_MISSED"
              • "CALLBACK_CONTACTS_HANDLED"
              • "API_CONTACTS_HANDLED"
              • "OCCUPANCY"
              • "HANDLE_TIME"
              • "AFTER_CONTACT_WORK_TIME"
              • "QUEUED_TIME"
              • "ABANDON_TIME"
              • "QUEUE_ANSWER_TIME"
              • "HOLD_TIME"
              • "INTERACTION_TIME"
              • "INTERACTION_AND_HOLD_TIME"
              • "SERVICE_LEVEL"
            • Threshold — (map)

              The threshold for the metric, used with service level metrics.

              • Comparison — (String)

                The type of comparison. Only "less than" (LT) comparisons are supported.

                Possible values include:
                • "LT"
              • ThresholdValue — (Float)

                The threshold value to compare.

            • Statistic — (String)

              The statistic for the metric.

              Possible values include:
              • "SUM"
              • "MAX"
              • "AVG"
            • Unit — (String)

              The unit for the metric.

              Possible values include:
              • "SECONDS"
              • "COUNT"
              • "PERCENT"
          • Value — (Float)

            The value of the metric.

Returns:

  • (AWS.Request)

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

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

Gets details about a specific task template in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the getTaskTemplate operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TaskTemplateId: 'STRING_VALUE', /* required */
  SnapshotVersion: 'STRING_VALUE'
};
connect.getTaskTemplate(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • TaskTemplateId — (String)

      A unique identifier for the task template.

    • SnapshotVersion — (String)

      The system generated version of a task template that is associated with a task, when the task is created.

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:

      • InstanceId — (String)

        The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

      • Id — (String)

        A unique identifier for the task template.

      • Arn — (String)

        The Amazon Resource Name (ARN).

      • Name — (String)

        The name of the task template.

      • Description — (String)

        The description of the task template.

      • ContactFlowId — (String)

        The identifier of the flow that runs by default when a task is created by referencing this template.

      • Constraints — (map)

        Constraints that are applicable to the fields listed.

        • RequiredFields — (Array<map>)

          Lists the fields that are required to be filled by agents.

          • Id — (map)

            The unique identifier for the field.

            • Name — (String)

              The name of the task template field.

        • ReadOnlyFields — (Array<map>)

          Lists the fields that are read-only to agents, and cannot be edited.

          • Id — (map)

            Identifier of the read-only field.

            • Name — (String)

              The name of the task template field.

        • InvisibleFields — (Array<map>)

          Lists the fields that are invisible to agents.

          • Id — (map)

            Identifier of the invisible field.

            • Name — (String)

              The name of the task template field.

      • Defaults — (map)

        The default values for fields when a task is created by referencing this template.

        • DefaultFieldValues — (Array<map>)

          Default value for the field.

          • Id — (map)

            Identifier of a field.

            • Name — (String)

              The name of the task template field.

          • DefaultValue — (String)

            Default value for the field.

      • Fields — (Array<map>)

        Fields that are part of the template.

        • Idrequired — (map)

          The unique identifier for the field.

          • Name — (String)

            The name of the task template field.

        • Description — (String)

          The description of the field.

        • Type — (String)

          Indicates the type of field.

          Possible values include:
          • "NAME"
          • "DESCRIPTION"
          • "SCHEDULED_TIME"
          • "QUICK_CONNECT"
          • "URL"
          • "NUMBER"
          • "TEXT"
          • "TEXT_AREA"
          • "DATE_TIME"
          • "BOOLEAN"
          • "SINGLE_SELECT"
          • "EMAIL"
        • SingleSelectOptions — (Array<String>)

          A list of options for a single select field.

      • Status — (String)

        Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • LastModifiedTime — (Date)

        The timestamp when the task template was last modified.

      • CreatedTime — (Date)

        The timestamp when the task template was created.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

Returns:

  • (AWS.Request)

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

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

Retrieves the current traffic distribution for a given traffic distribution group.

Service Reference:

Examples:

Calling the getTrafficDistribution operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
connect.getTrafficDistribution(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)

      The identifier of the traffic distribution group.

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:

      • TelephonyConfig — (map)

        The distribution of traffic between the instance and its replicas.

        • Distributionsrequired — (Array<map>)

          Information about traffic distributions.

          • Regionrequired — (String)

            The Amazon Web Services Region where the traffic is distributed.

          • Percentagerequired — (Integer)

            The percentage of the traffic that is distributed, in increments of 10.

      • Id — (String)

        The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the traffic distribution group.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Lists agent statuses.

Service Reference:

Examples:

Calling the listAgentStatuses operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  AgentStatusTypes: [
    ROUTABLE | CUSTOM | OFFLINE,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listAgentStatuses(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • AgentStatusTypes — (Array<String>)

      Available agent status types.

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)

        If there are additional results, this is the token for the next set of results.

      • AgentStatusSummaryList — (Array<map>)

        A summary of agent statuses.

        • Id — (String)

          The identifier for an agent status.

        • Arn — (String)

          The Amazon Resource Name (ARN) for the agent status.

        • Name — (String)

          The name of the agent status.

        • Type — (String)

          The type of the agent status.

          Possible values include:
          • "ROUTABLE"
          • "CUSTOM"
          • "OFFLINE"

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

Service Reference:

Examples:

Calling the listApprovedOrigins operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listApprovedOrigins(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • Origins — (Array<String>)

        The approved origins.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

Service Reference:

Examples:

Calling the listBots operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexVersion: V1 | V2, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listBots(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • LexVersion — (String)

      The version of Amazon Lex or Amazon Lex V2.

      Possible values include:
      • "V1"
      • "V2"

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:

      • LexBots — (Array<map>)

        The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.

        • LexBot — (map)

          Configuration information of an Amazon Lex bot.

          • Name — (String)

            The name of the Amazon Lex bot.

          • LexRegion — (String)

            The Amazon Web Services Region where the Amazon Lex bot was created.

        • LexV2Bot — (map)

          Configuration information of an Amazon Lex V2 bot.

          • AliasArn — (String)

            The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides information about the flow modules for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listContactFlowModules operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ContactFlowModuleState: ACTIVE | ARCHIVED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listContactFlowModules(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • ContactFlowModuleState — (String)

      The state of the flow module.

      Possible values include:
      • "ACTIVE"
      • "ARCHIVED"

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:

      • ContactFlowModulesSummaryList — (Array<map>)

        Information about the flow module.

        • Id — (String)

          The identifier of the flow module.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the flow module.

        • Name — (String)

          The name of the flow module.

        • State — (String)

          The type of flow module.

          Possible values include:
          • "ACTIVE"
          • "ARCHIVED"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides information about the flows for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

For more information about flows, see Flows in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listContactFlows operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ContactFlowTypes: [
    CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listContactFlows(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowTypes — (Array<String>)

      The type of flow.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • ContactFlowSummaryList — (Array<map>)

        Information about the flows.

        • Id — (String)

          The identifier of the flow.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the flow.

        • Name — (String)

          The name of the flow.

        • ContactFlowType — (String)

          The type of flow.

          Possible values include:
          • "CONTACT_FLOW"
          • "CUSTOMER_QUEUE"
          • "CUSTOMER_HOLD"
          • "CUSTOMER_WHISPER"
          • "AGENT_HOLD"
          • "AGENT_WHISPER"
          • "OUTBOUND_WHISPER"
          • "AGENT_TRANSFER"
          • "QUEUE_TRANSFER"
        • ContactFlowState — (String)

          The type of flow.

          Possible values include:
          • "ACTIVE"
          • "ARCHIVED"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

For the specified referenceTypes, returns a list of references associated with the contact.

Service Reference:

Examples:

Calling the listContactReferences operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ReferenceTypes: [ /* required */
    URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL,
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
connect.listContactReferences(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the initial contact.

    • ReferenceTypes — (Array<String>)

      The type of reference.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      This is not expected to be set, because the value returned in the previous response is always null.

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:

      • ReferenceSummaryList — (Array<map>)

        Information about the flows.

        • Url — (map)

          Information about the reference when the referenceType is URL. Otherwise, null.

          • Name — (String)

            Identifier of the URL reference.

          • Value — (String)

            A valid URL.

        • Attachment — (map)

          Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.

          • Name — (String)

            Identifier of the attachment reference.

          • Value — (String)

            The location path of the attachment reference.

          • Status — (String)

            Status of the attachment reference type.

            Possible values include:
            • "APPROVED"
            • "REJECTED"
        • String — (map)

          Information about a reference when the referenceType is STRING. Otherwise, null.

          • Name — (String)

            Identifier of the string reference.

          • Value — (String)

            A valid string.

        • Number — (map)

          Information about a reference when the referenceType is NUMBER. Otherwise, null.

          • Name — (String)

            Identifier of the number reference.

          • Value — (String)

            A valid number.

        • Date — (map)

          Information about a reference when the referenceType is DATE. Otherwise, null.

          • Name — (String)

            Identifier of the date reference.

          • Value — (String)

            A valid date.

        • Email — (map)

          Information about a reference when the referenceType is EMAIL. Otherwise, null.

          • Name — (String)

            Identifier of the email reference.

          • Value — (String)

            A valid email address.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

        This is always returned as null in the response.

Returns:

  • (AWS.Request)

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

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

Lists the default vocabularies for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listDefaultVocabularies operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LanguageCode: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listDefaultVocabularies(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • LanguageCode — (String)

      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

      Possible values include:
      • "ar-AE"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fr-CA"
      • "fr-FR"
      • "hi-IN"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "pt-BR"
      • "pt-PT"
      • "zh-CN"
    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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:

      • DefaultVocabularyList — (Array<map>)

        A list of default vocabularies.

        • InstanceIdrequired — (String)

          The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • LanguageCoderequired — (String)

          The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

          Possible values include:
          • "ar-AE"
          • "de-CH"
          • "de-DE"
          • "en-AB"
          • "en-AU"
          • "en-GB"
          • "en-IE"
          • "en-IN"
          • "en-US"
          • "en-WL"
          • "es-ES"
          • "es-US"
          • "fr-CA"
          • "fr-FR"
          • "hi-IN"
          • "it-IT"
          • "ja-JP"
          • "ko-KR"
          • "pt-BR"
          • "pt-PT"
          • "zh-CN"
        • VocabularyIdrequired — (String)

          The identifier of the custom vocabulary.

        • VocabularyNamerequired — (String)

          A unique name of the custom vocabulary.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listHoursOfOperations operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listHoursOfOperations(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • HoursOfOperationSummaryList — (Array<map>)

        Information about the hours of operation.

        • Id — (String)

          The identifier of the hours of operation.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the hours of operation.

        • Name — (String)

          The name of the hours of operation.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all attribute types for the given instance.

Service Reference:

Examples:

Calling the listInstanceAttributes operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listInstanceAttributes(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • Attributes — (Array<map>)

        The attribute types.

        • AttributeType — (String)

          The type of attribute.

          Possible values include:
          • "INBOUND_CALLS"
          • "OUTBOUND_CALLS"
          • "CONTACTFLOW_LOGS"
          • "CONTACT_LENS"
          • "AUTO_RESOLVE_BEST_VOICES"
          • "USE_CUSTOM_TTS_VOICES"
          • "EARLY_MEDIA"
          • "MULTI_PARTY_CONFERENCE"
          • "HIGH_VOLUME_OUTBOUND"
          • "ENHANCED_CONTACT_MONITORING"
        • Value — (String)

          The value of the attribute.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

Service Reference:

Examples:

Calling the listInstances operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listInstances(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: {})
    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • InstanceSummaryList — (Array<map>)

        Information about the instances.

        • Id — (String)

          The identifier of the instance.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the instance.

        • IdentityManagementType — (String)

          The identity management type of the instance.

          Possible values include:
          • "SAML"
          • "CONNECT_MANAGED"
          • "EXISTING_DIRECTORY"
        • InstanceAlias — (String)

          The alias of the instance.

        • CreatedTime — (Date)

          When the instance was created.

        • ServiceRole — (String)

          The service role of the instance.

        • InstanceStatus — (String)

          The state of the instance.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "ACTIVE"
          • "CREATION_FAILED"
        • InboundCallsEnabled — (Boolean)

          Whether inbound calls are enabled.

        • OutboundCallsEnabled — (Boolean)

          Whether outbound calls are enabled.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of storage configs for the identified instance and resource type.

Service Reference:

Examples:

Calling the listInstanceStorageConfigs operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listInstanceStorageConfigs(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "CHAT_TRANSCRIPTS"
      • "CALL_RECORDINGS"
      • "SCHEDULED_REPORTS"
      • "MEDIA_STREAMS"
      • "CONTACT_TRACE_RECORDS"
      • "AGENT_EVENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"
    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • StorageConfigs — (Array<map>)

        A valid storage type.

        • AssociationId — (String)

          The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

        • StorageTyperequired — (String)

          A valid storage type.

          Possible values include:
          • "S3"
          • "KINESIS_VIDEO_STREAM"
          • "KINESIS_STREAM"
          • "KINESIS_FIREHOSE"
        • S3Config — (map)

          The S3 bucket configuration.

          • BucketNamerequired — (String)

            The S3 bucket name.

          • BucketPrefixrequired — (String)

            The S3 bucket prefix.

          • EncryptionConfig — (map)

            The Amazon S3 encryption configuration.

            • EncryptionTyperequired — (String)

              The type of encryption.

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

              The full ARN of the encryption key.

              Note: Be sure to provide the full ARN of the encryption key, not just the ID.
        • KinesisVideoStreamConfig — (map)

          The configuration of the Kinesis video stream.

          • Prefixrequired — (String)

            The prefix of the video stream.

          • RetentionPeriodHoursrequired — (Integer)

            The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

            The default value is 0, indicating that the stream does not persist data.

          • EncryptionConfigrequired — (map)

            The encryption configuration.

            • EncryptionTyperequired — (String)

              The type of encryption.

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

              The full ARN of the encryption key.

              Note: Be sure to provide the full ARN of the encryption key, not just the ID.
        • KinesisStreamConfig — (map)

          The configuration of the Kinesis data stream.

          • StreamArnrequired — (String)

            The Amazon Resource Name (ARN) of the data stream.

        • KinesisFirehoseConfig — (map)

          The configuration of the Kinesis Firehose delivery stream.

          • FirehoseArnrequired — (String)

            The Amazon Resource Name (ARN) of the delivery stream.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listIntegrationAssociations operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationType: EVENT | VOICE_ID | PINPOINT_APP | WISDOM_ASSISTANT | WISDOM_KNOWLEDGE_BASE | CASES_DOMAIN,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listIntegrationAssociations(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • IntegrationType — (String)

      The integration type.

      Possible values include:
      • "EVENT"
      • "VOICE_ID"
      • "PINPOINT_APP"
      • "WISDOM_ASSISTANT"
      • "WISDOM_KNOWLEDGE_BASE"
      • "CASES_DOMAIN"
    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • IntegrationAssociationSummaryList — (Array<map>)

        The associations.

        • IntegrationAssociationId — (String)

          The identifier for the AppIntegration association.

        • IntegrationAssociationArn — (String)

          The Amazon Resource Name (ARN) for the AppIntegration association.

        • InstanceId — (String)

          The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • IntegrationType — (String)

          The integration type.

          Possible values include:
          • "EVENT"
          • "VOICE_ID"
          • "PINPOINT_APP"
          • "WISDOM_ASSISTANT"
          • "WISDOM_KNOWLEDGE_BASE"
          • "CASES_DOMAIN"
        • IntegrationArn — (String)

          The Amazon Resource Name (ARN) for the AppIntegration.

        • SourceApplicationUrl — (String)

          The URL for the external application.

        • SourceApplicationName — (String)

          The user-provided, friendly name for the external application.

        • SourceType — (String)

          The name of the source.

          Possible values include:
          • "SALESFORCE"
          • "ZENDESK"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

Service Reference:

Examples:

Calling the listLambdaFunctions operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listLambdaFunctions(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • LambdaFunctions — (Array<String>)

        The Lambdafunction ARNs associated with the specified instance.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

Service Reference:

Examples:

Calling the listLexBots operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listLexBots(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. If no value is specified, the default is 10.

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:

      • LexBots — (Array<map>)

        The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified instance.

        • Name — (String)

          The name of the Amazon Lex bot.

        • LexRegion — (String)

          The Amazon Web Services Region where the Amazon Lex bot was created.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

Service Reference:

Examples:

Calling the listPhoneNumbers operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PhoneNumberCountryCodes: [
    AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ | DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW | GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA | AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW,
    /* more items */
  ],
  PhoneNumberTypes: [
    TOLL_FREE | DID,
    /* more items */
  ]
};
connect.listPhoneNumbers(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • PhoneNumberTypes — (Array<String>)

      The type of phone number.

    • PhoneNumberCountryCodes — (Array<String>)

      The ISO country code.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • PhoneNumberSummaryList — (Array<map>)

        Information about the phone numbers.

        • Id — (String)

          The identifier of the phone number.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the phone number.

        • PhoneNumber — (String)

          The phone number.

        • PhoneNumberType — (String)

          The type of phone number.

          Possible values include:
          • "TOLL_FREE"
          • "DID"
        • PhoneNumberCountryCode — (String)

          The ISO country code.

          Possible values include:
          • "AF"
          • "AL"
          • "DZ"
          • "AS"
          • "AD"
          • "AO"
          • "AI"
          • "AQ"
          • "AG"
          • "AR"
          • "AM"
          • "AW"
          • "AU"
          • "AT"
          • "AZ"
          • "BS"
          • "BH"
          • "BD"
          • "BB"
          • "BY"
          • "BE"
          • "BZ"
          • "BJ"
          • "BM"
          • "BT"
          • "BO"
          • "BA"
          • "BW"
          • "BR"
          • "IO"
          • "VG"
          • "BN"
          • "BG"
          • "BF"
          • "BI"
          • "KH"
          • "CM"
          • "CA"
          • "CV"
          • "KY"
          • "CF"
          • "TD"
          • "CL"
          • "CN"
          • "CX"
          • "CC"
          • "CO"
          • "KM"
          • "CK"
          • "CR"
          • "HR"
          • "CU"
          • "CW"
          • "CY"
          • "CZ"
          • "CD"
          • "DK"
          • "DJ"
          • "DM"
          • "DO"
          • "TL"
          • "EC"
          • "EG"
          • "SV"
          • "GQ"
          • "ER"
          • "EE"
          • "ET"
          • "FK"
          • "FO"
          • "FJ"
          • "FI"
          • "FR"
          • "PF"
          • "GA"
          • "GM"
          • "GE"
          • "DE"
          • "GH"
          • "GI"
          • "GR"
          • "GL"
          • "GD"
          • "GU"
          • "GT"
          • "GG"
          • "GN"
          • "GW"
          • "GY"
          • "HT"
          • "HN"
          • "HK"
          • "HU"
          • "IS"
          • "IN"
          • "ID"
          • "IR"
          • "IQ"
          • "IE"
          • "IM"
          • "IL"
          • "IT"
          • "CI"
          • "JM"
          • "JP"
          • "JE"
          • "JO"
          • "KZ"
          • "KE"
          • "KI"
          • "KW"
          • "KG"
          • "LA"
          • "LV"
          • "LB"
          • "LS"
          • "LR"
          • "LY"
          • "LI"
          • "LT"
          • "LU"
          • "MO"
          • "MK"
          • "MG"
          • "MW"
          • "MY"
          • "MV"
          • "ML"
          • "MT"
          • "MH"
          • "MR"
          • "MU"
          • "YT"
          • "MX"
          • "FM"
          • "MD"
          • "MC"
          • "MN"
          • "ME"
          • "MS"
          • "MA"
          • "MZ"
          • "MM"
          • "NA"
          • "NR"
          • "NP"
          • "NL"
          • "AN"
          • "NC"
          • "NZ"
          • "NI"
          • "NE"
          • "NG"
          • "NU"
          • "KP"
          • "MP"
          • "NO"
          • "OM"
          • "PK"
          • "PW"
          • "PA"
          • "PG"
          • "PY"
          • "PE"
          • "PH"
          • "PN"
          • "PL"
          • "PT"
          • "PR"
          • "QA"
          • "CG"
          • "RE"
          • "RO"
          • "RU"
          • "RW"
          • "BL"
          • "SH"
          • "KN"
          • "LC"
          • "MF"
          • "PM"
          • "VC"
          • "WS"
          • "SM"
          • "ST"
          • "SA"
          • "SN"
          • "RS"
          • "SC"
          • "SL"
          • "SG"
          • "SX"
          • "SK"
          • "SI"
          • "SB"
          • "SO"
          • "ZA"
          • "KR"
          • "ES"
          • "LK"
          • "SD"
          • "SR"
          • "SJ"
          • "SZ"
          • "SE"
          • "CH"
          • "SY"
          • "TW"
          • "TJ"
          • "TZ"
          • "TH"
          • "TG"
          • "TK"
          • "TO"
          • "TT"
          • "TN"
          • "TR"
          • "TM"
          • "TC"
          • "TV"
          • "VI"
          • "UG"
          • "UA"
          • "AE"
          • "GB"
          • "US"
          • "UY"
          • "UZ"
          • "VU"
          • "VA"
          • "VE"
          • "VN"
          • "WF"
          • "EH"
          • "YE"
          • "ZM"
          • "ZW"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listPhoneNumbersV2 operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PhoneNumberCountryCodes: [
    AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ | DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW | GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA | AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW,
    /* more items */
  ],
  PhoneNumberPrefix: 'STRING_VALUE',
  PhoneNumberTypes: [
    TOLL_FREE | DID,
    /* more items */
  ],
  TargetArn: 'STRING_VALUE'
};
connect.listPhoneNumbersV2(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: {})
    • TargetArn — (String)

      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • PhoneNumberCountryCodes — (Array<String>)

      The ISO country code.

    • PhoneNumberTypes — (Array<String>)

      The type of phone number.

    • PhoneNumberPrefix — (String)

      The prefix of the phone number. If provided, it must contain + as part of the country code.

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)

        If there are additional results, this is the token for the next set of results.

      • ListPhoneNumbersSummaryList — (Array<map>)

        Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.

        • PhoneNumberId — (String)

          A unique identifier for the phone number.

        • PhoneNumberArn — (String)

          The Amazon Resource Name (ARN) of the phone number.

        • PhoneNumber — (String)

          The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

        • PhoneNumberCountryCode — (String)

          The ISO country code.

          Possible values include:
          • "AF"
          • "AL"
          • "DZ"
          • "AS"
          • "AD"
          • "AO"
          • "AI"
          • "AQ"
          • "AG"
          • "AR"
          • "AM"
          • "AW"
          • "AU"
          • "AT"
          • "AZ"
          • "BS"
          • "BH"
          • "BD"
          • "BB"
          • "BY"
          • "BE"
          • "BZ"
          • "BJ"
          • "BM"
          • "BT"
          • "BO"
          • "BA"
          • "BW"
          • "BR"
          • "IO"
          • "VG"
          • "BN"
          • "BG"
          • "BF"
          • "BI"
          • "KH"
          • "CM"
          • "CA"
          • "CV"
          • "KY"
          • "CF"
          • "TD"
          • "CL"
          • "CN"
          • "CX"
          • "CC"
          • "CO"
          • "KM"
          • "CK"
          • "CR"
          • "HR"
          • "CU"
          • "CW"
          • "CY"
          • "CZ"
          • "CD"
          • "DK"
          • "DJ"
          • "DM"
          • "DO"
          • "TL"
          • "EC"
          • "EG"
          • "SV"
          • "GQ"
          • "ER"
          • "EE"
          • "ET"
          • "FK"
          • "FO"
          • "FJ"
          • "FI"
          • "FR"
          • "PF"
          • "GA"
          • "GM"
          • "GE"
          • "DE"
          • "GH"
          • "GI"
          • "GR"
          • "GL"
          • "GD"
          • "GU"
          • "GT"
          • "GG"
          • "GN"
          • "GW"
          • "GY"
          • "HT"
          • "HN"
          • "HK"
          • "HU"
          • "IS"
          • "IN"
          • "ID"
          • "IR"
          • "IQ"
          • "IE"
          • "IM"
          • "IL"
          • "IT"
          • "CI"
          • "JM"
          • "JP"
          • "JE"
          • "JO"
          • "KZ"
          • "KE"
          • "KI"
          • "KW"
          • "KG"
          • "LA"
          • "LV"
          • "LB"
          • "LS"
          • "LR"
          • "LY"
          • "LI"
          • "LT"
          • "LU"
          • "MO"
          • "MK"
          • "MG"
          • "MW"
          • "MY"
          • "MV"
          • "ML"
          • "MT"
          • "MH"
          • "MR"
          • "MU"
          • "YT"
          • "MX"
          • "FM"
          • "MD"
          • "MC"
          • "MN"
          • "ME"
          • "MS"
          • "MA"
          • "MZ"
          • "MM"
          • "NA"
          • "NR"
          • "NP"
          • "NL"
          • "AN"
          • "NC"
          • "NZ"
          • "NI"
          • "NE"
          • "NG"
          • "NU"
          • "KP"
          • "MP"
          • "NO"
          • "OM"
          • "PK"
          • "PW"
          • "PA"
          • "PG"
          • "PY"
          • "PE"
          • "PH"
          • "PN"
          • "PL"
          • "PT"
          • "PR"
          • "QA"
          • "CG"
          • "RE"
          • "RO"
          • "RU"
          • "RW"
          • "BL"
          • "SH"
          • "KN"
          • "LC"
          • "MF"
          • "PM"
          • "VC"
          • "WS"
          • "SM"
          • "ST"
          • "SA"
          • "SN"
          • "RS"
          • "SC"
          • "SL"
          • "SG"
          • "SX"
          • "SK"
          • "SI"
          • "SB"
          • "SO"
          • "ZA"
          • "KR"
          • "ES"
          • "LK"
          • "SD"
          • "SR"
          • "SJ"
          • "SZ"
          • "SE"
          • "CH"
          • "SY"
          • "TW"
          • "TJ"
          • "TZ"
          • "TH"
          • "TG"
          • "TK"
          • "TO"
          • "TT"
          • "TN"
          • "TR"
          • "TM"
          • "TC"
          • "TV"
          • "VI"
          • "UG"
          • "UA"
          • "AE"
          • "GB"
          • "US"
          • "UY"
          • "UZ"
          • "VU"
          • "VA"
          • "VE"
          • "VN"
          • "WF"
          • "EH"
          • "YE"
          • "ZM"
          • "ZW"
        • PhoneNumberType — (String)

          The type of phone number.

          Possible values include:
          • "TOLL_FREE"
          • "DID"
        • TargetArn — (String)

          The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

Returns:

  • (AWS.Request)

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

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

Provides information about the prompts for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listPrompts operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listPrompts(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • PromptSummaryList — (Array<map>)

        Information about the prompts.

        • Id — (String)

          The identifier of the prompt.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the prompt.

        • Name — (String)

          The name of the prompt.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Lists the quick connects associated with a queue.

Service Reference:

Examples:

Calling the listQueueQuickConnects operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listQueueQuickConnects(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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)

        If there are additional results, this is the token for the next set of results.

      • QuickConnectSummaryList — (Array<map>)

        Information about the quick connects.

        • Id — (String)

          The identifier for the quick connect.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the quick connect.

        • Name — (String)

          The name of the quick connect.

        • QuickConnectType — (String)

          The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

          Possible values include:
          • "USER"
          • "QUEUE"
          • "PHONE_NUMBER"

Returns:

  • (AWS.Request)

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

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

Provides information about the queues for the specified Amazon Connect instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listQueues operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QueueTypes: [
    STANDARD | AGENT,
    /* more items */
  ]
};
connect.listQueues(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • QueueTypes — (Array<String>)

      The type of queue.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • QueueSummaryList — (Array<map>)

        Information about the queues.

        • Id — (String)

          The identifier of the queue.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the queue.

        • Name — (String)

          The name of the queue.

        • QueueType — (String)

          The type of queue.

          Possible values include:
          • "STANDARD"
          • "AGENT"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides information about the quick connects for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listQuickConnects operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QuickConnectTypes: [
    USER | QUEUE | PHONE_NUMBER,
    /* more items */
  ]
};
connect.listQuickConnects(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

    • QuickConnectTypes — (Array<String>)

      The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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:

      • QuickConnectSummaryList — (Array<map>)

        Information about the quick connects.

        • Id — (String)

          The identifier for the quick connect.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the quick connect.

        • Name — (String)

          The name of the quick connect.

        • QuickConnectType — (String)

          The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

          Possible values include:
          • "USER"
          • "QUEUE"
          • "PHONE_NUMBER"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Lists the queues associated with a routing profile.

Service Reference:

Examples:

Calling the listRoutingProfileQueues operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  RoutingProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listRoutingProfileQueues(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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)

        If there are additional results, this is the token for the next set of results.

      • RoutingProfileQueueConfigSummaryList — (Array<map>)

        Information about the routing profiles.

        • QueueIdrequired — (String)

          The identifier for the queue.

        • QueueArnrequired — (String)

          The Amazon Resource Name (ARN) of the queue.

        • QueueNamerequired — (String)

          The name of the queue.

        • Priorityrequired — (Integer)

          The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

        • Delayrequired — (Integer)

          The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

        • Channelrequired — (String)

          The channels this queue supports.

          Possible values include:
          • "VOICE"
          • "CHAT"
          • "TASK"

Returns:

  • (AWS.Request)

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

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

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listRoutingProfiles operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listRoutingProfiles(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • RoutingProfileSummaryList — (Array<map>)

        Information about the routing profiles.

        • Id — (String)

          The identifier of the routing profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the routing profile.

        • Name — (String)

          The name of the routing profile.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all security keys associated with the instance.

Service Reference:

Examples:

Calling the listSecurityKeys operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listSecurityKeys(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • SecurityKeys — (Array<map>)

        The security keys.

        • AssociationId — (String)

          The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

        • Key — (String)

          The key of the security key.

        • CreationTime — (Date)

          When the security key was created.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Lists the permissions granted to a security profile.

Service Reference:

Examples:

Calling the listSecurityProfilePermissions operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listSecurityProfilePermissions(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: {})
    • SecurityProfileId — (String)

      The identifier for the security profle.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • Permissions — (Array<String>)

        The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listSecurityProfiles operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listSecurityProfiles(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • SecurityProfileSummaryList — (Array<map>)

        Information about the security profiles.

        • Id — (String)

          The identifier of the security profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the security profile.

        • Name — (String)

          The name of the security profile.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
connect.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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

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

        Information about the tags.

Returns:

  • (AWS.Request)

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

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

Lists task templates for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listTaskTemplates operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: ACTIVE | INACTIVE
};
connect.listTaskTemplates(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      It is not expected that you set this because the value returned in the previous response is always null.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

      It is not expected that you set this.

    • Status — (String)

      Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

      Possible values include:
      • "ACTIVE"
      • "INACTIVE"
    • Name — (String)

      The name of the task template.

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:

      • TaskTemplates — (Array<map>)

        Provides details about a list of task templates belonging to an instance.

        • Id — (String)

          A unique identifier for the task template.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the task template.

        • Name — (String)

          The name of the task template.

        • Description — (String)

          The description of the task template.

        • Status — (String)

          Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • LastModifiedTime — (Date)

          The timestamp when the task template was last modified.

        • CreatedTime — (Date)

          The timestamp when the task template was created.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

        This is always returned as a null in the response.

Returns:

  • (AWS.Request)

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

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

Lists traffic distribution groups.

Service Reference:

Examples:

Calling the listTrafficDistributionGroups operation

var params = {
  InstanceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listTrafficDistributionGroups(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. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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)

        If there are additional results, this is the token for the next set of results.

      • TrafficDistributionGroupSummaryList — (Array<map>)

        A list of traffic distribution groups.

        • Id — (String)

          The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the traffic distribution group.

        • Name — (String)

          The name of the traffic distribution group.

        • InstanceArn — (String)

          The Amazon Resource Name (ARN) of the traffic distribution group.

        • Status — (String)

          The status of the traffic distribution group.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "ACTIVE"
          • "CREATION_FAILED"
          • "PENDING_DELETION"
          • "DELETION_FAILED"
          • "UPDATE_IN_PROGRESS"

Returns:

  • (AWS.Request)

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

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

Lists the use cases for the integration association.

Service Reference:

Examples:

Calling the listUseCases operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  IntegrationAssociationId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listUseCases(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • IntegrationAssociationId — (String)

      The identifier for the integration association.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

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:

      • UseCaseSummaryList — (Array<map>)

        The use cases.

        • UseCaseId — (String)

          The identifier for the use case.

        • UseCaseArn — (String)

          The Amazon Resource Name (ARN) for the use case.

        • UseCaseType — (String)

          The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

          Possible values include:
          • "RULES_EVALUATION"
          • "CONNECT_CAMPAIGNS"
      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the listUserHierarchyGroups operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listUserHierarchyGroups(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • UserHierarchyGroupSummaryList — (Array<map>)

        Information about the hierarchy groups.

        • Id — (String)

          The identifier of the hierarchy group.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the hierarchy group.

        • Name — (String)

          The name of the hierarchy group.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Provides summary information about the users for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listUsers operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listUsers(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page. The default MaxResult size is 100.

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:

      • UserSummaryList — (Array<map>)

        Information about the users.

        • Id — (String)

          The identifier of the user account.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the user account.

        • Username — (String)

          The Amazon Connect user name of the user account.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

Service Reference:

Examples:

Calling the monitorContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  AllowedMonitorCapabilities: [
    SILENT_MONITOR | BARGE,
    /* more items */
  ],
  ClientToken: 'STRING_VALUE'
};
connect.monitorContact(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

    • UserId — (String)

      The identifier of the user account.

    • AllowedMonitorCapabilities — (Array<String>)

      Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • ContactId — (String)

        The identifier of the contact.

      • ContactArn — (String)

        The ARN of the contact.

Returns:

  • (AWS.Request)

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

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

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the putUserStatus operation

var params = {
  AgentStatusId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.putUserStatus(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: {})
    • UserId — (String)

      The identifier of the user.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AgentStatusId — (String)

      The identifier of the agent status.

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.

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

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect console.

After releasing a phone number, the phone number enters into a cooldown period of 30 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

Service Reference:

Examples:

Calling the releasePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.releasePhoneNumber(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: {})
    • PhoneNumberId — (String)

      A unique identifier for the phone number.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the replicateInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ReplicaAlias: 'STRING_VALUE', /* required */
  ReplicaRegion: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.replicateInstance(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.

    • ReplicaRegion — (String)

      The Amazon Web Services Region where to replicate the Amazon Connect instance.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ReplicaAlias — (String)

      The alias for the replicated instance. The ReplicaAlias must be unique.

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)

        The identifier of the replicated instance. You can find the instanceId in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the replicated instance.

Returns:

  • (AWS.Request)

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

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

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.

Service Reference:

Examples:

Calling the resumeContactRecording operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.resumeContactRecording(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

    • InitialContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

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.

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

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

Service Reference:

Examples:

Calling the searchAvailablePhoneNumbers operation

var params = {
  PhoneNumberCountryCode: AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ | DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW | GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA | AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW, /* required */
  PhoneNumberType: TOLL_FREE | DID, /* required */
  TargetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PhoneNumberPrefix: 'STRING_VALUE'
};
connect.searchAvailablePhoneNumbers(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: {})
    • TargetArn — (String)

      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

    • PhoneNumberCountryCode — (String)

      The ISO country code.

      Possible values include:
      • "AF"
      • "AL"
      • "DZ"
      • "AS"
      • "AD"
      • "AO"
      • "AI"
      • "AQ"
      • "AG"
      • "AR"
      • "AM"
      • "AW"
      • "AU"
      • "AT"
      • "AZ"
      • "BS"
      • "BH"
      • "BD"
      • "BB"
      • "BY"
      • "BE"
      • "BZ"
      • "BJ"
      • "BM"
      • "BT"
      • "BO"
      • "BA"
      • "BW"
      • "BR"
      • "IO"
      • "VG"
      • "BN"
      • "BG"
      • "BF"
      • "BI"
      • "KH"
      • "CM"
      • "CA"
      • "CV"
      • "KY"
      • "CF"
      • "TD"
      • "CL"
      • "CN"
      • "CX"
      • "CC"
      • "CO"
      • "KM"
      • "CK"
      • "CR"
      • "HR"
      • "CU"
      • "CW"
      • "CY"
      • "CZ"
      • "CD"
      • "DK"
      • "DJ"
      • "DM"
      • "DO"
      • "TL"
      • "EC"
      • "EG"
      • "SV"
      • "GQ"
      • "ER"
      • "EE"
      • "ET"
      • "FK"
      • "FO"
      • "FJ"
      • "FI"
      • "FR"
      • "PF"
      • "GA"
      • "GM"
      • "GE"
      • "DE"
      • "GH"
      • "GI"
      • "GR"
      • "GL"
      • "GD"
      • "GU"
      • "GT"
      • "GG"
      • "GN"
      • "GW"
      • "GY"
      • "HT"
      • "HN"
      • "HK"
      • "HU"
      • "IS"
      • "IN"
      • "ID"
      • "IR"
      • "IQ"
      • "IE"
      • "IM"
      • "IL"
      • "IT"
      • "CI"
      • "JM"
      • "JP"
      • "JE"
      • "JO"
      • "KZ"
      • "KE"
      • "KI"
      • "KW"
      • "KG"
      • "LA"
      • "LV"
      • "LB"
      • "LS"
      • "LR"
      • "LY"
      • "LI"
      • "LT"
      • "LU"
      • "MO"
      • "MK"
      • "MG"
      • "MW"
      • "MY"
      • "MV"
      • "ML"
      • "MT"
      • "MH"
      • "MR"
      • "MU"
      • "YT"
      • "MX"
      • "FM"
      • "MD"
      • "MC"
      • "MN"
      • "ME"
      • "MS"
      • "MA"
      • "MZ"
      • "MM"
      • "NA"
      • "NR"
      • "NP"
      • "NL"
      • "AN"
      • "NC"
      • "NZ"
      • "NI"
      • "NE"
      • "NG"
      • "NU"
      • "KP"
      • "MP"
      • "NO"
      • "OM"
      • "PK"
      • "PW"
      • "PA"
      • "PG"
      • "PY"
      • "PE"
      • "PH"
      • "PN"
      • "PL"
      • "PT"
      • "PR"
      • "QA"
      • "CG"
      • "RE"
      • "RO"
      • "RU"
      • "RW"
      • "BL"
      • "SH"
      • "KN"
      • "LC"
      • "MF"
      • "PM"
      • "VC"
      • "WS"
      • "SM"
      • "ST"
      • "SA"
      • "SN"
      • "RS"
      • "SC"
      • "SL"
      • "SG"
      • "SX"
      • "SK"
      • "SI"
      • "SB"
      • "SO"
      • "ZA"
      • "KR"
      • "ES"
      • "LK"
      • "SD"
      • "SR"
      • "SJ"
      • "SZ"
      • "SE"
      • "CH"
      • "SY"
      • "TW"
      • "TJ"
      • "TZ"
      • "TH"
      • "TG"
      • "TK"
      • "TO"
      • "TT"
      • "TN"
      • "TR"
      • "TM"
      • "TC"
      • "TV"
      • "VI"
      • "UG"
      • "UA"
      • "AE"
      • "GB"
      • "US"
      • "UY"
      • "UZ"
      • "VU"
      • "VA"
      • "VE"
      • "VN"
      • "WF"
      • "EH"
      • "YE"
      • "ZM"
      • "ZW"
    • PhoneNumberType — (String)

      The type of phone number.

      Possible values include:
      • "TOLL_FREE"
      • "DID"
    • PhoneNumberPrefix — (String)

      The prefix of the phone number. If provided, it must contain + as part of the country code.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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)

        If there are additional results, this is the token for the next set of results.

      • AvailableNumbersList — (Array<map>)

        A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

        • PhoneNumber — (String)

          The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

        • PhoneNumberCountryCode — (String)

          The ISO country code.

          Possible values include:
          • "AF"
          • "AL"
          • "DZ"
          • "AS"
          • "AD"
          • "AO"
          • "AI"
          • "AQ"
          • "AG"
          • "AR"
          • "AM"
          • "AW"
          • "AU"
          • "AT"
          • "AZ"
          • "BS"
          • "BH"
          • "BD"
          • "BB"
          • "BY"
          • "BE"
          • "BZ"
          • "BJ"
          • "BM"
          • "BT"
          • "BO"
          • "BA"
          • "BW"
          • "BR"
          • "IO"
          • "VG"
          • "BN"
          • "BG"
          • "BF"
          • "BI"
          • "KH"
          • "CM"
          • "CA"
          • "CV"
          • "KY"
          • "CF"
          • "TD"
          • "CL"
          • "CN"
          • "CX"
          • "CC"
          • "CO"
          • "KM"
          • "CK"
          • "CR"
          • "HR"
          • "CU"
          • "CW"
          • "CY"
          • "CZ"
          • "CD"
          • "DK"
          • "DJ"
          • "DM"
          • "DO"
          • "TL"
          • "EC"
          • "EG"
          • "SV"
          • "GQ"
          • "ER"
          • "EE"
          • "ET"
          • "FK"
          • "FO"
          • "FJ"
          • "FI"
          • "FR"
          • "PF"
          • "GA"
          • "GM"
          • "GE"
          • "DE"
          • "GH"
          • "GI"
          • "GR"
          • "GL"
          • "GD"
          • "GU"
          • "GT"
          • "GG"
          • "GN"
          • "GW"
          • "GY"
          • "HT"
          • "HN"
          • "HK"
          • "HU"
          • "IS"
          • "IN"
          • "ID"
          • "IR"
          • "IQ"
          • "IE"
          • "IM"
          • "IL"
          • "IT"
          • "CI"
          • "JM"
          • "JP"
          • "JE"
          • "JO"
          • "KZ"
          • "KE"
          • "KI"
          • "KW"
          • "KG"
          • "LA"
          • "LV"
          • "LB"
          • "LS"
          • "LR"
          • "LY"
          • "LI"
          • "LT"
          • "LU"
          • "MO"
          • "MK"
          • "MG"
          • "MW"
          • "MY"
          • "MV"
          • "ML"
          • "MT"
          • "MH"
          • "MR"
          • "MU"
          • "YT"
          • "MX"
          • "FM"
          • "MD"
          • "MC"
          • "MN"
          • "ME"
          • "MS"
          • "MA"
          • "MZ"
          • "MM"
          • "NA"
          • "NR"
          • "NP"
          • "NL"
          • "AN"
          • "NC"
          • "NZ"
          • "NI"
          • "NE"
          • "NG"
          • "NU"
          • "KP"
          • "MP"
          • "NO"
          • "OM"
          • "PK"
          • "PW"
          • "PA"
          • "PG"
          • "PY"
          • "PE"
          • "PH"
          • "PN"
          • "PL"
          • "PT"
          • "PR"
          • "QA"
          • "CG"
          • "RE"
          • "RO"
          • "RU"
          • "RW"
          • "BL"
          • "SH"
          • "KN"
          • "LC"
          • "MF"
          • "PM"
          • "VC"
          • "WS"
          • "SM"
          • "ST"
          • "SA"
          • "SN"
          • "RS"
          • "SC"
          • "SL"
          • "SG"
          • "SX"
          • "SK"
          • "SI"
          • "SB"
          • "SO"
          • "ZA"
          • "KR"
          • "ES"
          • "LK"
          • "SD"
          • "SR"
          • "SJ"
          • "SZ"
          • "SE"
          • "CH"
          • "SY"
          • "TW"
          • "TJ"
          • "TZ"
          • "TH"
          • "TG"
          • "TK"
          • "TO"
          • "TT"
          • "TN"
          • "TR"
          • "TM"
          • "TC"
          • "TV"
          • "VI"
          • "UG"
          • "UA"
          • "AE"
          • "GB"
          • "US"
          • "UY"
          • "UZ"
          • "VU"
          • "VA"
          • "VE"
          • "VN"
          • "WF"
          • "EH"
          • "YE"
          • "ZM"
          • "ZW"
        • PhoneNumberType — (String)

          The type of phone number.

          Possible values include:
          • "TOLL_FREE"
          • "DID"

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Searches queues in an Amazon Connect instance, with optional filtering.

Service Reference:

Examples:

Calling the searchQueues operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* QueueSearchCriteria */
    AndConditions: [
      /* recursive QueueSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive QueueSearchCriteria */,
      /* more items */
    ],
    QueueTypeCondition: STANDARD,
    StringCondition: {
      ComparisonType: STARTS_WITH | CONTAINS | EXACT,
      FieldName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    }
  },
  SearchFilter: {
    TagFilter: {
      AndConditions: [
        {
          TagKey: 'STRING_VALUE',
          TagValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      OrConditions: [
        [
          {
            TagKey: 'STRING_VALUE',
            TagValue: 'STRING_VALUE'
          },
          /* more items */
        ],
        /* more items */
      ],
      TagCondition: {
        TagKey: 'STRING_VALUE',
        TagValue: 'STRING_VALUE'
      }
    }
  }
};
connect.searchQueues(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • SearchFilter — (map)

      Filters to be applied to search results.

      • TagFilter — (map)

        An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

        • Top level list specifies conditions that need to be applied with OR operator

        • Inner list specifies conditions that need to be applied with AND operator.

        • OrConditions — (Array<Array<map>>)

          A list of conditions which would be applied together with an OR condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • AndConditions — (Array<map>)

          A list of conditions which would be applied together with an AND condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • TagCondition — (map)

          A leaf node condition which can be used to specify a tag condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

    • SearchCriteria — (map)

      The search criteria to be used to return queues.

      Note: The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
      • OrConditions — (Array<map>)

        A list of conditions which would be applied together with an OR condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          Note: The currently supported value for FieldName: name
          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
        • QueueTypeCondition — (String)

          The type of queue.

          Possible values include:
          • "STANDARD"
      • AndConditions — (Array<map>)

        A list of conditions which would be applied together with an AND condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          Note: The currently supported value for FieldName: name
          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
        • QueueTypeCondition — (String)

          The type of queue.

          Possible values include:
          • "STANDARD"
      • StringCondition — (map)

        A leaf node condition which can be used to specify a string condition.

        Note: The currently supported value for FieldName: name
        • FieldName — (String)

          The name of the field in the string condition.

        • Value — (String)

          The value of the string.

        • ComparisonType — (String)

          The type of comparison to be made when evaluating the string condition.

          Possible values include:
          • "STARTS_WITH"
          • "CONTAINS"
          • "EXACT"
      • QueueTypeCondition — (String)

        The type of queue.

        Possible values include:
        • "STANDARD"

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:

      • Queues — (Array<map>)

        Information about the queues.

        • Name — (String)

          The name of the queue.

        • QueueArn — (String)

          The Amazon Resource Name (ARN) for the queue.

        • QueueId — (String)

          The identifier for the queue.

        • Description — (String)

          The description of the queue.

        • OutboundCallerConfig — (map)

          The outbound caller ID name, number, and outbound whisper flow.

          • OutboundCallerIdName — (String)

            The caller ID name.

          • OutboundCallerIdNumberId — (String)

            The caller ID number.

          • OutboundFlowId — (String)

            The outbound whisper flow to be used during an outbound call.

        • HoursOfOperationId — (String)

          The identifier for the hours of operation.

        • MaxContacts — (Integer)

          The maximum number of contacts that can be in the queue before it is considered full.

        • Status — (String)

          The status of the queue.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

      • ApproximateTotalCount — (Integer)

        The total number of queues which matched your search query.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Searches routing profiles in an Amazon Connect instance, with optional filtering.

Service Reference:

Examples:

Calling the searchRoutingProfiles operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* RoutingProfileSearchCriteria */
    AndConditions: [
      /* recursive RoutingProfileSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive RoutingProfileSearchCriteria */,
      /* more items */
    ],
    StringCondition: {
      ComparisonType: STARTS_WITH | CONTAINS | EXACT,
      FieldName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    }
  },
  SearchFilter: {
    TagFilter: {
      AndConditions: [
        {
          TagKey: 'STRING_VALUE',
          TagValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      OrConditions: [
        [
          {
            TagKey: 'STRING_VALUE',
            TagValue: 'STRING_VALUE'
          },
          /* more items */
        ],
        /* more items */
      ],
      TagCondition: {
        TagKey: 'STRING_VALUE',
        TagValue: 'STRING_VALUE'
      }
    }
  }
};
connect.searchRoutingProfiles(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • SearchFilter — (map)

      Filters to be applied to search results.

      • TagFilter — (map)

        An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

        • Top level list specifies conditions that need to be applied with OR operator

        • Inner list specifies conditions that need to be applied with AND operator.

        • OrConditions — (Array<Array<map>>)

          A list of conditions which would be applied together with an OR condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • AndConditions — (Array<map>)

          A list of conditions which would be applied together with an AND condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • TagCondition — (map)

          A leaf node condition which can be used to specify a tag condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

    • SearchCriteria — (map)

      The search criteria to be used to return routing profiles.

      Note: The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
      • OrConditions — (Array<map>)

        A list of conditions which would be applied together with an OR condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          Note: The currently supported value for FieldName: name
          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
      • AndConditions — (Array<map>)

        A list of conditions which would be applied together with an AND condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          Note: The currently supported value for FieldName: name
          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
      • StringCondition — (map)

        A leaf node condition which can be used to specify a string condition.

        Note: The currently supported value for FieldName: name
        • FieldName — (String)

          The name of the field in the string condition.

        • Value — (String)

          The value of the string.

        • ComparisonType — (String)

          The type of comparison to be made when evaluating the string condition.

          Possible values include:
          • "STARTS_WITH"
          • "CONTAINS"
          • "EXACT"

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:

      • RoutingProfiles — (Array<map>)

        Information about the routing profiles.

        • InstanceId — (String)

          The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • Name — (String)

          The name of the routing profile.

        • RoutingProfileArn — (String)

          The Amazon Resource Name (ARN) of the routing profile.

        • RoutingProfileId — (String)

          The identifier of the routing profile.

        • Description — (String)

          The description of the routing profile.

        • MediaConcurrencies — (Array<map>)

          The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

          • Channelrequired — (String)

            The channels that agents can handle in the Contact Control Panel (CCP).

            Possible values include:
            • "VOICE"
            • "CHAT"
            • "TASK"
          • Concurrencyrequired — (Integer)

            The number of contacts an agent can have on a channel simultaneously.

            Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

            Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

            Valid Range for TASK: Minimum value of 1. Maximum value of 10.

        • DefaultOutboundQueueId — (String)

          The identifier of the default outbound queue for this routing profile.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

        • NumberOfAssociatedQueues — (Integer)

          The number of associated queues in routing profile.

        • NumberOfAssociatedUsers — (Integer)

          The number of associated users in routing profile.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

      • ApproximateTotalCount — (Integer)

        The total number of routing profiles which matched your search query.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Searches security profiles in an Amazon Connect instance, with optional filtering.

Service Reference:

Examples:

Calling the searchSecurityProfiles operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* SecurityProfileSearchCriteria */
    AndConditions: [
      /* recursive SecurityProfileSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive SecurityProfileSearchCriteria */,
      /* more items */
    ],
    StringCondition: {
      ComparisonType: STARTS_WITH | CONTAINS | EXACT,
      FieldName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    }
  },
  SearchFilter: {
    TagFilter: {
      AndConditions: [
        {
          TagKey: 'STRING_VALUE',
          TagValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      OrConditions: [
        [
          {
            TagKey: 'STRING_VALUE',
            TagValue: 'STRING_VALUE'
          },
          /* more items */
        ],
        /* more items */
      ],
      TagCondition: {
        TagKey: 'STRING_VALUE',
        TagValue: 'STRING_VALUE'
      }
    }
  }
};
connect.searchSecurityProfiles(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • SearchCriteria — (map)

      The search criteria to be used to return security profiles.

      Note: The name field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
      Note: The currently supported value for FieldName: name
      • OrConditions — (Array<map>)

        A list of conditions which would be applied together with an OR condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          Note: The currently supported value for FieldName: name
          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
      • AndConditions — (Array<map>)

        A list of conditions which would be applied together with an AND condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          Note: The currently supported value for FieldName: name
          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
      • StringCondition — (map)

        A leaf node condition which can be used to specify a string condition.

        Note: The currently supported value for FieldName: name
        • FieldName — (String)

          The name of the field in the string condition.

        • Value — (String)

          The value of the string.

        • ComparisonType — (String)

          The type of comparison to be made when evaluating the string condition.

          Possible values include:
          • "STARTS_WITH"
          • "CONTAINS"
          • "EXACT"
    • SearchFilter — (map)

      Filters to be applied to search results.

      • TagFilter — (map)

        An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

        • Top level list specifies conditions that need to be applied with OR operator

        • Inner list specifies conditions that need to be applied with AND operator.

        • OrConditions — (Array<Array<map>>)

          A list of conditions which would be applied together with an OR condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • AndConditions — (Array<map>)

          A list of conditions which would be applied together with an AND condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • TagCondition — (map)

          A leaf node condition which can be used to specify a tag condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

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:

      • SecurityProfiles — (Array<map>)

        Information about the security profiles.

        • Id — (String)

          The identifier of the security profile.

        • OrganizationResourceId — (String)

          The organization resource identifier.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the security profile.

        • SecurityProfileName — (String)

          The name of the security profile.

        • Description — (String)

          The description of the security profile.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

      • ApproximateTotalCount — (Integer)

        The total number of security profiles which matched your search query.

Returns:

  • (AWS.Request)

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

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

Searches users in an Amazon Connect instance, with optional filtering.

Note: AfterContactWorkTimeLimit is returned in milliseconds.

Service Reference:

Examples:

Calling the searchUsers operation

var params = {
  InstanceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* UserSearchCriteria */
    AndConditions: [
      /* recursive UserSearchCriteria */,
      /* more items */
    ],
    HierarchyGroupCondition: {
      HierarchyGroupMatchType: EXACT | WITH_CHILD_GROUPS,
      Value: 'STRING_VALUE'
    },
    OrConditions: [
      /* recursive UserSearchCriteria */,
      /* more items */
    ],
    StringCondition: {
      ComparisonType: STARTS_WITH | CONTAINS | EXACT,
      FieldName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    }
  },
  SearchFilter: {
    TagFilter: {
      AndConditions: [
        {
          TagKey: 'STRING_VALUE',
          TagValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      OrConditions: [
        [
          {
            TagKey: 'STRING_VALUE',
            TagValue: 'STRING_VALUE'
          },
          /* more items */
        ],
        /* more items */
      ],
      TagCondition: {
        TagKey: 'STRING_VALUE',
        TagValue: 'STRING_VALUE'
      }
    }
  }
};
connect.searchUsers(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • SearchFilter — (map)

      Filters to be applied to search results.

      • TagFilter — (map)

        An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

        • Top level list specifies conditions that need to be applied with OR operator

        • Inner list specifies conditions that need to be applied with AND operator.

        • OrConditions — (Array<Array<map>>)

          A list of conditions which would be applied together with an OR condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • AndConditions — (Array<map>)

          A list of conditions which would be applied together with an AND condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • TagCondition — (map)

          A leaf node condition which can be used to specify a tag condition.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

    • SearchCriteria — (map)

      The search criteria to be used to return users.

      Note: The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
      • OrConditions — (Array<map>)

        A list of conditions which would be applied together with an OR condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
        • HierarchyGroupCondition — (map)

          A leaf node condition which can be used to specify a hierarchy group condition.

          • Value — (String)

            The value in the hierarchy group condition.

          • HierarchyGroupMatchType — (String)

            The type of hierarchy group match.

            Possible values include:
            • "EXACT"
            • "WITH_CHILD_GROUPS"
      • AndConditions — (Array<map>)

        A list of conditions which would be applied together with an AND condition.

        • StringCondition — (map)

          A leaf node condition which can be used to specify a string condition.

          • FieldName — (String)

            The name of the field in the string condition.

          • Value — (String)

            The value of the string.

          • ComparisonType — (String)

            The type of comparison to be made when evaluating the string condition.

            Possible values include:
            • "STARTS_WITH"
            • "CONTAINS"
            • "EXACT"
        • HierarchyGroupCondition — (map)

          A leaf node condition which can be used to specify a hierarchy group condition.

          • Value — (String)

            The value in the hierarchy group condition.

          • HierarchyGroupMatchType — (String)

            The type of hierarchy group match.

            Possible values include:
            • "EXACT"
            • "WITH_CHILD_GROUPS"
      • StringCondition — (map)

        A leaf node condition which can be used to specify a string condition.

        • FieldName — (String)

          The name of the field in the string condition.

        • Value — (String)

          The value of the string.

        • ComparisonType — (String)

          The type of comparison to be made when evaluating the string condition.

          Possible values include:
          • "STARTS_WITH"
          • "CONTAINS"
          • "EXACT"
      • HierarchyGroupCondition — (map)

        A leaf node condition which can be used to specify a hierarchy group condition.

        • Value — (String)

          The value in the hierarchy group condition.

        • HierarchyGroupMatchType — (String)

          The type of hierarchy group match.

          Possible values include:
          • "EXACT"
          • "WITH_CHILD_GROUPS"

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:

      • Users — (Array<map>)

        Information about the users.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the user.

        • DirectoryUserId — (String)

          The directory identifier of the user.

        • HierarchyGroupId — (String)

          The identifier of the user's hierarchy group.

        • Id — (String)

          The identifier of the user's summary.

        • IdentityInfo — (map)

          The user's first name and last name.

          • FirstName — (String)

            The user's first name.

          • LastName — (String)

            The user's last name.

        • PhoneConfig — (map)

          Contains information about the phone configuration settings for a user.

          • PhoneTyperequired — (String)

            The phone type.

            Possible values include:
            • "SOFT_PHONE"
            • "DESK_PHONE"
          • AutoAccept — (Boolean)

            The Auto accept setting.

          • AfterContactWorkTimeLimit — (Integer)

            The After Call Work (ACW) timeout setting, in seconds.

            Note: When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
          • DeskPhoneNumber — (String)

            The phone number for the user's desk phone.

        • RoutingProfileId — (String)

          The identifier of the user's routing profile.

        • SecurityProfileIds — (Array<String>)

          The identifiers of the user's security profiles.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

        • Username — (String)

          The name of the user.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

      • ApproximateTotalCount — (Integer)

        The total number of users who matched your search query.

Returns:

  • (AWS.Request)

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

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

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

Service Reference:

Examples:

Calling the searchVocabularies operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LanguageCode: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN,
  MaxResults: 'NUMBER_VALUE',
  NameStartsWith: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  State: CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILED | DELETE_IN_PROGRESS
};
connect.searchVocabularies(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • NextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • State — (String)

      The current state of the custom vocabulary.

      Possible values include:
      • "CREATION_IN_PROGRESS"
      • "ACTIVE"
      • "CREATION_FAILED"
      • "DELETE_IN_PROGRESS"
    • NameStartsWith — (String)

      The starting pattern of the name of the vocabulary.

    • LanguageCode — (String)

      The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

      Possible values include:
      • "ar-AE"
      • "de-CH"
      • "de-DE"
      • "en-AB"
      • "en-AU"
      • "en-GB"
      • "en-IE"
      • "en-IN"
      • "en-US"
      • "en-WL"
      • "es-ES"
      • "es-US"
      • "fr-CA"
      • "fr-FR"
      • "hi-IN"
      • "it-IT"
      • "ja-JP"
      • "ko-KR"
      • "pt-BR"
      • "pt-PT"
      • "zh-CN"

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:

      • VocabularySummaryList — (Array<map>)

        The list of the available custom vocabularies.

        • Namerequired — (String)

          A unique name of the custom vocabulary.

        • Idrequired — (String)

          The identifier of the custom vocabulary.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the custom vocabulary.

        • LanguageCoderequired — (String)

          The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

          Possible values include:
          • "ar-AE"
          • "de-CH"
          • "de-DE"
          • "en-AB"
          • "en-AU"
          • "en-GB"
          • "en-IE"
          • "en-IN"
          • "en-US"
          • "en-WL"
          • "es-ES"
          • "es-US"
          • "fr-CA"
          • "fr-FR"
          • "hi-IN"
          • "it-IT"
          • "ja-JP"
          • "ko-KR"
          • "pt-BR"
          • "pt-PT"
          • "zh-CN"
        • Staterequired — (String)

          The current state of the custom vocabulary.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "ACTIVE"
          • "CREATION_FAILED"
          • "DELETE_IN_PROGRESS"
        • LastModifiedTimerequired — (Date)

          The timestamp when the custom vocabulary was last modified.

        • FailureReason — (String)

          The reason why the custom vocabulary was not created.

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in the following situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

For more information about chat, see Chat in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the startChatContact operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ParticipantDetails: { /* required */
    DisplayName: 'STRING_VALUE' /* required */
  },
  Attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  ChatDurationInMinutes: 'NUMBER_VALUE',
  ClientToken: 'STRING_VALUE',
  InitialMessage: {
    Content: 'STRING_VALUE', /* required */
    ContentType: 'STRING_VALUE' /* required */
  },
  SupportedMessagingContentTypes: [
    'STRING_VALUE',
    /* more items */
  ]
};
connect.startChatContact(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowId — (String)

      The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

    • Attributes — (map<String>)

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

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    • ParticipantDetails — (map)

      Information identifying the participant.

      • DisplayNamerequired — (String)

        Display name of the participant.

    • InitialMessage — (map)

      The initial message to be sent to the newly created chat.

      • ContentTyperequired — (String)

        The type of the content. Supported types are text/plain.

      • Contentrequired — (String)

        The content of the chat message.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ChatDurationInMinutes — (Integer)

      The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

    • SupportedMessagingContentTypes — (Array<String>)

      The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

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:

      • ContactId — (String)

        The identifier of this contact within the Amazon Connect instance.

      • ParticipantId — (String)

        The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

      • ParticipantToken — (String)

        The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

Returns:

  • (AWS.Request)

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

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

Starts recording the contact:

  • If the API is called before the agent joins the call, recording starts when the agent joins the call.

  • If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

Service Reference:

Examples:

Calling the startContactRecording operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  VoiceRecordingConfiguration: { /* required */
    VoiceRecordingTrack: FROM_AGENT | TO_AGENT | ALL
  }
};
connect.startContactRecording(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

    • InitialContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    • VoiceRecordingConfiguration — (map)

      The person being recorded.

      • VoiceRecordingTrack — (String)

        Identifies which track is being recorded.

        Possible values include:
        • "FROM_AGENT"
        • "TO_AGENT"
        • "ALL"

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.

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

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the startContactStreaming operation

var params = {
  ChatStreamingConfiguration: { /* required */
    StreamingEndpointArn: 'STRING_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE', /* required */
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.startContactStreaming(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    • ChatStreamingConfiguration — (map)

      The streaming configuration, such as the Amazon SNS streaming endpoint.

      • StreamingEndpointArnrequired — (String)

        The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • StreamingId — (String)

        The identifier of the streaming configuration enabled.

Returns:

  • (AWS.Request)

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

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

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

Note: UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Note: Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

Service Reference:

Examples:

Calling the startOutboundVoiceContact operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  DestinationPhoneNumber: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  AnswerMachineDetectionConfig: {
    AwaitAnswerMachinePrompt: true || false,
    EnableAnswerMachineDetection: true || false
  },
  Attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  CampaignId: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  QueueId: 'STRING_VALUE',
  SourcePhoneNumber: 'STRING_VALUE',
  TrafficType: GENERAL | CAMPAIGN
};
connect.startOutboundVoiceContact(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: {})
    • DestinationPhoneNumber — (String)

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

    • ContactFlowId — (String)

      The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

      If a token is not provided, the SDK will use a version 4 UUID.
    • SourcePhoneNumber — (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.

    • QueueId — (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 flow is used. If you do not specify a queue, you must specify a source phone number.

    • Attributes — (map<String>)

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

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    • AnswerMachineDetectionConfig — (map)

      Configuration of the answering machine detection for this outbound call.

      • EnableAnswerMachineDetection — (Boolean)

        The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.

      • AwaitAnswerMachinePrompt — (Boolean)

        Wait for the answering machine prompt.

    • CampaignId — (String)

      The campaign identifier of the outbound communication.

    • TrafficType — (String)

      Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

      Possible values include:
      • "GENERAL"
      • "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:

      • ContactId — (String)

        The identifier of this contact within the Amazon Connect instance.

Returns:

  • (AWS.Request)

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

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

Initiates a flow to start a new task.

Service Reference:

Examples:

Calling the startTaskContact operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  ClientToken: 'STRING_VALUE',
  ContactFlowId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  PreviousContactId: 'STRING_VALUE',
  QuickConnectId: 'STRING_VALUE',
  References: {
    '<ReferenceKey>': {
      Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* '<ReferenceKey>': ... */
  },
  ScheduledTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TaskTemplateId: 'STRING_VALUE'
};
connect.startTaskContact(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • PreviousContactId — (String)

      The identifier of the previous chat, voice, or task contact.

    • ContactFlowId — (String)

      The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

    • Attributes — (map<String>)

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

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    • Name — (String)

      The name of a task that is shown to an agent in the Contact Control Panel (CCP).

    • References — (map<map>)

      A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

      • Valuerequired — (String)

        A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

      • Typerequired — (String)

        The type of the reference. DATE must be of type Epoch timestamp.

        Possible values include:
        • "URL"
        • "ATTACHMENT"
        • "NUMBER"
        • "STRING"
        • "DATE"
        • "EMAIL"
    • Description — (String)

      A description of the task that is shown to an agent in the Contact Control Panel (CCP).

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ScheduledTime — (Date)

      The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

    • TaskTemplateId — (String)

      A unique identifier for the task template.

    • QuickConnectId — (String)

      The identifier for the quick connect.

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:

      • ContactId — (String)

        The identifier of this contact within the Amazon Connect instance.

Returns:

  • (AWS.Request)

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

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

Ends the specified contact. This call does not work for the following initiation methods:

  • DISCONNECT

  • TRANSFER

  • QUEUE_TRANSFER

Service Reference:

Examples:

Calling the stopContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.stopContact(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: {})
    • ContactId — (String)

      The ID of the contact.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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.

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

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

Service Reference:

Examples:

Calling the stopContactRecording operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.stopContactRecording(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

    • InitialContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

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.

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

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

Service Reference:

Examples:

Calling the stopContactStreaming operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  StreamingId: 'STRING_VALUE' /* required */
};
connect.stopContactStreaming(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

    • StreamingId — (String)

      The identifier of the streaming configuration enabled.

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.

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

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

Service Reference:

Examples:

Calling the suspendContactRecording operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.suspendContactRecording(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

    • InitialContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

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

Adds the specified tags to the specified resource.

Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": "key2":"value2" }.

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.

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

Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:

  • Transfer is supported for only TASK contacts.

  • Do not use both QueueId and UserId in the same call.

  • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

  • The TransferContact API can be called only on active contacts.

  • A contact cannot be transferred more than 11 times.

Service Reference:

Examples:

Calling the transferContact operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  QueueId: 'STRING_VALUE',
  UserId: 'STRING_VALUE'
};
connect.transferContact(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact in this instance of Amazon Connect.

    • QueueId — (String)

      The identifier for the queue.

    • UserId — (String)

      The identifier for the user.

    • ContactFlowId — (String)

      The identifier of the flow.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • ContactId — (String)

        The identifier of the contact in this instance of Amazon Connect.

      • ContactArn — (String)

        The Amazon Resource Name (ARN) of the contact.

Returns:

  • (AWS.Request)

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

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

Removes the specified tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connect.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: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The 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.

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

This API is in preview release for Amazon Connect and is subject to change.

Updates agent status.

Service Reference:

Examples:

Calling the updateAgentStatus operation

var params = {
  AgentStatusId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisplayOrder: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  ResetOrderNumber: true || false,
  State: ENABLED | DISABLED
};
connect.updateAgentStatus(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AgentStatusId — (String)

      The identifier of the agent status.

    • Name — (String)

      The name of the agent status.

    • Description — (String)

      The description of the agent status.

    • State — (String)

      The state of the agent status.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • DisplayOrder — (Integer)

      The display order of the agent status.

    • ResetOrderNumber — (Boolean)

      A number indicating the reset order of the agent status.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

You can add or update user-defined contact information for both ongoing and completed contacts.

Service Reference:

Examples:

Calling the updateContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  References: {
    '<ReferenceKey>': {
      Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* '<ReferenceKey>': ... */
  }
};
connect.updateContact(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

    • Name — (String)

      The name of the contact.

    • Description — (String)

      The description of the contact.

    • References — (map<map>)

      Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

      • Valuerequired — (String)

        A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

      • Typerequired — (String)

        The type of the reference. DATE must be of type Epoch timestamp.

        Possible values include:
        • "URL"
        • "ATTACHMENT"
        • "NUMBER"
        • "STRING"
        • "DATE"
        • "EMAIL"

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.

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

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the updateContactAttributes operation

var params = {
  Attributes: { /* required */
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.updateContactAttributes(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: {})
    • InitialContactId — (String)

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • Attributes — (map<String>)

      The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.

      You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

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.

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

Updates the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

Service Reference:

Examples:

Calling the updateContactFlowContent operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.updateContactFlowContent(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • ContactFlowId — (String)

      The identifier of the flow.

    • Content — (String)

      The JSON string that represents flow's content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.

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.

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

Updates metadata about specified flow.

Service Reference:

Examples:

Calling the updateContactFlowMetadata operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ContactFlowState: ACTIVE | ARCHIVED,
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
connect.updateContactFlowMetadata(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowId — (String)

      The identifier of the flow.

    • Name — (String)

      The name of the flow.

    • Description — (String)

      The description of the flow.

    • ContactFlowState — (String)

      The state of flow.

      Possible values include:
      • "ACTIVE"
      • "ARCHIVED"

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.

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

Updates specified flow module for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the updateContactFlowModuleContent operation

var params = {
  ContactFlowModuleId: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.updateContactFlowModuleContent(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowModuleId — (String)

      The identifier of the flow module.

    • Content — (String)

      The content of the flow module.

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.

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

Updates metadata about specified flow module.

Service Reference:

Examples:

Calling the updateContactFlowModuleMetadata operation

var params = {
  ContactFlowModuleId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  State: ACTIVE | ARCHIVED
};
connect.updateContactFlowModuleMetadata(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactFlowModuleId — (String)

      The identifier of the flow module.

    • Name — (String)

      The name of the flow module.

    • Description — (String)

      The description of the flow module.

    • State — (String)

      The state of flow module.

      Possible values include:
      • "ACTIVE"
      • "ARCHIVED"

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.

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

The name of the flow.

You can also create and update flows using the Amazon Connect Flow language.

Service Reference:

Examples:

Calling the updateContactFlowName operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
connect.updateContactFlowName(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • ContactFlowId — (String)

      The identifier of the flow.

    • Name — (String)

      The name of the flow.

    • Description — (String)

      The description of the flow.

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.

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

Updates the scheduled time of a task contact that is already scheduled.

Service Reference:

Examples:

Calling the updateContactSchedule operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ScheduledTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
connect.updateContactSchedule(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • ContactId — (String)

      The identifier of the contact.

    • ScheduledTime — (Date)

      The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Updates the hours of operation.

Service Reference:

Examples:

Calling the updateHoursOfOperation operation

var params = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Config: [
    {
      Day: SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY, /* required */
      EndTime: { /* required */
        Hours: 'NUMBER_VALUE', /* required */
        Minutes: 'NUMBER_VALUE' /* required */
      },
      StartTime: { /* required */
        Hours: 'NUMBER_VALUE', /* required */
        Minutes: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  TimeZone: 'STRING_VALUE'
};
connect.updateHoursOfOperation(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • HoursOfOperationId — (String)

      The identifier of the hours of operation.

    • Name — (String)

      The name of the hours of operation.

    • Description — (String)

      The description of the hours of operation.

    • TimeZone — (String)

      The time zone of the hours of operation.

    • Config — (Array<map>)

      Configuration information of the hours of operation.

      • Dayrequired — (String)

        The day that the hours of operation applies to.

        Possible values include:
        • "SUNDAY"
        • "MONDAY"
        • "TUESDAY"
        • "WEDNESDAY"
        • "THURSDAY"
        • "FRIDAY"
        • "SATURDAY"
      • StartTimerequired — (map)

        The start time that your contact center opens.

        • Hoursrequired — (Integer)

          The hours.

        • Minutesrequired — (Integer)

          The minutes.

      • EndTimerequired — (map)

        The end time that your contact center closes.

        • Hoursrequired — (Integer)

          The hours.

        • Minutesrequired — (Integer)

          The minutes.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Updates the value for the specified attribute type.

Service Reference:

Examples:

Calling the updateInstanceAttribute operation

var params = {
  AttributeType: INBOUND_CALLS | OUTBOUND_CALLS | CONTACTFLOW_LOGS | CONTACT_LENS | AUTO_RESOLVE_BEST_VOICES | USE_CUSTOM_TTS_VOICES | EARLY_MEDIA | MULTI_PARTY_CONFERENCE | HIGH_VOLUME_OUTBOUND | ENHANCED_CONTACT_MONITORING, /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Value: 'STRING_VALUE' /* required */
};
connect.updateInstanceAttribute(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AttributeType — (String)

      The type of attribute.

      Note: Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
      Possible values include:
      • "INBOUND_CALLS"
      • "OUTBOUND_CALLS"
      • "CONTACTFLOW_LOGS"
      • "CONTACT_LENS"
      • "AUTO_RESOLVE_BEST_VOICES"
      • "USE_CUSTOM_TTS_VOICES"
      • "EARLY_MEDIA"
      • "MULTI_PARTY_CONFERENCE"
      • "HIGH_VOLUME_OUTBOUND"
      • "ENHANCED_CONTACT_MONITORING"
    • Value — (String)

      The value for the attribute. Maximum character limit is 100.

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.

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

This API is in preview release for Amazon Connect and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

Service Reference:

Examples:

Calling the updateInstanceStorageConfig operation

var params = {
  AssociationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ResourceType: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, /* required */
  StorageConfig: { /* required */
    StorageType: S3 | KINESIS_VIDEO_STREAM | KINESIS_STREAM | KINESIS_FIREHOSE, /* required */
    AssociationId: 'STRING_VALUE',
    KinesisFirehoseConfig: {
      FirehoseArn: 'STRING_VALUE' /* required */
    },
    KinesisStreamConfig: {
      StreamArn: 'STRING_VALUE' /* required */
    },
    KinesisVideoStreamConfig: {
      EncryptionConfig: { /* required */
        EncryptionType: KMS, /* required */
        KeyId: 'STRING_VALUE' /* required */
      },
      Prefix: 'STRING_VALUE', /* required */
      RetentionPeriodHours: 'NUMBER_VALUE' /* required */
    },
    S3Config: {
      BucketName: 'STRING_VALUE', /* required */
      BucketPrefix: 'STRING_VALUE', /* required */
      EncryptionConfig: {
        EncryptionType: KMS, /* required */
        KeyId: 'STRING_VALUE' /* required */
      }
    }
  }
};
connect.updateInstanceStorageConfig(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: {})
    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • AssociationId — (String)

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "CHAT_TRANSCRIPTS"
      • "CALL_RECORDINGS"
      • "SCHEDULED_REPORTS"
      • "MEDIA_STREAMS"
      • "CONTACT_TRACE_RECORDS"
      • "AGENT_EVENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"
    • StorageConfig — (map)

      The storage configuration for the instance.

      • AssociationId — (String)

        The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

      • StorageTyperequired — (String)

        A valid storage type.

        Possible values include:
        • "S3"
        • "KINESIS_VIDEO_STREAM"
        • "KINESIS_STREAM"
        • "KINESIS_FIREHOSE"
      • S3Config — (map)

        The S3 bucket configuration.

        • BucketNamerequired — (String)

          The S3 bucket name.

        • BucketPrefixrequired — (String)

          The S3 bucket prefix.

        • EncryptionConfig — (map)

          The Amazon S3 encryption configuration.

          • EncryptionTyperequired — (String)

            The type of encryption.

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

            The full ARN of the encryption key.

            Note: Be sure to provide the full ARN of the encryption key, not just the ID.
      • KinesisVideoStreamConfig — (map)

        The configuration of the Kinesis video stream.

        • Prefixrequired — (String)

          The prefix of the video stream.

        • RetentionPeriodHoursrequired — (Integer)

          The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

          The default value is 0, indicating that the stream does not persist data.

        • EncryptionConfigrequired — (map)

          The encryption configuration.

          • EncryptionTyperequired — (String)

            The type of encryption.

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

            The full ARN of the encryption key.

            Note: Be sure to provide the full ARN of the encryption key, not just the ID.
      • KinesisStreamConfig — (map)

        The configuration of the Kinesis data stream.

        • StreamArnrequired — (String)

          The Amazon Resource Name (ARN) of the data stream.

      • KinesisFirehoseConfig — (map)

        The configuration of the Kinesis Firehose delivery stream.

        • FirehoseArnrequired — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

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.

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

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

Service Reference:

Examples:

Calling the updatePhoneNumber operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  TargetArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.updatePhoneNumber(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: {})
    • PhoneNumberId — (String)

      A unique identifier for the phone number.

    • TargetArn — (String)

      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • PhoneNumberId — (String)

        A unique identifier for the phone number.

      • PhoneNumberArn — (String)

        The Amazon Resource Name (ARN) of the phone number.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and is subject to change.

Updates the hours of operation for the specified queue.

Service Reference: