We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.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.

Sending a Request Using Connect

var connect = new AWS.Connect();
connect.activateEvaluationForm(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

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

Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

Service Reference:

Examples:

Calling the activateEvaluationForm operation

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  EvaluationFormVersion: 'NUMBER_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.activateEvaluationForm(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • EvaluationFormVersion — (Integer)

      The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.

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:

      • EvaluationFormId — (String)

        The unique identifier for the evaluation form.

      • EvaluationFormArn — (String)

        The Amazon Resource Name (ARN) for the evaluation form resource.

      • EvaluationFormVersion — (Integer)

        A version of the evaluation form.

Returns:

  • (AWS.Request)

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

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

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

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

Service Reference:

Examples:

Calling the associateAnalyticsDataSet operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.associateAnalyticsDataSet(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • DataSetId — (String)

      The identifier of the dataset to associate with the target account.

    • TargetAccountId — (String)

      The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect 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:

      • DataSetId — (String)

        The identifier of the dataset that was associated.

      • TargetAccountId — (String)

        The identifier of the target account.

      • ResourceShareId — (String)

        The Resource Access Manager share ID that is generated.

      • ResourceShareArn — (String)

        The Amazon Resource Name (ARN) of the Resource Access Manager share.

Returns:

  • (AWS.Request)

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

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 instance ID in the Amazon Resource Name (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', /* required */
    Name: 'STRING_VALUE' /* required */
  },
  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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • LexBot — (map)

      Configuration information of an Amazon Lex bot.

      • Namerequired — (String)

        The name of the Amazon Lex bot.

      • LexRegionrequired — (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 | en-NZ | en-ZA, /* 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 instance ID in the Amazon Resource Name (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"
      • "en-NZ"
      • "en-ZA"
    • 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.

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

Associates a connect resource to a flow.

Service Reference:

Examples:

Calling the associateFlow operation

var params = {
  FlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: SMS_PHONE_NUMBER /* required */
};
connect.associateFlow(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ResourceId — (String)

      The identifier of the resource.

    • FlowId — (String)

      The identifier of the flow.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "SMS_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.

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 | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ResourceType — (String)

      A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:

      • For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.

      • For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

      Note: REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.
      Possible values include:
      • "CHAT_TRANSCRIPTS"
      • "CALL_RECORDINGS"
      • "SCHEDULED_REPORTS"
      • "MEDIA_STREAMS"
      • "CONTACT_TRACE_RECORDS"
      • "AGENT_EVENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS"
      • "ATTACHMENTS"
      • "CONTACT_EVALUATIONS"
      • "SCREEN_RECORDINGS"
      • "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_VOICE_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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
      • 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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
      • 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 instance ID in the Amazon Resource Name (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 V1 bot. This API only supports the association of Amazon Lex V1 bots.

Service Reference:

Examples:

Calling the associateLexBot operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  LexBot: { /* required */
    LexRegion: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE' /* required */
  }
};
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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • LexBot — (map)

      The Amazon Lex bot to associate with the instance.

      • Namerequired — (String)

        The name of the Amazon Lex bot.

      • LexRegionrequired — (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Associates an agent with a traffic distribution group.

Examples:

Calling the associateTrafficDistributionGroupUser operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TrafficDistributionGroupId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.associateTrafficDistributionGroupUser(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.

    • UserId — (String)

      The identifier of the user account. This can be the ID or the ARN of the user.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

>Associates a set of proficiencies with a user.

Service Reference:

Examples:

Calling the associateUserProficiencies operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  UserProficiencies: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeValue: 'STRING_VALUE', /* required */
      Level: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ]
};
connect.associateUserProficiencies(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 instance ID in the Amazon Resource Name (ARN of the instance).

    • UserId — (String)

      The identifier of the user account.

    • UserProficiencies — (Array<map>)

      The proficiencies to associate with the user.

      • AttributeNamerequired — (String)

        The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.

      • AttributeValuerequired — (String)

        The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.

      • Levelrequired — (Float)

        The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.

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.

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

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

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

Service Reference:

Examples:

Calling the batchAssociateAnalyticsDataSet operation

var params = {
  DataSetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.batchAssociateAnalyticsDataSet(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • DataSetIds — (Array<String>)

      An array of dataset identifiers to associate.

    • TargetAccountId — (String)

      The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect 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:

      • Created — (Array<map>)

        Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

        • DataSetId — (String)

          The identifier of the dataset.

        • TargetAccountId — (String)

          The identifier of the target account.

        • ResourceShareId — (String)

          The Resource Access Manager share ID.

        • ResourceShareArn — (String)

          The Amazon Resource Name (ARN) of the Resource Access Manager share.

      • Errors — (Array<map>)

        A list of errors for datasets that aren't successfully associated with the target account.

        • ErrorCode — (String)

          The error code.

        • ErrorMessage — (String)

          The corresponding error message for the error code.

Returns:

  • (AWS.Request)

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

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

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

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

Examples:

Calling the batchDisassociateAnalyticsDataSet operation

var params = {
  DataSetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.batchDisassociateAnalyticsDataSet(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • DataSetIds — (Array<String>)

      An array of associated dataset identifiers to remove.

    • TargetAccountId — (String)

      The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect 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:

      • Deleted — (Array<String>)

        An array of successfully disassociated dataset identifiers.

      • Errors — (Array<map>)

        A list of errors for any datasets not successfully removed.

        • ErrorCode — (String)

          The error code.

        • ErrorMessage — (String)

          The corresponding error message for the error code.

Returns:

  • (AWS.Request)

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

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

Retrieve the flow associations for the given resources.

Service Reference:

Examples:

Calling the batchGetFlowAssociation operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ResourceType: VOICE_PHONE_NUMBER
};
connect.batchGetFlowAssociation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ResourceIds — (Array<String>)

      A list of resource identifiers to retrieve flow associations.

    • ResourceType — (String)

      The type of resource association.

      Possible values include:
      • "VOICE_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:

      • FlowAssociationSummaryList — (Array<map>)

        Information about flow associations.

        • ResourceId — (String)

          The identifier of the resource.

        • FlowId — (String)

          The identifier of the flow.

        • ResourceType — (String)

          The type of resource association.

          Possible values include:
          • "VOICE_PHONE_NUMBER"

Returns:

  • (AWS.Request)

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

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

Note: Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

Service Reference:

Examples:

Calling the batchPutContact operation

var params = {
  ContactDataRequestList: [ /* required */
    {
      Attributes: {
        '<AttributeName>': 'STRING_VALUE',
        /* '<AttributeName>': ... */
      },
      Campaign: {
        CampaignId: 'STRING_VALUE'
      },
      CustomerEndpoint: {
        Address: 'STRING_VALUE',
        Type: TELEPHONE_NUMBER | VOIP | CONTACT_FLOW
      },
      QueueId: 'STRING_VALUE',
      RequestIdentifier: 'STRING_VALUE',
      SystemEndpoint: {
        Address: 'STRING_VALUE',
        Type: TELEPHONE_NUMBER | VOIP | CONTACT_FLOW
      }
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.batchPutContact(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 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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactDataRequestList — (Array<map>)

      List of individual contact requests.

      • SystemEndpoint — (map)

        Endpoint associated with the Amazon Connect instance from which outbound contact will be initiated for the campaign.

        • Type — (String)

          Type of the endpoint.

          Possible values include:
          • "TELEPHONE_NUMBER"
          • "VOIP"
          • "CONTACT_FLOW"
        • Address — (String)

          Address of the endpoint.

      • CustomerEndpoint — (map)

        Endpoint of the customer for which contact will be initiated.

        • Type — (String)

          Type of the endpoint.

          Possible values include:
          • "TELEPHONE_NUMBER"
          • "VOIP"
          • "CONTACT_FLOW"
        • Address — (String)

          Address of the endpoint.

      • RequestIdentifier — (String)

        Identifier to uniquely identify individual requests in the batch.

      • QueueId — (String)

        The identifier of the queue associated with the Amazon Connect instance in which contacts that are created will be queued.

      • Attributes — (map<String>)

        List of attributes to be stored in a contact.

      • Campaign — (map)

        Structure to store information associated with a campaign.

        • CampaignId — (String)

          A unique identifier for a campaign.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • SuccessfulRequestList — (Array<map>)

        List of requests for which contact was successfully created.

        • RequestIdentifier — (String)

          Request identifier provided in the API call in the ContactDataRequest to create a contact.

        • ContactId — (String)

          The contactId of the contact that was created successfully.

      • FailedRequestList — (Array<map>)

        List of requests for which contact creation failed.

        • RequestIdentifier — (String)

          Request identifier provided in the API call in the ContactDataRequest to create a contact.

        • FailureReasonCode — (String)

          Reason code for the failure.

          Possible values include:
          • "INVALID_ATTRIBUTE_KEY"
          • "INVALID_CUSTOMER_ENDPOINT"
          • "INVALID_SYSTEM_ENDPOINT"
          • "INVALID_QUEUE"
          • "MISSING_CAMPAIGN"
          • "MISSING_CUSTOMER_ENDPOINT"
          • "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT"
          • "REQUEST_THROTTLED"
          • "IDEMPOTENCY_EXCEPTION"
          • "INTERNAL_ERROR"
        • FailureReasonMessage — (String)

          Why the request to create a contact failed.

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.

For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

Service Reference:

Examples:

Calling the claimPhoneNumber operation

var params = {
  PhoneNumber: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  PhoneNumberDescription: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  TargetArn: 'STRING_VALUE'
};
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 number inbound traffic is routed through. You must enter InstanceId or TargetArn.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

    • 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 instance ID in the Amazon Resource Name (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 JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

      Length Constraints: Minimum length of 1. Maximum length of 256000.

    • 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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the flow module.

    • Description — (String)

      The description of the flow module.

    • Content — (String)

      The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

    • 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.

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

Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

Service Reference:

Examples:

Calling the createEvaluationForm operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Items: [ /* EvaluationFormItemsList */ /* required */
    {
      Question: {
        QuestionType: TEXT | SINGLESELECT | NUMERIC, /* required */
        RefId: 'STRING_VALUE', /* required */
        Title: 'STRING_VALUE', /* required */
        Instructions: 'STRING_VALUE',
        NotApplicableEnabled: true || false,
        QuestionTypeProperties: {
          Numeric: {
            MaxValue: 'NUMBER_VALUE', /* required */
            MinValue: 'NUMBER_VALUE', /* required */
            Automation: {
              PropertyValue: {
                Label: OVERALL_CUSTOMER_SENTIMENT_SCORE | OVERALL_AGENT_SENTIMENT_SCORE | NON_TALK_TIME | NON_TALK_TIME_PERCENTAGE | NUMBER_OF_INTERRUPTIONS | CONTACT_DURATION | AGENT_INTERACTION_DURATION | CUSTOMER_HOLD_TIME /* required */
              }
            },
            Options: [
              {
                MaxValue: 'NUMBER_VALUE', /* required */
                MinValue: 'NUMBER_VALUE', /* required */
                AutomaticFail: true || false,
                Score: 'NUMBER_VALUE'
              },
              /* more items */
            ]
          },
          SingleSelect: {
            Options: [ /* required */
              {
                RefId: 'STRING_VALUE', /* required */
                Text: 'STRING_VALUE', /* required */
                AutomaticFail: true || false,
                Score: 'NUMBER_VALUE'
              },
              /* more items */
            ],
            Automation: {
              Options: [ /* required */
                {
                  RuleCategory: {
                    Category: 'STRING_VALUE', /* required */
                    Condition: PRESENT | NOT_PRESENT, /* required */
                    OptionRefId: 'STRING_VALUE' /* required */
                  }
                },
                /* more items */
              ],
              DefaultOptionRefId: 'STRING_VALUE'
            },
            DisplayAs: DROPDOWN | RADIO
          }
        },
        Weight: 'NUMBER_VALUE'
      },
      Section: {
        Items: /* recursive EvaluationFormItemsList */,
        RefId: 'STRING_VALUE', /* required */
        Title: 'STRING_VALUE', /* required */
        Instructions: 'STRING_VALUE',
        Weight: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  Title: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ScoringStrategy: {
    Mode: QUESTION_ONLY | SECTION_ONLY, /* required */
    Status: ENABLED | DISABLED /* required */
  }
};
connect.createEvaluationForm(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Title — (String)

      A title of the evaluation form.

    • Description — (String)

      The description of the evaluation form.

    • Items — (Array<map>)

      Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

      • Section — (map)

        The information of the section.

        • Titlerequired — (String)

          The title of the section.

        • RefIdrequired — (String)

          The identifier of the section. An identifier must be unique within the evaluation form.

        • Instructions — (String)

          The instructions of the section.

        • Itemsrequired — (Array<map>)

          The items of the section.

        • Weight — (Float)

          The scoring weight of the section.

      • Question — (map)

        The information of the question.

        • Titlerequired — (String)

          The title of the question.

        • Instructions — (String)

          The instructions of the section.

        • RefIdrequired — (String)

          The identifier of the question. An identifier must be unique within the evaluation form.

        • NotApplicableEnabled — (Boolean)

          The flag to enable not applicable answers to the question.

        • QuestionTyperequired — (String)

          The type of the question.

          Possible values include:
          • "TEXT"
          • "SINGLESELECT"
          • "NUMERIC"
        • QuestionTypeProperties — (map)

          The properties of the type of question. Text questions do not have to define question type properties.

          • Numeric — (map)

            The properties of the numeric question.

            • MinValuerequired — (Integer)

              The minimum answer value.

            • MaxValuerequired — (Integer)

              The maximum answer value.

            • Options — (Array<map>)

              The scoring options of the numeric question.

              • MinValuerequired — (Integer)

                The minimum answer value of the range option.

              • MaxValuerequired — (Integer)

                The maximum answer value of the range option.

              • Score — (Integer)

                The score assigned to answer values within the range option.

              • AutomaticFail — (Boolean)

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

            • Automation — (map)

              The automation properties of the numeric question.

              • PropertyValue — (map)

                The property value of the automation.

                • Labelrequired — (String)

                  The property label of the automation.

                  Possible values include:
                  • "OVERALL_CUSTOMER_SENTIMENT_SCORE"
                  • "OVERALL_AGENT_SENTIMENT_SCORE"
                  • "NON_TALK_TIME"
                  • "NON_TALK_TIME_PERCENTAGE"
                  • "NUMBER_OF_INTERRUPTIONS"
                  • "CONTACT_DURATION"
                  • "AGENT_INTERACTION_DURATION"
                  • "CUSTOMER_HOLD_TIME"
          • SingleSelect — (map)

            The properties of the numeric question.

            • Optionsrequired — (Array<map>)

              The answer options of the single select question.

              • RefIdrequired — (String)

                The identifier of the answer option. An identifier must be unique within the question.

              • Textrequired — (String)

                The title of the answer option.

              • Score — (Integer)

                The score assigned to the answer option.

              • AutomaticFail — (Boolean)

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

            • DisplayAs — (String)

              The display mode of the single select question.

              Possible values include:
              • "DROPDOWN"
              • "RADIO"
            • Automation — (map)

              The display mode of the single select question.

              • Optionsrequired — (Array<map>)

                The automation options of the single select question.

                • RuleCategory — (map)

                  The automation option based on a rule category for the single select question.

                  • Categoryrequired — (String)

                    The category name, as defined in Rules.

                  • Conditionrequired — (String)

                    The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                    Possible values include:
                    • "PRESENT"
                    • "NOT_PRESENT"
                  • OptionRefIdrequired — (String)

                    The identifier of the answer option.

              • DefaultOptionRefId — (String)

                The identifier of the default answer option, when none of the automation options match the criteria.

        • Weight — (Float)

          The scoring weight of the section.

    • ScoringStrategy — (map)

      A scoring strategy of the evaluation form.

      • Moderequired — (String)

        The scoring mode of the evaluation form.

        Possible values include:
        • "QUESTION_ONLY"
        • "SECTION_ONLY"
      • Statusrequired — (String)

        The scoring status of the evaluation form.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • 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:

      • EvaluationFormId — (String)

        The unique identifier for the evaluation form.

      • EvaluationFormArn — (String)

        The Amazon Resource Name (ARN) for the evaluation form resource.

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 instance ID in the Amazon Resource Name (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',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "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 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 | WISDOM_QUICK_RESPONSES | CASES_DOMAIN | APPLICATION | FILE_SCANNER, /* required */
  SourceApplicationName: 'STRING_VALUE',
  SourceApplicationUrl: 'STRING_VALUE',
  SourceType: SALESFORCE | ZENDESK | CASES,
  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 instance ID in the Amazon Resource Name (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"
      • "WISDOM_QUICK_RESPONSES"
      • "CASES_DOMAIN"
      • "APPLICATION"
      • "FILE_SCANNER"
    • 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"
      • "CASES"
    • 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.

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

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

Service Reference:

Examples:

Calling the createParticipant operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ParticipantDetails: { /* required */
    DisplayName: 'STRING_VALUE',
    ParticipantRole: AGENT | CUSTOMER | SYSTEM | CUSTOM_BOT | SUPERVISOR
  },
  ClientToken: 'STRING_VALUE'
};
connect.createParticipant(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactId — (String)

      The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

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

      Information identifying the participant.

      The only Valid value for ParticipantRole is CUSTOM_BOT.

      DisplayName is Required.

      • ParticipantRole — (String)

        The role of the participant being added.

        Possible values include:
        • "AGENT"
        • "CUSTOMER"
        • "SYSTEM"
        • "CUSTOM_BOT"
        • "SUPERVISOR"
      • DisplayName — (String)

        The display name of the participant.

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:

      • ParticipantCredentials — (map)

        The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

        • ParticipantToken — (String)

          The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

        • Expiry — (String)

          The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

      • ParticipantId — (String)

        The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

Returns:

  • (AWS.Request)

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

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

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.

Examples:

Calling the createPersistentContactAssociation operation

var params = {
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  RehydrationType: ENTIRE_PAST_SESSION | FROM_SEGMENT, /* required */
  SourceContactId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.createPersistentContactAssociation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • InitialContactId — (String)

      This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

    • RehydrationType — (String)

      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      Possible values include:
      • "ENTIRE_PAST_SESSION"
      • "FROM_SEGMENT"
    • SourceContactId — (String)

      The contactId from which a persistent chat session must be started.

    • 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.

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:

      • ContinuedFromContactId — (String)

        The contactId from which a persistent chat session is started. This field is populated only for persistent chat.

Returns:

  • (AWS.Request)

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

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

Creates a new predefined attribute for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the createPredefinedAttribute operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Values: { /* required */
    StringList: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
connect.createPredefinedAttribute(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the predefined attribute.

    • Values — (map)

      The values of the predefined attribute.

      • StringList — (Array<String>)

        Predefined attribute values of type string 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.

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

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator's Guide.

Service Reference:

Examples:

Calling the createPrompt operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  S3Uri: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createPrompt(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the prompt.

    • Description — (String)

      The description of the prompt.

    • S3Uri — (String)

      The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

    • 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:

      • PromptARN — (String)

        The Amazon Resource Name (ARN) of the prompt.

      • PromptId — (String)

        A unique identifier for the prompt.

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 phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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.

  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      A unique 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 admin website, 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 */
      CrossChannelBehavior: {
        BehaviorType: ROUTE_CURRENT_CHANNEL_ONLY | ROUTE_ANY_CHANNEL /* required */
      }
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  AgentAvailabilityTimer: TIME_SINCE_LAST_ACTIVITY | TIME_SINCE_LAST_INBOUND,
  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 instance ID in the Amazon Resource Name (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.

      The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.

      • 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.

      • CrossChannelBehavior — (map)

        Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.

        • BehaviorTyperequired — (String)

          Specifies the other channels that can be routed to an agent handling their current channel.

          Possible values include:
          • "ROUTE_CURRENT_CHANNEL_ONLY"
          • "ROUTE_ANY_CHANNEL"
    • Tags — (map<String>)

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

    • AgentAvailabilityTimer — (String)

      Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.

      Possible values include:
      • "TIME_SINCE_LAST_ACTIVITY"
      • "TIME_SINCE_LAST_INBOUND"

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.

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

Creates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

Service Reference:

Examples:

Calling the createRule operation

var params = {
  Actions: [ /* required */
    {
      ActionType: CREATE_TASK | ASSIGN_CONTACT_CATEGORY | GENERATE_EVENTBRIDGE_EVENT | SEND_NOTIFICATION | CREATE_CASE | UPDATE_CASE | END_ASSOCIATED_TASKS, /* required */
      AssignContactCategoryAction: {
      },
      CreateCaseAction: {
        Fields: [ /* required */
          {
            Id: 'STRING_VALUE', /* required */
            Value: { /* required */
              BooleanValue: true || false,
              DoubleValue: 'NUMBER_VALUE',
              EmptyValue: {
              },
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        TemplateId: 'STRING_VALUE' /* required */
      },
      EndAssociatedTasksAction: {
      },
      EventBridgeAction: {
        Name: 'STRING_VALUE' /* required */
      },
      SendNotificationAction: {
        Content: 'STRING_VALUE', /* required */
        ContentType: PLAIN_TEXT, /* required */
        DeliveryMethod: EMAIL, /* required */
        Recipient: { /* required */
          UserIds: [
            'STRING_VALUE',
            /* more items */
          ],
          UserTags: {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          }
        },
        Subject: 'STRING_VALUE'
      },
      TaskAction: {
        ContactFlowId: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        Description: 'STRING_VALUE',
        References: {
          '<ReferenceKey>': {
            Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* '<ReferenceKey>': ... */
        }
      },
      UpdateCaseAction: {
        Fields: [ /* required */
          {
            Id: 'STRING_VALUE', /* required */
            Value: { /* required */
              BooleanValue: true || false,
              DoubleValue: 'NUMBER_VALUE',
              EmptyValue: {
              },
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  Function: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  PublishStatus: DRAFT | PUBLISHED, /* required */
  TriggerEventSource: { /* required */
    EventSourceName: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate | OnCaseCreate | OnCaseUpdate, /* required */
    IntegrationAssociationId: 'STRING_VALUE'
  },
  ClientToken: 'STRING_VALUE'
};
connect.createRule(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      A unique name for the rule.

    • TriggerEventSource — (map)

      The event source to trigger the rule.

      • EventSourceNamerequired — (String)

        The name of the event source.

        Possible values include:
        • "OnPostCallAnalysisAvailable"
        • "OnRealTimeCallAnalysisAvailable"
        • "OnRealTimeChatAnalysisAvailable"
        • "OnPostChatAnalysisAvailable"
        • "OnZendeskTicketCreate"
        • "OnZendeskTicketStatusUpdate"
        • "OnSalesforceCaseCreate"
        • "OnContactEvaluationSubmit"
        • "OnMetricDataUpdate"
        • "OnCaseCreate"
        • "OnCaseUpdate"
      • IntegrationAssociationId — (String)

        The identifier for the integration association.

    • Function — (String)

      The conditions of the rule.

    • Actions — (Array<map>)

      A list of actions to be run when the rule is triggered.

      • ActionTyperequired — (String)

        The type of action that creates a rule.

        Possible values include:
        • "CREATE_TASK"
        • "ASSIGN_CONTACT_CATEGORY"
        • "GENERATE_EVENTBRIDGE_EVENT"
        • "SEND_NOTIFICATION"
        • "CREATE_CASE"
        • "UPDATE_CASE"
        • "END_ASSOCIATED_TASKS"
      • TaskAction — (map)

        Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

        • Namerequired — (String)

          The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • Description — (String)

          The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • ContactFlowIdrequired — (String)

          The identifier of the flow.

        • References — (map<map>)

          Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)

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

        Information about the EventBridge action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

        • Namerequired — (String)

          The name.

      • AssignContactCategoryAction — (map)

        Information about the contact category action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

      • SendNotificationAction — (map)

        Information about the send notification action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

        • DeliveryMethodrequired — (String)

          Notification delivery method.

          Possible values include:
          • "EMAIL"
        • Subject — (String)

          The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • Contentrequired — (String)

          Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • ContentTyperequired — (String)

          Content type format.

          Possible values include:
          • "PLAIN_TEXT"
        • Recipientrequired — (map)

          Notification recipient.

          • UserTags — (map<String>)

            The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }. Amazon Connect users with the specified tags will be notified.

          • UserIds — (Array<String>)

            A list of user IDs.

      • CreateCaseAction — (map)

        Information about the create case action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.

        • Fieldsrequired — (Array<map>)

          An array of objects with Field ID and Value data.

          • Idrequired — (String)

            Unique identifier of a field.

          • Valuerequired — (map)

            Union of potential field value types.

            • BooleanValue — (Boolean)

              A Boolean number value type.

            • DoubleValue — (Float)

              a Double number value type.

            • EmptyValue — (map)

              An empty value.

            • StringValue — (String)

              String value type.

        • TemplateIdrequired — (String)

          A unique identifier of a template.

      • UpdateCaseAction — (map)

        Information about the update case action.

        Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.

        • Fieldsrequired — (Array<map>)

          An array of objects with Field ID and Value data.

          • Idrequired — (String)

            Unique identifier of a field.

          • Valuerequired — (map)

            Union of potential field value types.

            • BooleanValue — (Boolean)

              A Boolean number value type.

            • DoubleValue — (Float)

              a Double number value type.

            • EmptyValue — (map)

              An empty value.

            • StringValue — (String)

              String value type.

      • EndAssociatedTasksAction — (map)

        Information about the end associated tasks action.

        Supported only for TriggerEventSource values: OnCaseUpdate.

    • PublishStatus — (String)

      The publish status of the rule.

      Possible values include:
      • "DRAFT"
      • "PUBLISHED"
    • 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:

      • RuleArn — (String)

        The Amazon Resource Name (ARN) of the rule.

      • RuleId — (String)

        A unique identifier for the rule.

Returns:

  • (AWS.Request)

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

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

Creates a security profile.

Service Reference:

Examples:

Calling the createSecurityProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileName: 'STRING_VALUE', /* required */
  AllowedAccessControlHierarchyGroupId: 'STRING_VALUE',
  AllowedAccessControlTags: {
    '<SecurityProfilePolicyKey>': 'STRING_VALUE',
    /* '<SecurityProfilePolicyKey>': ... */
  },
  Applications: [
    {
      ApplicationPermissions: [
        'STRING_VALUE',
        /* more items */
      ],
      Namespace: 'STRING_VALUE'
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  HierarchyRestrictedResources: [
    'STRING_VALUE',
    /* more items */
  ],
  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 instance ID in the Amazon Resource Name (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. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

    • Applications — (Array<map>)

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

      A list of third-party applications that the security profile will give access to.

      • Namespace — (String)

        Namespace of the application that you want to give access to.

      • ApplicationPermissions — (Array<String>)

        The permissions that the agent is granted on the application. Only the ACCESS permission is supported.

    • HierarchyRestrictedResources — (Array<String>)

      The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

    • AllowedAccessControlHierarchyGroupId — (String)

      The identifier of the hierarchy group that a security profile uses to restrict access to resources 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 instance ID in the Amazon Resource Name (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.

Note: The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

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 instance ID in the Amazon Resource Name (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.

Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

For information about how to create users using the Amazon Connect admin website, 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_-.\@]+.

      Username can include @ only if used in an email format. For example:

    • 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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

        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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Creates a new view with the possible status of SAVED or PUBLISHED.

The views will have a unique name for each connect instance.

It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Service Reference:

Examples:

Calling the createView operation

var params = {
  Content: { /* required */
    Actions: [
      'STRING_VALUE',
      /* more items */
    ],
    Template: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Status: PUBLISHED | SAVED, /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createView(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.

    • ClientToken — (String)

      A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.

    • Status — (String)

      Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

      Possible values include:
      • "PUBLISHED"
      • "SAVED"
    • Content — (map)

      View content containing all content necessary to render a view except for runtime input data.

      The total uncompressed content has a maximum file size of 400kB.

      • Template — (String)

        The view template representing the structure of the view.

      • Actions — (Array<String>)

        A list of possible actions from the view.

    • Description — (String)

      The description of the view.

    • Name — (String)

      The name of the view.

    • Tags — (map<String>)

      The tags associated with the view resource (not specific to view version).These tags can be 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:

      • View — (map)

        A view resource object. Contains metadata and content necessary to render the view.

        • Id — (String)

          The identifier of the view.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the view.

        • Name — (String)

          The name of the view.

        • Status — (String)

          Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

          Possible values include:
          • "PUBLISHED"
          • "SAVED"
        • Type — (String)

          The type of the view - CUSTOMER_MANAGED.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_MANAGED"
        • Description — (String)

          The description of the view.

        • Version — (Integer)

          Current version of the view.

        • VersionDescription — (String)

          The description of the version.

        • Content — (map)

          View content containing all content necessary to render a view except for runtime input data.

          • InputSchema — (String)

            The data schema matching data that the view template must be provided to render.

          • Template — (String)

            The view template representing the structure of the view.

          • Actions — (Array<String>)

            A list of possible actions from the view.

        • Tags — (map<String>)

          The tags associated with the view resource (not specific to view version).

        • CreatedTime — (Date)

          The timestamp of when the view was created.

        • LastModifiedTime — (Date)

          Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

        • ViewContentSha256 — (String)

          Indicates the checksum value of the latest published view content.

Returns:

  • (AWS.Request)

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

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

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

Service Reference:

Examples:

Calling the createViewVersion operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ViewId: 'STRING_VALUE', /* required */
  VersionDescription: 'STRING_VALUE',
  ViewContentSha256: 'STRING_VALUE'
};
connect.createViewVersion(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.

    • ViewId — (String)

      The identifier of the view. Both ViewArn and ViewId can be used.

    • VersionDescription — (String)

      The description for the version being published.

    • ViewContentSha256 — (String)

      Indicates the checksum value of the latest published view content.

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:

      • View — (map)

        All view data is contained within the View object.

        • Id — (String)

          The identifier of the view.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the view.

        • Name — (String)

          The name of the view.

        • Status — (String)

          Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

          Possible values include:
          • "PUBLISHED"
          • "SAVED"
        • Type — (String)

          The type of the view - CUSTOMER_MANAGED.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_MANAGED"
        • Description — (String)

          The description of the view.

        • Version — (Integer)

          Current version of the view.

        • VersionDescription — (String)

          The description of the version.

        • Content — (map)

          View content containing all content necessary to render a view except for runtime input data.

          • InputSchema — (String)

            The data schema matching data that the view template must be provided to render.

          • Template — (String)

            The view template representing the structure of the view.

          • Actions — (Array<String>)

            A list of possible actions from the view.

        • Tags — (map<String>)

          The tags associated with the view resource (not specific to view version).

        • CreatedTime — (Date)

          The timestamp of when the view was created.

        • LastModifiedTime — (Date)

          Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

        • ViewContentSha256 — (String)

          Indicates the checksum value of the latest published view content.

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 | en-NZ | en-ZA, /* 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 instance ID in the Amazon Resource Name (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"
      • "en-NZ"
      • "en-ZA"
    • 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.

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

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

Service Reference:

Examples:

Calling the deactivateEvaluationForm operation

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  EvaluationFormVersion: 'NUMBER_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deactivateEvaluationForm(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • EvaluationFormVersion — (Integer)

      A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.

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:

      • EvaluationFormId — (String)

        The unique identifier for the evaluation form.

      • EvaluationFormArn — (String)

        The Amazon Resource Name (ARN) for the evaluation form resource.

      • EvaluationFormVersion — (Integer)

        The version of the deactivated evaluation form resource.

Returns:

  • (AWS.Request)

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

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

Deletes a contact evaluation in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the deleteContactEvaluation operation

var params = {
  EvaluationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteContactEvaluation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationId — (String)

      A unique identifier for the contact evaluation.

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.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Deletes an evaluation form in the specified Amazon Connect instance.

  • If the version property is provided, only the specified version of the evaluation form is deleted.

  • If no version is provided, then the full form (all versions) is deleted.

Service Reference:

Examples:

Calling the deleteEvaluationForm operation

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  EvaluationFormVersion: 'NUMBER_VALUE'
};
connect.deleteEvaluationForm(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • EvaluationFormVersion — (Integer)

      The unique identifier for the evaluation form.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Deletes a predefined attribute from the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the deletePredefinedAttribute operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
connect.deletePredefinedAttribute(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the predefined attribute.

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.

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

Deletes a prompt.

Service Reference:

Examples:

Calling the deletePrompt operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PromptId: 'STRING_VALUE' /* required */
};
connect.deletePrompt(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PromptId — (String)

      A unique identifier for the prompt.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes a queue.

Service Reference:

Examples:

Calling the deleteQueue operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE' /* required */
};
connect.deleteQueue(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 instance ID in the Amazon Resource Name (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.

Returns:

  • (AWS.Request)

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

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

Deletes a quick connect.

After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

  • Avoid dangling resources that impact your service quotas.

  • Remove deleted users so they don't appear to agents as transfer options.

  • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

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 instance ID in the Amazon Resource Name (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.

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

Deletes a routing profile.

Service Reference:

Examples:

Calling the deleteRoutingProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.deleteRoutingProfile(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 instance ID in the Amazon Resource Name (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.

Returns:

  • (AWS.Request)

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

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

Deletes a rule for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the deleteRule operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  RuleId: 'STRING_VALUE' /* required */
};
connect.deleteRule(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RuleId — (String)

      A unique identifier for the rule.

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

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

  • Avoid dangling resources that impact your service quotas.

  • Remove deleted users so they don't appear to agents as transfer options.

  • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

Service Reference:

Examples:

Calling the deleteView operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ViewId: 'STRING_VALUE' /* required */
};
connect.deleteView(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.

    • ViewId — (String)

      The identifier of the view. Both ViewArn and ViewId can be used.

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.

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

Deletes the particular version specified in ViewVersion identifier.

Service Reference:

Examples:

Calling the deleteViewVersion operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ViewId: 'STRING_VALUE', /* required */
  ViewVersion: 'NUMBER_VALUE' /* required */
};
connect.deleteViewVersion(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.

    • ViewId — (String)

      The identifier of the view. Both ViewArn and ViewId can be used.

    • ViewVersion — (Integer)

      The version number of the view.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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"
          • "DISCONNECT"
          • "MONITOR"
          • "EXTERNAL_OUTBOUND"
        • 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.

          • AgentPauseDurationInSeconds — (Integer)

            Agent pause duration for a contact in seconds.

        • 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. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

        • DisconnectTimestamp — (Date)

          The timestamp when the customer endpoint disconnected from Amazon Connect.

        • LastUpdateTimestamp — (Date)

          The timestamp when contact was last updated.

        • LastPausedTimestamp — (Date)

          The timestamp when the contact was last paused.

        • LastResumedTimestamp — (Date)

          The timestamp when the contact was last resumed.

        • TotalPauseCount — (Integer)

          Total pause count for a contact.

        • TotalPauseDurationInSeconds — (Integer)

          Total pause duration for a contact in seconds.

        • ScheduledTimestamp — (Date)

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

        • RelatedContactId — (String)

          The contactId that is related to this contact.

        • WisdomInfo — (map)

          Information about Amazon Connect Wisdom.

          • SessionArn — (String)

            The Amazon Resource Name (ARN) of the Wisdom session.

        • QueueTimeAdjustmentSeconds — (Integer)

          An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

        • QueuePriority — (Integer)

          An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

        • Tags — (map<String>)

          Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

Returns:

  • (AWS.Request)

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

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

Describes a contact evaluation in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the describeContactEvaluation operation

var params = {
  EvaluationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.describeContactEvaluation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationId — (String)

      A unique identifier for the contact evaluation.

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:

      • Evaluation — (map)

        Information about the evaluation form completed for a specific contact.

        • EvaluationIdrequired — (String)

          A unique identifier for the contact evaluation.

        • EvaluationArnrequired — (String)

          The Amazon Resource Name (ARN) for the contact evaluation resource.

        • Metadatarequired — (map)

          Metadata about the contact evaluation.

          • ContactIdrequired — (String)

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

          • EvaluatorArnrequired — (String)

            The Amazon Resource Name (ARN) of the user who last updated the evaluation.

          • ContactAgentId — (String)

            The identifier of the agent who performed the contact.

          • Score — (map)

            The overall score of the contact evaluation.

            • Percentage — (Float)

              The score percentage for an item in a contact evaluation.

            • NotApplicable — (Boolean)

              The flag to mark the item as not applicable for scoring.

            • AutomaticFail — (Boolean)

              The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.

        • Answersrequired — (map<map>)

          A map of question identifiers to answer value.

          • Value — (map)

            The value for an answer in a contact evaluation.

            • StringValue — (String)

              The string value for an answer in a contact evaluation.

            • NumericValue — (Float)

              The numeric value for an answer in a contact evaluation.

            • NotApplicable — (Boolean)

              The flag to mark the question as not applicable.

          • SystemSuggestedValue — (map)

            The system suggested value for an answer in a contact evaluation.

            • StringValue — (String)

              The string value for an answer in a contact evaluation.

            • NumericValue — (Float)

              The numeric value for an answer in a contact evaluation.

            • NotApplicable — (Boolean)

              The flag to mark the question as not applicable.

        • Notesrequired — (map<map>)

          A map of question identifiers to note value.

          • Value — (String)

            The note for an item (section or question) in a contact evaluation.

            Note: Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
        • Statusrequired — (String)

          The status of the contact evaluation.

          Possible values include:
          • "DRAFT"
          • "SUBMITTED"
        • Scores — (map<map>)

          A map of item (section or question) identifiers to score value.

          • Percentage — (Float)

            The score percentage for an item in a contact evaluation.

          • NotApplicable — (Boolean)

            The flag to mark the item as not applicable for scoring.

          • AutomaticFail — (Boolean)

            The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.

        • CreatedTimerequired — (Date)

          The timestamp for when the evaluation was created.

        • LastModifiedTimerequired — (Date)

          The timestamp for when the evaluation was last updated.

        • Tags — (map<String>)

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

      • EvaluationForm — (map)

        Information about the evaluation form.

        • EvaluationFormVersionrequired — (Integer)

          A version of the evaluation form.

        • EvaluationFormIdrequired — (String)

          The unique identifier for the evaluation form.

        • EvaluationFormArnrequired — (String)

          The Amazon Resource Name (ARN) for the evaluation form resource.

        • Titlerequired — (String)

          A title of the evaluation form.

        • Description — (String)

          The description of the evaluation form.

        • Itemsrequired — (Array<map>)

          Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

          • Section — (map)

            The information of the section.

            • Titlerequired — (String)

              The title of the section.

            • RefIdrequired — (String)

              The identifier of the section. An identifier must be unique within the evaluation form.

            • Instructions — (String)

              The instructions of the section.

            • Weight — (Float)

              The scoring weight of the section.

          • Question — (map)

            The information of the question.

            • Titlerequired — (String)

              The title of the question.

            • Instructions — (String)

              The instructions of the section.

            • RefIdrequired — (String)

              The identifier of the question. An identifier must be unique within the evaluation form.

            • NotApplicableEnabled — (Boolean)

              The flag to enable not applicable answers to the question.

            • QuestionTyperequired — (String)

              The type of the question.

              Possible values include:
              • "TEXT"
              • "SINGLESELECT"
              • "NUMERIC"
            • QuestionTypeProperties — (map)

              The properties of the type of question. Text questions do not have to define question type properties.

              • Numeric — (map)

                The properties of the numeric question.

                • MinValuerequired — (Integer)

                  The minimum answer value.

                • MaxValuerequired — (Integer)

                  The maximum answer value.

                • Options — (Array<map>)

                  The scoring options of the numeric question.

                  • MinValuerequired — (Integer)

                    The minimum answer value of the range option.

                  • MaxValuerequired — (Integer)

                    The maximum answer value of the range option.

                  • Score — (Integer)

                    The score assigned to answer values within the range option.

                  • AutomaticFail — (Boolean)

                    The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                • Automation — (map)

                  The automation properties of the numeric question.

                  • PropertyValue — (map)

                    The property value of the automation.

                    • Labelrequired — (String)

                      The property label of the automation.

                      Possible values include:
                      • "OVERALL_CUSTOMER_SENTIMENT_SCORE"
                      • "OVERALL_AGENT_SENTIMENT_SCORE"
                      • "NON_TALK_TIME"
                      • "NON_TALK_TIME_PERCENTAGE"
                      • "NUMBER_OF_INTERRUPTIONS"
                      • "CONTACT_DURATION"
                      • "AGENT_INTERACTION_DURATION"
                      • "CUSTOMER_HOLD_TIME"
              • SingleSelect — (map)

                The properties of the numeric question.

                • Optionsrequired — (Array<map>)

                  The answer options of the single select question.

                  • RefIdrequired — (String)

                    The identifier of the answer option. An identifier must be unique within the question.

                  • Textrequired — (String)

                    The title of the answer option.

                  • Score — (Integer)

                    The score assigned to the answer option.

                  • AutomaticFail — (Boolean)

                    The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                • DisplayAs — (String)

                  The display mode of the single select question.

                  Possible values include:
                  • "DROPDOWN"
                  • "RADIO"
                • Automation — (map)

                  The display mode of the single select question.

                  • Optionsrequired — (Array<map>)

                    The automation options of the single select question.

                    • RuleCategory — (map)

                      The automation option based on a rule category for the single select question.

                      • Categoryrequired — (String)

                        The category name, as defined in Rules.

                      • Conditionrequired — (String)

                        The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                        Possible values include:
                        • "PRESENT"
                        • "NOT_PRESENT"
                      • OptionRefIdrequired — (String)

                        The identifier of the answer option.

                  • DefaultOptionRefId — (String)

                    The identifier of the default answer option, when none of the automation options match the criteria.

            • Weight — (Float)

              The scoring weight of the section.

        • ScoringStrategy — (map)

          A scoring strategy of the evaluation form.

          • Moderequired — (String)

            The scoring mode of the evaluation form.

            Possible values include:
            • "QUESTION_ONLY"
            • "SECTION_ONLY"
          • Statusrequired — (String)

            The scoring status of the evaluation form.

            Possible values include:
            • "ENABLED"
            • "DISABLED"

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 JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

          Length Constraints: Minimum length of 1. Maximum length of 256000.

        • 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 instance ID in the Amazon Resource Name (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 JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

        • 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.

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

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

Service Reference:

Examples:

Calling the describeEvaluationForm operation

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  EvaluationFormVersion: 'NUMBER_VALUE'
};
connect.describeEvaluationForm(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationFormId — (String)

      A unique identifier for the contact evaluation.

    • EvaluationFormVersion — (Integer)

      A version of the evaluation form.

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:

      • EvaluationForm — (map)

        Information about the evaluation form.

        • EvaluationFormIdrequired — (String)

          The unique identifier for the evaluation form.

        • EvaluationFormVersionrequired — (Integer)

          A version of the evaluation form.

        • Lockedrequired — (Boolean)

          The flag indicating whether the evaluation form is locked for changes.

        • EvaluationFormArnrequired — (String)

          The Amazon Resource Name (ARN) for the evaluation form resource.

        • Titlerequired — (String)

          A title of the evaluation form.

        • Description — (String)

          The description of the evaluation form.

        • Statusrequired — (String)

          The status of the evaluation form.

          Possible values include:
          • "DRAFT"
          • "ACTIVE"
        • Itemsrequired — (Array<map>)

          Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

          • Section — (map)

            The information of the section.

            • Titlerequired — (String)

              The title of the section.

            • RefIdrequired — (String)

              The identifier of the section. An identifier must be unique within the evaluation form.

            • Instructions — (String)

              The instructions of the section.

            • Weight — (Float)

              The scoring weight of the section.

          • Question — (map)

            The information of the question.

            • Titlerequired — (String)

              The title of the question.

            • Instructions — (String)

              The instructions of the section.

            • RefIdrequired — (String)

              The identifier of the question. An identifier must be unique within the evaluation form.

            • NotApplicableEnabled — (Boolean)

              The flag to enable not applicable answers to the question.

            • QuestionTyperequired — (String)

              The type of the question.

              Possible values include:
              • "TEXT"
              • "SINGLESELECT"
              • "NUMERIC"
            • QuestionTypeProperties — (map)

              The properties of the type of question. Text questions do not have to define question type properties.

              • Numeric — (map)

                The properties of the numeric question.

                • MinValuerequired — (Integer)

                  The minimum answer value.

                • MaxValuerequired — (Integer)

                  The maximum answer value.

                • Options — (Array<map>)

                  The scoring options of the numeric question.

                  • MinValuerequired — (Integer)

                    The minimum answer value of the range option.

                  • MaxValuerequired — (Integer)

                    The maximum answer value of the range option.

                  • Score — (Integer)

                    The score assigned to answer values within the range option.

                  • AutomaticFail — (Boolean)

                    The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                • Automation — (map)

                  The automation properties of the numeric question.

                  • PropertyValue — (map)

                    The property value of the automation.

                    • Labelrequired — (String)

                      The property label of the automation.

                      Possible values include:
                      • "OVERALL_CUSTOMER_SENTIMENT_SCORE"
                      • "OVERALL_AGENT_SENTIMENT_SCORE"
                      • "NON_TALK_TIME"
                      • "NON_TALK_TIME_PERCENTAGE"
                      • "NUMBER_OF_INTERRUPTIONS"
                      • "CONTACT_DURATION"
                      • "AGENT_INTERACTION_DURATION"
                      • "CUSTOMER_HOLD_TIME"
              • SingleSelect — (map)

                The properties of the numeric question.

                • Optionsrequired — (Array<map>)

                  The answer options of the single select question.

                  • RefIdrequired — (String)

                    The identifier of the answer option. An identifier must be unique within the question.

                  • Textrequired — (String)

                    The title of the answer option.

                  • Score — (Integer)

                    The score assigned to the answer option.

                  • AutomaticFail — (Boolean)

                    The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                • DisplayAs — (String)

                  The display mode of the single select question.

                  Possible values include:
                  • "DROPDOWN"
                  • "RADIO"
                • Automation — (map)

                  The display mode of the single select question.

                  • Optionsrequired — (Array<map>)

                    The automation options of the single select question.

                    • RuleCategory — (map)

                      The automation option based on a rule category for the single select question.

                      • Categoryrequired — (String)

                        The category name, as defined in Rules.

                      • Conditionrequired — (String)

                        The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                        Possible values include:
                        • "PRESENT"
                        • "NOT_PRESENT"
                      • OptionRefIdrequired — (String)

                        The identifier of the answer option.

                  • DefaultOptionRefId — (String)

                    The identifier of the default answer option, when none of the automation options match the criteria.

            • Weight — (Float)

              The scoring weight of the section.

        • ScoringStrategy — (map)

          A scoring strategy of the evaluation form.

          • Moderequired — (String)

            The scoring mode of the evaluation form.

            Possible values include:
            • "QUESTION_ONLY"
            • "SECTION_ONLY"
          • Statusrequired — (String)

            The scoring status of the evaluation form.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
        • CreatedTimerequired — (Date)

          The timestamp for when the evaluation form was created.

        • CreatedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who created the evaluation form.

        • LastModifiedTimerequired — (Date)

          The timestamp for when the evaluation form was last updated.

        • LastModifiedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

        • 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 instance ID in the Amazon Resource Name (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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

        • InstanceAccessUrl — (String)

          This URL allows contact center users to access the Amazon Connect admin website.

        • Tags — (map<String>)

          The tags of an instance.

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 | ENHANCED_CHAT_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 instance ID in the Amazon Resource Name (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"
      • "ENHANCED_CHAT_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"
          • "ENHANCED_CHAT_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 | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_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 instance ID in the Amazon Resource Name (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"
      • "ATTACHMENTS"
      • "CONTACT_EVALUATIONS"
      • "SCREEN_RECORDINGS"
      • "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_VOICE_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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
        • 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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
        • 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"
          • "UIFN"
          • "SHARED"
          • "THIRD_PARTY_TF"
          • "THIRD_PARTY_DID"
          • "SHORT_CODE"
        • 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 number inbound traffic is routed through.

        • InstanceId — (String)

          The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

        • 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 ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

          • IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata 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 ClaimPhoneNumber 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.

        • SourcePhoneNumberArn — (String)

          The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

Returns:

  • (AWS.Request)

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

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

Describes a predefined attribute for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the describePredefinedAttribute operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
connect.describePredefinedAttribute(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the predefined attribute.

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:

      • PredefinedAttribute — (map)

        Information about the predefined attribute.

        • Name — (String)

          The name of the predefined attribute.

        • Values — (map)

          The values of the predefined attribute.

          • StringList — (Array<String>)

            Predefined attribute values of type string list.

        • LastModifiedTime — (Date)

          Last modified time.

        • LastModifiedRegion — (String)

          Last modified region.

Returns:

  • (AWS.Request)

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

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

Describes the prompt.

Service Reference:

Examples:

Calling the describePrompt operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PromptId: 'STRING_VALUE' /* required */
};
connect.describePrompt(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PromptId — (String)

      A unique identifier for the prompt.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Prompt — (map)

        Information about the prompt.

        • PromptARN — (String)

          The Amazon Resource Name (ARN) of the prompt.

        • PromptId — (String)

          A unique identifier for the prompt.

        • Name — (String)

          The name of the prompt.

        • Description — (String)

          The description of the prompt.

        • Tags — (map<String>)

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

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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 admin website, 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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

          • CrossChannelBehavior — (map)

            Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.

            • BehaviorTyperequired — (String)

              Specifies the other channels that can be routed to an agent handling their current channel.

              Possible values include:
              • "ROUTE_CURRENT_CHANNEL_ONLY"
              • "ROUTE_ANY_CHANNEL"
        • 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.

        • AgentAvailabilityTimer — (String)

          Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

          Possible values include:
          • "TIME_SINCE_LAST_ACTIVITY"
          • "TIME_SINCE_LAST_INBOUND"
        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

        • IsDefault — (Boolean)

          Whether this a default routing profile.

Returns:

  • (AWS.Request)

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

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

Describes a rule for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the describeRule operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  RuleId: 'STRING_VALUE' /* required */
};
connect.describeRule(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RuleId — (String)

      A unique identifier for the rule.

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:

      • Rule — (map)

        Information about the rule.

        • Namerequired — (String)

          The name of the rule.

        • RuleIdrequired — (String)

          A unique identifier for the rule.

        • RuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the rule.

        • TriggerEventSourcerequired — (map)

          The event source to trigger the rule.

          • EventSourceNamerequired — (String)

            The name of the event source.

            Possible values include:
            • "OnPostCallAnalysisAvailable"
            • "OnRealTimeCallAnalysisAvailable"
            • "OnRealTimeChatAnalysisAvailable"
            • "OnPostChatAnalysisAvailable"
            • "OnZendeskTicketCreate"
            • "OnZendeskTicketStatusUpdate"
            • "OnSalesforceCaseCreate"
            • "OnContactEvaluationSubmit"
            • "OnMetricDataUpdate"
            • "OnCaseCreate"
            • "OnCaseUpdate"
          • IntegrationAssociationId — (String)

            The identifier for the integration association.

        • Functionrequired — (String)

          The conditions of the rule.

        • Actionsrequired — (Array<map>)

          A list of actions to be run when the rule is triggered.

          • ActionTyperequired — (String)

            The type of action that creates a rule.

            Possible values include:
            • "CREATE_TASK"
            • "ASSIGN_CONTACT_CATEGORY"
            • "GENERATE_EVENTBRIDGE_EVENT"
            • "SEND_NOTIFICATION"
            • "CREATE_CASE"
            • "UPDATE_CASE"
            • "END_ASSOCIATED_TASKS"
          • TaskAction — (map)

            Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

            • Namerequired — (String)

              The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

            • Description — (String)

              The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

            • ContactFlowIdrequired — (String)

              The identifier of the flow.

            • References — (map<map>)

              Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)

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

            Information about the EventBridge action.

            Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

            • Namerequired — (String)

              The name.

          • AssignContactCategoryAction — (map)

            Information about the contact category action.

            Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

          • SendNotificationAction — (map)

            Information about the send notification action.

            Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

            • DeliveryMethodrequired — (String)

              Notification delivery method.

              Possible values include:
              • "EMAIL"
            • Subject — (String)

              The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

            • Contentrequired — (String)

              Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

            • ContentTyperequired — (String)

              Content type format.

              Possible values include:
              • "PLAIN_TEXT"
            • Recipientrequired — (map)

              Notification recipient.

              • UserTags — (map<String>)

                The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }. Amazon Connect users with the specified tags will be notified.

              • UserIds — (Array<String>)

                A list of user IDs.

          • CreateCaseAction — (map)

            Information about the create case action.

            Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.

            • Fieldsrequired — (Array<map>)

              An array of objects with Field ID and Value data.

              • Idrequired — (String)

                Unique identifier of a field.

              • Valuerequired — (map)

                Union of potential field value types.

                • BooleanValue — (Boolean)

                  A Boolean number value type.

                • DoubleValue — (Float)

                  a Double number value type.

                • EmptyValue — (map)

                  An empty value.

                • StringValue — (String)

                  String value type.

            • TemplateIdrequired — (String)

              A unique identifier of a template.

          • UpdateCaseAction — (map)

            Information about the update case action.

            Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.

            • Fieldsrequired — (Array<map>)

              An array of objects with Field ID and Value data.

              • Idrequired — (String)

                Unique identifier of a field.

              • Valuerequired — (map)

                Union of potential field value types.

                • BooleanValue — (Boolean)

                  A Boolean number value type.

                • DoubleValue — (Float)

                  a Double number value type.

                • EmptyValue — (map)

                  An empty value.

                • StringValue — (String)

                  String value type.

          • EndAssociatedTasksAction — (map)

            Information about the end associated tasks action.

            Supported only for TriggerEventSource values: OnCaseUpdate.

        • PublishStatusrequired — (String)

          The publish status of the rule.

          Possible values include:
          • "DRAFT"
          • "PUBLISHED"
        • CreatedTimerequired — (Date)

          The timestamp for when the rule was created.

        • LastUpdatedTimerequired — (Date)

          The timestamp for the when the rule was last updated.

        • LastUpdatedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who last updated the rule.

        • 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.

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

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 instance ID in the Amazon Resource Name (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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

        • HierarchyRestrictedResources — (Array<String>)

          The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

        • AllowedAccessControlHierarchyGroupId — (String)

          The identifier of the hierarchy group that a security profile uses to restrict access to resources 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" }.

        • IsDefault — (Boolean)

          Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

          Note: The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

Returns:

  • (AWS.Request)

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

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

Describes the specified user. You can find the instance ID in the Amazon Connect 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 instance ID in the Amazon Resource Name (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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

            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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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.

            • LastModifiedTime — (Date)

              The timestamp when this resource was last modified.

            • LastModifiedRegion — (String)

              The Amazon Web Services Region where this resource was last modified.

          • 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.

            • LastModifiedTime — (Date)

              The timestamp when this resource was last modified.

            • LastModifiedRegion — (String)

              The Amazon Web Services Region where this resource was last modified.

          • 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.

            • LastModifiedTime — (Date)

              The timestamp when this resource was last modified.

            • LastModifiedRegion — (String)

              The Amazon Web Services Region where this resource was last modified.

          • 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.

            • LastModifiedTime — (Date)

              The timestamp when this resource was last modified.

            • LastModifiedRegion — (String)

              The Amazon Web Services Region where this resource was last modified.

          • 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.

            • LastModifiedTime — (Date)

              The timestamp when this resource was last modified.

            • LastModifiedRegion — (String)

              The Amazon Web Services Region where this resource was last modified.

        • Tags — (map<String>)

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

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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.

          • LastModifiedTime — (Date)

            The timestamp when this resource was last modified.

          • LastModifiedRegion — (String)

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime — (Date)

            The timestamp when this resource was last modified.

          • LastModifiedRegion — (String)

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime — (Date)

            The timestamp when this resource was last modified.

          • LastModifiedRegion — (String)

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime — (Date)

            The timestamp when this resource was last modified.

          • LastModifiedRegion — (String)

            The Amazon Web Services Region where this resource was last modified.

        • 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.

          • LastModifiedTime — (Date)

            The timestamp when this resource was last modified.

          • LastModifiedRegion — (String)

            The Amazon Web Services Region where this resource was last modified.

Returns:

  • (AWS.Request)

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

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

Retrieves the view for the specified Amazon Connect instance and view identifier.

The view identifier can be supplied as a ViewId or ARN.

$SAVED needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

Service Reference:

Examples:

Calling the describeView operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ViewId: 'STRING_VALUE' /* required */
};
connect.describeView(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.

    • ViewId — (String)

      The ViewId of the view. This must be an ARN for Amazon Web Services managed views.

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:

      • View — (map)

        All view data is contained within the View object.

        • Id — (String)

          The identifier of the view.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the view.

        • Name — (String)

          The name of the view.

        • Status — (String)

          Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

          Possible values include:
          • "PUBLISHED"
          • "SAVED"
        • Type — (String)

          The type of the view - CUSTOMER_MANAGED.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_MANAGED"
        • Description — (String)

          The description of the view.

        • Version — (Integer)

          Current version of the view.

        • VersionDescription — (String)

          The description of the version.

        • Content — (map)

          View content containing all content necessary to render a view except for runtime input data.

          • InputSchema — (String)

            The data schema matching data that the view template must be provided to render.

          • Template — (String)

            The view template representing the structure of the view.

          • Actions — (Array<String>)

            A list of possible actions from the view.

        • Tags — (map<String>)

          The tags associated with the view resource (not specific to view version).

        • CreatedTime — (Date)

          The timestamp of when the view was created.

        • LastModifiedTime — (Date)

          Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

        • ViewContentSha256 — (String)

          Indicates the checksum value of the latest published view content.

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 instance ID in the Amazon Resource Name (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"
          • "en-NZ"
          • "en-ZA"
        • 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.

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

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

Removes the dataset ID associated with a given Amazon Connect instance.

Service Reference:

Examples:

Calling the disassociateAnalyticsDataSet operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  TargetAccountId: 'STRING_VALUE'
};
connect.disassociateAnalyticsDataSet(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • DataSetId — (String)

      The identifier of the dataset to remove.

    • TargetAccountId — (String)

      The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect 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.

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 instance ID in the Amazon Resource Name (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', /* required */
    Name: 'STRING_VALUE' /* required */
  },
  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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • LexBot — (map)

      Configuration information of an Amazon Lex bot.

      • Namerequired — (String)

        The name of the Amazon Lex bot.

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

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

Disassociates a connect resource from a flow.

Service Reference:

Examples:

Calling the disassociateFlow operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: SMS_PHONE_NUMBER /* required */
};
connect.disassociateFlow(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ResourceId — (String)

      The identifier of the resource.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "SMS_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.

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 | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_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 instance ID in the Amazon Resource Name (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"
      • "ATTACHMENTS"
      • "CONTACT_EVALUATIONS"
      • "SCREEN_RECORDINGS"
      • "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_VOICE_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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Disassociates an agent from a traffic distribution group.

Examples:

Calling the disassociateTrafficDistributionGroupUser operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TrafficDistributionGroupId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.disassociateTrafficDistributionGroupUser(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.

    • UserId — (String)

      The identifier for the user. This can be the ID or the ARN of the user.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Disassociates a set of proficiencies from a user.

Service Reference:

Examples:

Calling the disassociateUserProficiencies operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  UserProficiencies: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
connect.disassociateUserProficiencies(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • UserId — (String)

      The identifier of the user account.

    • UserProficiencies — (Array<map>)

      The proficiencies to disassociate from the user.

      • AttributeNamerequired — (String)

        The name of user's proficiency.

      • AttributeValuerequired — (String)

        The value of user's proficiency.

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 */
    ],
    RoutingProfiles: [
      'STRING_VALUE',
      /* more items */
    ],
    RoutingStepExpressions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  InstanceId: 'STRING_VALUE', /* required */
  Groupings: [
    QUEUE | CHANNEL | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortCriteria: [
    {
      SortByMetric: 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,
      SortOrder: ASCENDING | DESCENDING
    },
    /* more items */
  ]
};
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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Filters — (map)

      The filters to apply to returned metrics. You can filter up to the following limits:

      • Queues: 100

      • Routing profiles: 100

      • Channels: 3 (VOICE, CHAT, and TASK channels are supported.)

      • RoutingStepExpressions: 50

      Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.

      When using the RoutingStepExpression filter, you need to pass exactly one QueueId. The filter is also case sensitive so when using the RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is required.

      Currently tagging is only supported on the resources that are passed in the filter.

      • 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.

      • RoutingProfiles — (Array<String>)

        A list of up to 100 routing profile IDs or ARNs.

      • RoutingStepExpressions — (Array<String>)

        A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.

    • 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. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.

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

      • When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is required.

    • 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.

      When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.

      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.

    • SortCriteria — (Array<map>)

      The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.

      Note the following:

      • Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.

      • SortByMetric — (String)

        The current metric names.

        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"
      • SortOrder — (String)

        The way to sort.

        Possible values include:
        • "ASCENDING"
        • "DESCENDING"

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

            Information about the routing profile assigned to the user.

            • Id — (String)

              The identifier of the routing profile.

            • Arn — (String)

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

          • RoutingStepExpression — (String)

            The expression of a step in a routing criteria.

        • 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.

      • ApproximateTotalCount — (Integer)

        The total count of the result, regardless of the current page size.

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 */
    Agents: [
      'STRING_VALUE',
      /* more items */
    ],
    ContactFilter: {
      ContactStates: [
        INCOMING | PENDING | CONNECTING | CONNECTED | CONNECTED_ONHOLD | MISSED | ERROR | ENDED | REJECTED,
        /* more items */
      ]
    },
    Queues: [
      'STRING_VALUE',
      /* more items */
    ],
    RoutingProfiles: [
      'STRING_VALUE',
      /* more items */
    ],
    UserHierarchyGroups: [
      '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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Filters — (map)

      The filters to apply to returned user data. You can filter up to the following limits:

      • Queues: 100

      • Routing profiles: 100

      • Agents: 100

      • Contact states: 9

      • User hierarchy groups: 1

      The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

      Currently tagging is only supported on the resources that are passed in the filter.

      • Queues — (Array<String>)

        A list of up to 100 queues or ARNs.

      • 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.

      • RoutingProfiles — (Array<String>)

        A list of up to 100 routing profile IDs or ARNs.

      • Agents — (Array<String>)

        A list of up to 100 agent IDs or ARNs.

      • UserHierarchyGroups — (Array<String>)

        A UserHierarchyGroup ID or ARN.

    • 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.

          • StatusName — (String)

            The name of the agent 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"
            • "DISCONNECT"
            • "MONITOR"
            • "EXTERNAL_OUTBOUND"
          • AgentContactState — (String)

            The state of the contact.

            Note: When AgentContactState is set to CONNECTED_ONHOLD, StateStartTimestamp is not changed. Instead, StateStartTimestamp reflects the time the contact was CONNECTED to the agent.
            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.

        • NextStatus — (String)

          The Next status of the agent.

      • ApproximateTotalCount — (Integer)

        The total count of the result, regardless of the current page size.

Returns:

  • (AWS.Request)

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

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

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

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 instance ID in the Amazon Resource Name (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. This can be the ID or the ARN of the user.

Returns:

  • (AWS.Request)

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

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

Retrieves the flow associated for a given resource.

Service Reference:

Examples:

Calling the getFlowAssociation operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: SMS_PHONE_NUMBER /* required */
};
connect.getFlowAssociation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ResourceId — (String)

      The identifier of the resource.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "SMS_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:

      • ResourceId — (String)

        The identifier of the resource.

      • FlowId — (String)

        The identifier of the flow.

      • ResourceType — (String)

        A valid resource type.

        Possible values include:
        • "SMS_PHONE_NUMBER"

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.

Note: We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

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 */
    ],
    RoutingProfiles: [
      'STRING_VALUE',
      /* more items */
    ],
    RoutingStepExpressions: [
      '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 | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION,
    /* 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 instance ID in the Amazon Resource Name (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.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      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.

      • RoutingProfiles — (Array<String>)

        A list of up to 100 routing profile IDs or ARNs.

      • RoutingStepExpressions — (Array<String>)

        A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.

    • 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.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

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

            Information about the routing profile assigned to the user.

            • Id — (String)

              The identifier of the routing profile.

            • Arn — (String)

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

          • RoutingStepExpression — (String)

            The expression of a step in a routing criteria.

        • 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.

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

Gets metric data from the specified Amazon Connect instance.

GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

Service Reference:

Examples:

Calling the getMetricDataV2 operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Filters: [ /* required */
    {
      FilterKey: 'STRING_VALUE',
      FilterValues: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Metrics: [ /* required */
    {
      MetricFilters: [
        {
          MetricFilterKey: 'STRING_VALUE',
          MetricFilterValues: [
            'STRING_VALUE',
            /* more items */
          ],
          Negate: true || false
        },
        /* more items */
      ],
      Name: 'STRING_VALUE',
      Threshold: [
        {
          Comparison: 'STRING_VALUE',
          ThresholdValue: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  ResourceArn: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Groupings: [
    'STRING_VALUE',
    /* more items */
  ],
  Interval: {
    IntervalPeriod: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL,
    TimeZone: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.getMetricDataV2(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. This includes the instanceId an Amazon Connect 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 before the end time timestamp. The start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.

    • 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 later than the start time timestamp. It cannot be later than the current timestamp.

    • Interval — (map)

      The interval period and timezone to apply to returned metrics.

      • IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

        For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.

        The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.

        • FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

        • THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

        • HOUR: The difference between StartTime and EndTime must be less than 3 days.

        • DAY: The difference between StartTime and EndTime must be less than 35 days.

        • WEEK: The difference between StartTime and EndTime must be less than 35 days.

        • TOTAL: The difference between StartTime and EndTime must be less than 35 days.

      • TimeZone: The timezone applied to requested metrics.

      • TimeZone — (String)

        The timezone applied to requested metrics.

      • IntervalPeriod — (String)

        IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

        For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.

        The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.

        • FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

        • THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

        • HOUR: The difference between StartTime and EndTime must be less than 3 days.

        • DAY: The difference between StartTime and EndTime must be less than 35 days.

        • WEEK: The difference between StartTime and EndTime must be less than 35 days.

        • TOTAL: The difference between StartTime and EndTime must be less than 35 days.

        Possible values include:
        • "FIFTEEN_MIN"
        • "THIRTY_MIN"
        • "HOUR"
        • "DAY"
        • "WEEK"
        • "TOTAL"
    • Filters — (Array<map>)

      The filters to apply to returned metrics. You can filter on the following resources:

      • Queues

      • Routing profiles

      • Agents

      • Channels

      • User hierarchy groups

      • Feature

      • Routing step expression

      At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.

      To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator's Guide.

      Note the following limits:

      • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION

      • Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.

        contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.

        connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.

        ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.

      • FilterKey — (String)

        The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.

      • FilterValues — (Array<String>)

        The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you would add queue IDs or ARNs in FilterValues.

    • Groupings — (Array<String>)

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

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

      Valid grouping keys: QUEUE | ROUTING_PROFILE | AGENT | CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION

    • Metrics — (Array<map>)

      The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide.

      ABANDONMENT_RATE

      Unit: Percent

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Abandonment rate

      AGENT_ADHERENT_TIME

      This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Adherent time

      AGENT_ANSWER_RATE

      Unit: Percent

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Agent answer rate

      AGENT_NON_ADHERENT_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Non-adherent time

      AGENT_NON_RESPONSE

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Agent non-response

      AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

      UI name: Agent non-response without customer abandons

      AGENT_OCCUPANCY

      Unit: Percentage

      Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

      UI name: Occupancy

      AGENT_SCHEDULE_ADHERENCE

      This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

      Unit: Percent

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Adherence

      AGENT_SCHEDULED_TIME

      This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Scheduled time

      AVG_ABANDON_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average queue abandon time

      AVG_ACTIVE_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Average active time

      AVG_AFTER_CONTACT_WORK_TIME

      Unit: Seconds

      Valid metric filter key: INITIATION_METHOD

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average after contact work time

      Note: Feature is a valid filter but not a valid grouping.
      AVG_AGENT_CONNECTING_TIME

      Unit: Seconds

      Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Average agent API connecting time

      Note: The Negate key in Metric Level Filters is not applicable for this metric.
      AVG_AGENT_PAUSE_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Average agent pause time

      AVG_CASE_RELATED_CONTACTS

      Unit: Count

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Average contacts per case

      AVG_CASE_RESOLUTION_TIME

      Unit: Seconds

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Average case resolution time

      AVG_CONTACT_DURATION

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average contact duration

      Note: Feature is a valid filter but not a valid grouping.
      AVG_CONVERSATION_DURATION

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average conversation duration

      AVG_GREETING_TIME_AGENT

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average greeting time agent

      AVG_HANDLE_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

      UI name: Average handle time

      Note: Feature is a valid filter but not a valid grouping.
      AVG_HOLD_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average customer hold time

      Note: Feature is a valid filter but not a valid grouping.
      AVG_HOLD_TIME_ALL_CONTACTS

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average customer hold time all contacts

      AVG_HOLDS

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average holds

      Note: Feature is a valid filter but not a valid grouping.
      AVG_INTERACTION_AND_HOLD_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average agent interaction and customer hold time

      AVG_INTERACTION_TIME

      Unit: Seconds

      Valid metric filter key: INITIATION_METHOD

      Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average agent interaction time

      Note: Feature is a valid filter but not a valid grouping.
      AVG_INTERRUPTIONS_AGENT

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average interruptions agent

      AVG_INTERRUPTION_TIME_AGENT

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average interruption time agent

      AVG_NON_TALK_TIME

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average non-talk time

      AVG_QUEUE_ANSWER_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Average queue answer time

      Note: Feature is a valid filter but not a valid grouping.
      AVG_RESOLUTION_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

      UI name: Average resolution time

      AVG_TALK_TIME

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average talk time

      AVG_TALK_TIME_AGENT

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average talk time agent

      AVG_TALK_TIME_CUSTOMER

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Average talk time customer

      CASES_CREATED

      Unit: Count

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Cases created

      CONTACTS_ABANDONED

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

      UI name: Contact abandoned

      CONTACTS_CREATED

      Unit: Count

      Valid metric filter key: INITIATION_METHOD

      Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Contacts created

      Note: Feature is a valid filter but not a valid grouping.
      CONTACTS_HANDLED

      Unit: Count

      Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression

      UI name: API contacts handled

      Note: Feature is a valid filter but not a valid grouping.
      CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT

      Unit: Count

      Valid metric filter key: INITIATION_METHOD

      Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contacts handled by Connected to agent

      CONTACTS_HOLD_ABANDONS

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contacts hold disconnect

      CONTACTS_ON_HOLD_AGENT_DISCONNECT

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contacts hold agent disconnect

      CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contacts hold customer disconnect

      CONTACTS_PUT_ON_HOLD

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contacts put on hold

      CONTACTS_TRANSFERRED_OUT_EXTERNAL

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contacts transferred out external

      CONTACTS_TRANSFERRED_OUT_INTERNAL

      Unit: Percent

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contacts transferred out internal

      CONTACTS_QUEUED

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contacts queued

      CONTACTS_QUEUED_BY_ENQUEUE

      Unit: Count

      Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contacts queued by Enqueue

      CONTACTS_RESOLVED_IN_X

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

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

      UI name: Contacts resolved in X

      CONTACTS_TRANSFERRED_OUT

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype

      UI name: Contacts transferred out

      Note: Feature is a valid filter but not a valid grouping.
      CONTACTS_TRANSFERRED_OUT_BY_AGENT

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contacts transferred out by agent

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contacts transferred out queue

      CURRENT_CASES

      Unit: Count

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Current cases

      MAX_QUEUED_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Maximum queued time

      PERCENT_CASES_FIRST_CONTACT_RESOLVED

      Unit: Percent

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Cases resolved on first contact

      PERCENT_CONTACTS_STEP_EXPIRED

      Unit: Percent

      Valid groupings and filters: Queue, RoutingStepExpression

      UI name: Not available

      PERCENT_CONTACTS_STEP_JOINED

      Unit: Percent

      Valid groupings and filters: Queue, RoutingStepExpression

      UI name: Not available

      PERCENT_NON_TALK_TIME

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Percentage

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Non-talk time percent

      PERCENT_TALK_TIME

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Percentage

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Talk time percent

      PERCENT_TALK_TIME_AGENT

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Percentage

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Talk time agent percent

      PERCENT_TALK_TIME_CUSTOMER

      This metric is available only for contacts analyzed by Contact Lens conversational analytics.

      Unit: Percentage

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Talk time customer percent

      REOPENED_CASE_ACTIONS

      Unit: Count

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Cases reopened

      RESOLVED_CASE_ACTIONS

      Unit: Count

      Required filter key: CASE_TEMPLATE_ARN

      Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

      UI name: Cases resolved

      SERVICE_LEVEL

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

      Unit: Percent

      Valid groupings and filters: Queue, Channel, Routing Profile

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

      UI name: Service level X

      STEP_CONTACTS_QUEUED

      Unit: Count

      Valid groupings and filters: Queue, RoutingStepExpression

      UI name: Not available

      SUM_AFTER_CONTACT_WORK_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: After contact work time

      SUM_CONNECTING_TIME_AGENT

      Unit: Seconds

      Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Agent API connecting time

      Note: The Negate key in Metric Level Filters is not applicable for this metric.
      SUM_CONTACT_FLOW_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contact flow time

      SUM_CONTACT_TIME_AGENT

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Agent on contact time

      SUM_CONTACTS_ANSWERED_IN_X

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

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

      UI name: Contacts answered in X seconds

      SUM_CONTACTS_ABANDONED_IN_X

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

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

      UI name: Contacts abandoned in X seconds

      SUM_CONTACTS_DISCONNECTED

      Valid metric filter key: DISCONNECT_REASON

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype

      UI name: Contact disconnected

      SUM_ERROR_STATUS_TIME_AGENT

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Error status time

      SUM_HANDLE_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Contact handle time

      SUM_HOLD_TIME

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Customer hold time

      SUM_IDLE_TIME_AGENT

      Unit: Seconds

      Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

      UI name: Agent idle time

      SUM_INTERACTION_AND_HOLD_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Agent interaction and hold time

      SUM_INTERACTION_TIME

      Unit: Seconds

      Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

      UI name: Agent interaction time

      SUM_NON_PRODUCTIVE_TIME_AGENT

      Unit: Seconds

      Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

      UI name: Non-Productive Time

      SUM_ONLINE_TIME_AGENT

      Unit: Seconds

      Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

      UI name: Online time

      SUM_RETRY_CALLBACK_ATTEMPTS

      Unit: Count

      Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype

      UI name: Callback attempts

      • Name — (String)

        The name of the metric.

        This parameter is required. The following Required = No is incorrect.

      • Threshold — (Array<map>)

        Contains information about the threshold for service level metrics.

        • Comparison — (String)

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

        • ThresholdValue — (Float)

          The threshold value to compare.

      • MetricFilters — (Array<map>)

        Contains the filters to be used when returning data.

        • MetricFilterKey — (String)

          The key to use for filtering data.

          Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.

        • MetricFilterValues — (Array<String>)

          The values to use for filtering data.

          Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API

          Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API

        • Negate — (Boolean)

          The flag to use to filter on requested metric filter values or to not filter on requested metric filter values. By default the negate is false, which indicates to filter on the requested metric filter.

    • 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.

      • MetricResults — (Array<map>)

        Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.

        • Dimensions — (map<String>)

          The dimension for the metrics.

        • MetricInterval — (map)

          The interval period with the start and end time for the metrics.

          • Interval — (String)

            The interval period provided in the API request.

            Possible values include:
            • "FIFTEEN_MIN"
            • "THIRTY_MIN"
            • "HOUR"
            • "DAY"
            • "WEEK"
            • "TOTAL"
          • StartTime — (Date)

            The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.

          • EndTime — (Date)

            The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each StartTime and EndTime differing by 30 minutes.

        • Collections — (Array<map>)

          The set of metrics.

          • Metric — (map)

            The metric name, thresholds, and metric filters of the returned metric.

            • Name — (String)

              The name of the metric.

              This parameter is required. The following Required = No is incorrect.

            • Threshold — (Array<map>)

              Contains information about the threshold for service level metrics.

              • Comparison — (String)

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

              • ThresholdValue — (Float)

                The threshold value to compare.

            • MetricFilters — (Array<map>)

              Contains the filters to be used when returning data.

              • MetricFilterKey — (String)

                The key to use for filtering data.

                Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. These are the same values as the InitiationMethod and DisconnectReason in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.

              • MetricFilterValues — (Array<String>)

                The values to use for filtering data.

                Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API

                Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API

              • Negate — (Boolean)

                The flag to use to filter on requested metric filter values or to not filter on requested metric filter values. By default the negate is false, which indicates to filter on the requested metric filter.

          • Value — (Float)

            The corresponding value of the metric returned in the response.

Returns:

  • (AWS.Request)

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

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

Gets the prompt file.

Service Reference:

Examples:

Calling the getPromptFile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PromptId: 'STRING_VALUE' /* required */
};
connect.getPromptFile(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PromptId — (String)

      A unique identifier for the prompt.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • PromptPresignedUrl — (String)

        A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.

      • LastModifiedTime — (Date)

        The timestamp when this resource was last modified.

      • LastModifiedRegion — (String)

        The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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. 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:

      • 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.

      • SignInConfig — (map)

        The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

        • Distributionsrequired — (Array<map>)

          Information about traffic distributions.

          • Regionrequired — (String)

            The Amazon Web Services Region of the sign in distribution.

          • Enabledrequired — (Boolean)

            Whether sign in distribution is enabled.

      • AgentConfig — (map)

        The distribution of agents between the instance and its replica(s).

        • 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.

Returns:

  • (AWS.Request)

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

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

Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

Service Reference:

Examples:

Calling the importPhoneNumber operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SourcePhoneNumberArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  PhoneNumberDescription: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.importPhoneNumber(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • SourcePhoneNumberArn — (String)

      The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to import from Amazon Pinpoint.

    • 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.

      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.

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 instance ID in the Amazon Resource Name (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"
        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

Returns:

  • (AWS.Request)

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

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

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

Lists the association status of requested dataset ID for a given Amazon Connect instance.

Service Reference:

Examples:

Calling the listAnalyticsDataAssociations operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listAnalyticsDataAssociations(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • DataSetId — (String)

      The identifier of the dataset to get the association status.

    • 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:

      • Results — (Array<map>)

        An array of successful results: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn. This is a paginated API, so nextToken is given if there are more results to be returned.

        • DataSetId — (String)

          The identifier of the dataset.

        • TargetAccountId — (String)

          The identifier of the target account.

        • ResourceShareId — (String)

          The Resource Access Manager share ID.

        • ResourceShareArn — (String)

          The Amazon Resource Name (ARN) of the Resource Access Manager share.

      • 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.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

          • Namerequired — (String)

            The name of the Amazon Lex bot.

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

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

Lists contact evaluations in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listContactEvaluations operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
connect.listContactEvaluations(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactId — (String)

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

    • 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:

      • EvaluationSummaryList — (Array<map>)

        Provides details about a list of contact evaluations belonging to an instance.

        • EvaluationIdrequired — (String)

          A unique identifier for the contact evaluation.

        • EvaluationArnrequired — (String)

          The Amazon Resource Name (ARN) for the contact evaluation resource.

        • EvaluationFormTitlerequired — (String)

          A title of the evaluation form.

        • EvaluationFormIdrequired — (String)

          The unique identifier for the evaluation form.

        • Statusrequired — (String)

          The status of the contact evaluation.

          Possible values include:
          • "DRAFT"
          • "SUBMITTED"
        • EvaluatorArnrequired — (String)

          The Amazon Resource Name (ARN) of the user who last updated the evaluation.

        • Score — (map)

          The overall score of the contact evaluation.

          • Percentage — (Float)

            The score percentage for an item in a contact evaluation.

          • NotApplicable — (Boolean)

            The flag to mark the item as not applicable for scoring.

          • AutomaticFail — (Boolean)

            The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.

        • CreatedTimerequired — (Date)

          The timestamp for when the evaluation was created.

        • LastModifiedTimerequired — (Date)

          The timestamp for when the evaluation was last updated.

      • 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.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

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 instance ID in the Amazon Resource Name (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 | en-NZ | en-ZA,
  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 instance ID in the Amazon Resource Name (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"
      • "en-NZ"
      • "en-ZA"
    • 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 instance ID in the Amazon Resource Name (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"
          • "en-NZ"
          • "en-ZA"
        • 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.

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

Lists evaluation forms in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listEvaluationForms operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listEvaluationForms(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 instance ID in the Amazon Resource Name (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.

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:

      • EvaluationFormSummaryList — (Array<map>)

        Provides details about a list of evaluation forms belonging to an instance.

        • EvaluationFormIdrequired — (String)

          The unique identifier for the evaluation form.

        • EvaluationFormArnrequired — (String)

          The Amazon Resource Name (ARN) for the evaluation form resource.

        • Titlerequired — (String)

          A title of the evaluation form.

        • CreatedTimerequired — (Date)

          The timestamp for when the evaluation form was created.

        • CreatedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who created the evaluation form.

        • LastModifiedTimerequired — (Date)

          The timestamp for when the evaluation form was last updated.

        • LastModifiedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

        • LastActivatedTime — (Date)

          The timestamp for when the evaluation form was last activated.

        • LastActivatedBy — (String)

          The Amazon Resource Name (ARN) of the user who last activated the evaluation form.

        • LatestVersionrequired — (Integer)

          The version number of the latest evaluation form version.

        • ActiveVersion — (Integer)

          The version of the active evaluation form version.

      • 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.

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

Lists versions of an evaluation form in the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listEvaluationFormVersions operation

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listEvaluationFormVersions(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • 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:

      • EvaluationFormVersionSummaryList — (Array<map>)

        Provides details about a list of evaluation forms belonging to an instance.

        • EvaluationFormArnrequired — (String)

          The Amazon Resource Name (ARN) for the evaluation form resource.

        • EvaluationFormIdrequired — (String)

          The unique identifier for the evaluation form.

        • EvaluationFormVersionrequired — (Integer)

          A version of the evaluation form.

        • Lockedrequired — (Boolean)

          The flag indicating whether the evaluation form is locked for changes.

        • Statusrequired — (String)

          The status of the evaluation form.

          Possible values include:
          • "DRAFT"
          • "ACTIVE"
        • CreatedTimerequired — (Date)

          The timestamp for when the evaluation form was created.

        • CreatedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who created the evaluation form.

        • LastModifiedTimerequired — (Date)

          The timestamp for when the evaluation form was last updated.

        • LastModifiedByrequired — (String)

          The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

      • 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.

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

List the flow association based on the filters.

Service Reference:

Examples:

Calling the listFlowAssociations operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceType: VOICE_PHONE_NUMBER
};
connect.listFlowAssociations(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ResourceType — (String)

      A valid resource type.

      Possible values include:
      • "VOICE_PHONE_NUMBER"
    • 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:

      • FlowAssociationSummaryList — (Array<map>)

        Summary of flow associations.

        • ResourceId — (String)

          The identifier of the resource.

        • FlowId — (String)

          The identifier of the flow.

        • ResourceType — (String)

          The type of resource association.

          Possible values include:
          • "VOICE_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.

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 instance ID in the Amazon Resource Name (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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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 instance ID in the Amazon Resource Name (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"
          • "ENHANCED_CHAT_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.

        • InstanceAccessUrl — (String)

          This URL allows contact center users to access the Amazon Connect admin website.

      • 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 | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_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 instance ID in the Amazon Resource Name (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"
      • "ATTACHMENTS"
      • "CONTACT_EVALUATIONS"
      • "SCREEN_RECORDINGS"
      • "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_VOICE_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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
        • 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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
        • 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 */
  IntegrationArn: 'STRING_VALUE',
  IntegrationType: EVENT | VOICE_ID | PINPOINT_APP | WISDOM_ASSISTANT | WISDOM_KNOWLEDGE_BASE | WISDOM_QUICK_RESPONSES | CASES_DOMAIN | APPLICATION | FILE_SCANNER,
  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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • IntegrationType — (String)

      The integration type.

      Possible values include:
      • "EVENT"
      • "VOICE_ID"
      • "PINPOINT_APP"
      • "WISDOM_ASSISTANT"
      • "WISDOM_KNOWLEDGE_BASE"
      • "WISDOM_QUICK_RESPONSES"
      • "CASES_DOMAIN"
      • "APPLICATION"
      • "FILE_SCANNER"
    • 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.

    • IntegrationArn — (String)

      The Amazon Resource Name (ARN) of the integration.

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 instance ID in the Amazon Resource Name (ARN) of the instance.

        • IntegrationType — (String)

          The integration type.

          Possible values include:
          • "EVENT"
          • "VOICE_ID"
          • "PINPOINT_APP"
          • "WISDOM_ASSISTANT"
          • "WISDOM_KNOWLEDGE_BASE"
          • "WISDOM_QUICK_RESPONSES"
          • "CASES_DOMAIN"
          • "APPLICATION"
          • "FILE_SCANNER"
        • 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"
          • "CASES"
      • 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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

        • Namerequired — (String)

          The name of the Amazon Lex bot.

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

  • We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

  • 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 | UIFN | SHARED | THIRD_PARTY_TF | THIRD_PARTY_DID | SHORT_CODE,
    /* 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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PhoneNumberTypes — (Array<String>)

      The type of phone number.

      Note: We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it incorrectly lists them as TOLL_FREE or DID.
    • 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"
          • "UIFN"
          • "SHARED"
          • "THIRD_PARTY_TF"
          • "THIRD_PARTY_DID"
          • "SHORT_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"
      • 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.

Note:
  • When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.
  • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

Service Reference:

Examples:

Calling the listPhoneNumbersV2 operation

var params = {
  InstanceId: 'STRING_VALUE',
  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 | UIFN | SHARED | THIRD_PARTY_TF | THIRD_PARTY_DID | SHORT_CODE,
    /* 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 number inbound traffic is routed through. If both TargetArn and InstanceId input are 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.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. If both TargetArn and InstanceId are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS 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"
          • "UIFN"
          • "SHARED"
          • "THIRD_PARTY_TF"
          • "THIRD_PARTY_DID"
          • "SHORT_CODE"
        • TargetArn — (String)

          The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.

        • InstanceId — (String)

          The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

        • PhoneNumberDescription — (String)

          The description of the phone number.

        • SourcePhoneNumberArn — (String)

          The claimed phone number ARN that was previously imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number that was imported from Amazon Pinpoint.

Returns:

  • (AWS.Request)

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

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

Lists predefined attributes for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listPredefinedAttributes operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listPredefinedAttributes(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 instance ID in the Amazon Resource Name (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:

      • NextToken — (String)

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

      • PredefinedAttributeSummaryList — (Array<map>)

        Summary of the predefined attributes.

        • Name — (String)

          The name of the predefined attribute.

        • LastModifiedTime — (Date)

          Last modified time.

        • LastModifiedRegion — (String)

          Last modified region.

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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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 instance ID in the Amazon Resource Name (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 admin website, 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"
        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • LastModifiedTime — (Date)

        The timestamp when this resource was last modified.

      • LastModifiedRegion — (String)

        The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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"
        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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 instance ID in the Amazon Resource Name (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 admin website, 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 admin website, 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"
        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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.

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

Provides a list of analysis segments for a real-time analysis session.

Examples:

Calling the listRealtimeContactAnalysisSegmentsV2 operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  OutputType: Raw | Redacted, /* required */
  SegmentTypes: [ /* required */
    Transcript | Categories | Issues | Event | Attachments,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listRealtimeContactAnalysisSegmentsV2(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactId — (String)

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

    • 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.

    • OutputType — (String)

      The Contact Lens output type to be returned.

      Possible values include:
      • "Raw"
      • "Redacted"
    • SegmentTypes — (Array<String>)

      Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment 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:

      • Channel — (String)

        The channel of the contact. Voice will not be returned.

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

        Status of real-time contact analysis.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • Segments — (Array<map>)

        An analyzed transcript or category.

        • Transcript — (map)

          The analyzed transcript segment.

          • Idrequired — (String)

            The identifier of the transcript.

          • ParticipantIdrequired — (String)

            The identifier of the participant.

          • ParticipantRolerequired — (String)

            The role of the participant. For example, is it a customer, agent, or system.

            Possible values include:
            • "AGENT"
            • "CUSTOMER"
            • "SYSTEM"
            • "CUSTOM_BOT"
            • "SUPERVISOR"
          • DisplayName — (String)

            The display name of the participant.

          • Contentrequired — (String)

            The content of the transcript. Can be redacted.

          • ContentType — (String)

            The type of content of the item. For example, text/plain.

          • Timerequired — (map)

            Field describing the time of the event. It can have different representations of time.

            • AbsoluteTime — (Date)

              Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

          • Redaction — (map)

            Object describing redaction that was applied to the transcript. If transcript has the field it means part of the transcript was redacted.

            • CharacterOffsets — (Array<map>)

              List of character intervals each describing a part of the text that was redacted. For OutputType.Raw, part of the original text that contains data that can be redacted. For OutputType.Redacted, part of the string with redaction tag.

              • BeginOffsetCharrequired — (Integer)

                The beginning of the character interval.

              • EndOffsetCharrequired — (Integer)

                The end of the character interval.

          • Sentiment — (String)

            The sentiment detected for this piece of transcript.

            Possible values include:
            • "POSITIVE"
            • "NEGATIVE"
            • "NEUTRAL"
        • Categories — (map)

          The matched category rules.

          • MatchedDetailsrequired — (map<map>)

            Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.

            • PointsOfInterestrequired — (Array<map>)

              List of PointOfInterest - objects describing a single match of a rule.

              • TranscriptItems — (Array<map>)

                List of the transcript items (segments) that are associated with a given point of interest.

                • Idrequired — (String)

                  Transcript identifier. Matches the identifier from one of the TranscriptSegments.

                • CharacterOffsets — (map)

                  List of character intervals within transcript content/text.

                  • BeginOffsetCharrequired — (Integer)

                    The beginning of the character interval.

                  • EndOffsetCharrequired — (Integer)

                    The end of the character interval.

        • Issues — (map)

          Segment type containing a list of detected issues.

          • IssuesDetectedrequired — (Array<map>)

            List of the issues detected.

            • TranscriptItemsrequired — (Array<map>)

              List of the transcript items (segments) that are associated with a given issue.

              • Content — (String)

                Part of the transcript content that contains identified issue. Can be redacted

              • Idrequired — (String)

                Transcript identifier. Matches the identifier from one of the TranscriptSegments.

              • CharacterOffsets — (map)

                Begin and end offsets for a part of text.

                • BeginOffsetCharrequired — (Integer)

                  The beginning of the character interval.

                • EndOffsetCharrequired — (Integer)

                  The end of the character interval.

        • Event — (map)

          Segment type describing a contact event.

          • Idrequired — (String)

            The identifier of the contact event.

          • ParticipantId — (String)

            The identifier of the participant.

          • ParticipantRole — (String)

            The role of the participant. For example, is it a customer, agent, or system.

            Possible values include:
            • "AGENT"
            • "CUSTOMER"
            • "SYSTEM"
            • "CUSTOM_BOT"
            • "SUPERVISOR"
          • DisplayName — (String)

            The display name of the participant. Can be redacted.

          • EventTyperequired — (String)

            Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left.

          • Timerequired — (map)

            Field describing the time of the event. It can have different representations of time.

            • AbsoluteTime — (Date)

              Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

        • Attachments — (map)

          The analyzed attachments.

          • Idrequired — (String)

            The identifier of the segment.

          • ParticipantIdrequired — (String)

            The identifier of the participant.

          • ParticipantRolerequired — (String)

            The role of the participant. For example, is it a customer, agent, or system.

            Possible values include:
            • "AGENT"
            • "CUSTOMER"
            • "SYSTEM"
            • "CUSTOM_BOT"
            • "SUPERVISOR"
          • DisplayName — (String)

            The display name of the participant. Can be redacted.

          • Attachmentsrequired — (Array<map>)

            List of objects describing an individual attachment.

            • AttachmentNamerequired — (String)

              A case-sensitive name of the attachment being uploaded. Can be redacted.

            • ContentType — (String)

              Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

            • AttachmentIdrequired — (String)

              A unique identifier for the attachment.

            • Status — (String)

              Status of the attachment.

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

            Field describing the time of the event. It can have different representations of time.

            • AbsoluteTime — (Date)

              Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

      • 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 instance ID in the Amazon Resource Name (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"
      • LastModifiedTime — (Date)

        The timestamp when this resource was last modified.

      • LastModifiedRegion — (String)

        The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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.

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

List all rules for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listRules operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  EventSourceName: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate | OnCaseCreate | OnCaseUpdate,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PublishStatus: DRAFT | PUBLISHED
};
connect.listRules(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PublishStatus — (String)

      The publish status of the rule.

      Possible values include:
      • "DRAFT"
      • "PUBLISHED"
    • EventSourceName — (String)

      The name of the event source.

      Possible values include:
      • "OnPostCallAnalysisAvailable"
      • "OnRealTimeCallAnalysisAvailable"
      • "OnRealTimeChatAnalysisAvailable"
      • "OnPostChatAnalysisAvailable"
      • "OnZendeskTicketCreate"
      • "OnZendeskTicketStatusUpdate"
      • "OnSalesforceCaseCreate"
      • "OnContactEvaluationSubmit"
      • "OnMetricDataUpdate"
      • "OnCaseCreate"
      • "OnCaseUpdate"
    • 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:

      • RuleSummaryList — (Array<map>)

        Summary information about a rule.

        • Namerequired — (String)

          The name of the rule.

        • RuleIdrequired — (String)

          A unique identifier for the rule.

        • RuleArnrequired — (String)

          The Amazon Resource Name (ARN) of the rule.

        • EventSourceNamerequired — (String)

          The name of the event source.

          Possible values include:
          • "OnPostCallAnalysisAvailable"
          • "OnRealTimeCallAnalysisAvailable"
          • "OnRealTimeChatAnalysisAvailable"
          • "OnPostChatAnalysisAvailable"
          • "OnZendeskTicketCreate"
          • "OnZendeskTicketStatusUpdate"
          • "OnSalesforceCaseCreate"
          • "OnContactEvaluationSubmit"
          • "OnMetricDataUpdate"
          • "OnCaseCreate"
          • "OnCaseUpdate"
        • PublishStatusrequired — (String)

          The publish status of the rule.

          Possible values include:
          • "DRAFT"
          • "PUBLISHED"
        • ActionSummariesrequired — (Array<map>)

          A list of ActionTypes associated with a rule.

          • ActionTyperequired — (String)

            The action type.

            Possible values include:
            • "CREATE_TASK"
            • "ASSIGN_CONTACT_CATEGORY"
            • "GENERATE_EVENTBRIDGE_EVENT"
            • "SEND_NOTIFICATION"
            • "CREATE_CASE"
            • "UPDATE_CASE"
            • "END_ASSOCIATED_TASKS"
        • CreatedTimerequired — (Date)

          The timestamp for when the rule was created.

        • LastUpdatedTimerequired — (Date)

          The timestamp for when the rule was last updated.

      • 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 instance ID in the Amazon Resource Name (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.

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

Returns a list of third-party applications in a specific security profile.

Service Reference:

Examples:

Calling the listSecurityProfileApplications operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listSecurityProfileApplications(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 instance ID in the Amazon Resource Name (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:

      • Applications — (Array<map>)

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

        A list of the third-party application's metadata.

        • Namespace — (String)

          Namespace of the application that you want to give access to.

        • ApplicationPermissions — (Array<String>)

          The permissions that the agent is granted on the application. Only the ACCESS permission is supported.

      • NextToken — (String)

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

      • LastModifiedTime — (Date)

        The timestamp when this resource was last modified.

      • LastModifiedRegion — (String)

        The Amazon Web Services Region where this resource was last modified.

Returns:

  • (AWS.Request)

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

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

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 instance ID in the Amazon Resource Name (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.

      • LastModifiedTime — (Date)

        The timestamp when this resource was last modified.

      • LastModifiedRegion — (String)

        The Amazon Web Services Region where this resource was last modified.

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 instance ID in the Amazon Resource Name (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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • tags — (map<String>)

        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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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"
        • IsDefault — (Boolean)

          Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

Returns:

  • (AWS.Request)

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

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

Lists traffic distribution group users.

Examples:

Calling the listTrafficDistributionGroupUsers operation

var params = {
  TrafficDistributionGroupId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listTrafficDistributionGroupUsers(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.

    • 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.

      • TrafficDistributionGroupUserSummaryList — (Array<map>)

        A list of traffic distribution group users.

        • UserId — (String)

          The identifier for the user. This can be the ID or the ARN of the user.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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.

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

Lists proficiencies associated with a user.

Service Reference:

Examples:

Calling the listUserProficiencies operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listUserProficiencies(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • UserId — (String)

      The identifier of the user account.

    • 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.

      • UserProficiencyList — (Array<map>)

        Information about the user proficiencies.

        • AttributeNamerequired — (String)

          The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.

        • AttributeValuerequired — (String)

          The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.

        • Levelrequired — (Float)

          The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.

      • LastModifiedTime — (Date)

        The last time that the user's proficiencies are were modified.

      • LastModifiedRegion — (String)

        The region in which a user's proficiencies were last modified.

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 instance ID in the Amazon Resource Name (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.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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.

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

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

Service Reference:

Examples:

Calling the listViews operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: CUSTOMER_MANAGED | AWS_MANAGED
};
connect.listViews(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.

    • Type — (String)

      The type of the view.

      Possible values include:
      • "CUSTOMER_MANAGED"
      • "AWS_MANAGED"
    • 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:

      • ViewsSummaryList — (Array<map>)

        A list of view summaries.

        • Id — (String)

          The identifier of the view.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the view.

        • Name — (String)

          The name of the view.

        • Type — (String)

          The type of the view.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_MANAGED"
        • Status — (String)

          Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

          Possible values include:
          • "PUBLISHED"
          • "SAVED"
        • Description — (String)

          The description of the view.

      • 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.

Returns:

  • (AWS.Request)

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

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

Returns all the available versions for the specified Amazon Connect instance and view identifier.

Results will be sorted from highest to lowest.

Service Reference:

Examples:

Calling the listViewVersions operation

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

    • ViewId — (String)

      The identifier of the view. Both ViewArn and ViewId can be used.

    • 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:

      • ViewVersionSummaryList — (Array<map>)

        A list of view version summaries.

        • Id — (String)

          The identifier of the view version.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the view version.

        • Description — (String)

          The description of the view version.

        • Name — (String)

          The name of the view version.

        • Type — (String)

          The type of the view version.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_MANAGED"
        • Version — (Integer)

          The sequentially incremented version of the view version.

        • VersionDescription — (String)

          The description of the view version.

      • 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.

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. AllowedMonitorCapabilities is required if barge is enabled.

    • 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.

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

Allows pausing an ongoing task contact.

Service Reference:

Examples:

Calling the pauseContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ContactFlowId: 'STRING_VALUE'
};
connect.pauseContact(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 identifier of the contact.

    • 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.

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 instance ID in the Amazon Resource Name (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 admin website.

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.

If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

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 and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

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 instance ID in the Amazon Resource Name (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.

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

Allows resuming a task contact in a paused state.

Service Reference:

Examples:

Calling the resumeContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ContactFlowId: 'STRING_VALUE'
};
connect.resumeContact(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 identifier of the contact.

    • 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.

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

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

Voice and screen recordings are supported.

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 instance ID in the Amazon Resource Name (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 | UIFN | SHARED | THIRD_PARTY_TF | THIRD_PARTY_DID | SHORT_CODE, /* required */
  InstanceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PhoneNumberPrefix: 'STRING_VALUE',
  TargetArn: '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 number inbound traffic is routed through. You must enter InstanceId or TargetArn.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

    • 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"
      • "UIFN"
      • "SHARED"
      • "THIRD_PARTY_TF"
      • "THIRD_PARTY_DID"
      • "SHORT_CODE"
    • 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"
          • "UIFN"
          • "SHARED"
          • "THIRD_PARTY_TF"
          • "THIRD_PARTY_DID"
          • "SHORT_CODE"

Returns:

  • (AWS.Request)

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

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

Searches contacts in an Amazon Connect instance.

Service Reference:

Examples:

Calling the searchContacts operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TimeRange: { /* required */
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    Type: INITIATION_TIMESTAMP | SCHEDULED_TIMESTAMP | CONNECTED_TO_AGENT_TIMESTAMP | DISCONNECT_TIMESTAMP /* required */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: {
    AgentHierarchyGroups: {
      L1Ids: [
        'STRING_VALUE',
        /* more items */
      ],
      L2Ids: [
        'STRING_VALUE',
        /* more items */
      ],
      L3Ids: [
        'STRING_VALUE',
        /* more items */
      ],
      L4Ids: [
        'STRING_VALUE',
        /* more items */
      ],
      L5Ids: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    AgentIds: [
      'STRING_VALUE',
      /* more items */
    ],
    Channels: [
      VOICE | CHAT | TASK,
      /* more items */
    ],
    ContactAnalysis: {
      Transcript: {
        Criteria: [ /* required */
          {
            MatchType: MATCH_ALL | MATCH_ANY, /* required */
            ParticipantRole: AGENT | CUSTOMER | SYSTEM | CUSTOM_BOT | SUPERVISOR, /* required */
            SearchText: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        MatchType: MATCH_ALL | MATCH_ANY
      }
    },
    InitiationMethods: [
      INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API | DISCONNECT | MONITOR | EXTERNAL_OUTBOUND,
      /* more items */
    ],
    QueueIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SearchableContactAttributes: {
      Criteria: [ /* required */
        {
          Key: 'STRING_VALUE', /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      MatchType: MATCH_ALL | MATCH_ANY
    }
  },
  Sort: {
    FieldName: INITIATION_TIMESTAMP | SCHEDULED_TIMESTAMP | CONNECTED_TO_AGENT_TIMESTAMP | DISCONNECT_TIMESTAMP | INITIATION_METHOD | CHANNEL, /* required */
    Order: ASCENDING | DESCENDING /* required */
  }
};
connect.searchContacts(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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • TimeRange — (map)

      Time range that you want to search results.

      • Typerequired — (String)

        The type of timestamp to search.

        Possible values include:
        • "INITIATION_TIMESTAMP"
        • "SCHEDULED_TIMESTAMP"
        • "CONNECTED_TO_AGENT_TIMESTAMP"
        • "DISCONNECT_TIMESTAMP"
      • StartTimerequired — (Date)

        The start time of the time range.

      • EndTimerequired — (Date)

        The end time of the time range.

    • SearchCriteria — (map)

      The search criteria to be used to return contacts.

      • AgentIds — (Array<String>)

        The identifiers of agents who handled the contacts.

      • AgentHierarchyGroups — (map)

        The agent hierarchy groups of the agent at the time of handling the contact.

        • L1Ids — (Array<String>)

          The identifiers for level 1 hierarchy groups.

        • L2Ids — (Array<String>)

          The identifiers for level 2 hierarchy groups.

        • L3Ids — (Array<String>)

          The identifiers for level 3 hierarchy groups.

        • L4Ids — (Array<String>)

          The identifiers for level 4 hierarchy groups.

        • L5Ids — (Array<String>)

          The identifiers for level 5 hierarchy groups.

      • Channels — (Array<String>)

        The list of channels associated with contacts.

      • ContactAnalysis — (map)

        Search criteria based on analysis outputs from Amazon Connect Contact Lens.

        • Transcript — (map)

          Search criteria based on transcript analyzed by Amazon Connect Contact Lens.

          • Criteriarequired — (Array<map>)

            The list of search criteria based on Contact Lens conversational analytics transcript.

            • ParticipantRolerequired — (String)

              The participant role in a transcript

              Possible values include:
              • "AGENT"
              • "CUSTOMER"
              • "SYSTEM"
              • "CUSTOM_BOT"
              • "SUPERVISOR"
            • SearchTextrequired — (Array<String>)

              The words or phrases used to search within a transcript.

            • MatchTyperequired — (String)

              The match type combining search criteria using multiple search texts in a transcript criteria.

              Possible values include:
              • "MATCH_ALL"
              • "MATCH_ANY"
          • MatchType — (String)

            The match type combining search criteria using multiple transcript criteria.

            Possible values include:
            • "MATCH_ALL"
            • "MATCH_ANY"
      • InitiationMethods — (Array<String>)

        The list of initiation methods associated with contacts.

      • QueueIds — (Array<String>)

        The list of queue IDs associated with contacts.

      • SearchableContactAttributes — (map)

        The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.

        To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.

        • Criteriarequired — (Array<map>)

          The list of criteria based on user-defined contact attributes that are configured for contact search.

          • Keyrequired — (String)

            The key containing a searchable user-defined contact attribute.

          • Valuesrequired — (Array<String>)

            The list of values to search for within a user-defined contact attribute.

        • MatchType — (String)

          The match type combining search criteria using multiple searchable contact attributes.

          Possible values include:
          • "MATCH_ALL"
          • "MATCH_ANY"
    • 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.

    • Sort — (map)

      Specifies a field to sort by and a sort order.

      • FieldNamerequired — (String)

        The name of the field on which to sort.

        Possible values include:
        • "INITIATION_TIMESTAMP"
        • "SCHEDULED_TIMESTAMP"
        • "CONNECTED_TO_AGENT_TIMESTAMP"
        • "DISCONNECT_TIMESTAMP"
        • "INITIATION_METHOD"
        • "CHANNEL"
      • Orderrequired — (String)

        An ascending or descending sort.

        Possible values include:
        • "ASCENDING"
        • "DESCENDING"

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:

      • Contacts — (Array<map>)

        Information about the contacts.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the contact.

        • Id — (String)

          The identifier of the contact summary.

        • 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"
          • "DISCONNECT"
          • "MONITOR"
          • "EXTERNAL_OUTBOUND"
        • 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. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.

        • DisconnectTimestamp — (Date)

          The timestamp when the customer endpoint disconnected from Amazon Connect.

        • ScheduledTimestamp — (Date)

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

      • NextToken — (String)

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

      • TotalCount — (Integer)

        The total number of contacts which matched your search query.

Returns:

  • (AWS.Request)

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

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

Searches the hours of operation in an Amazon Connect instance, with optional filtering.

Service Reference:

Examples:

Calling the searchHoursOfOperations operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* HoursOfOperationSearchCriteria */
    AndConditions: [
      /* recursive HoursOfOperationSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive HoursOfOperationSearchCriteria */,
      /* 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.searchHoursOfOperations(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 instance ID in the Amazon Resource Name (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 hours of operations.

      • 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 values for FieldName are name, description, timezone, and resourceID.
          • 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 values for FieldName are name, description, timezone, and resourceID.
          • 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 values for FieldName are name, description, timezone, and resourceID.
        • 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:

      • HoursOfOperations — (Array<map>)

        Information about the hours of operations.

        • 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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • NextToken — (String)

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

      • ApproximateTotalCount — (Integer)

        The total number of hours of operations which matched your search query.

Returns:

  • (AWS.Request)

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

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

Predefined attributes that meet certain criteria.

Service Reference:

Examples:

Calling the searchPredefinedAttributes operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* PredefinedAttributeSearchCriteria */
    AndConditions: [
      /* recursive PredefinedAttributeSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive PredefinedAttributeSearchCriteria */,
      /* more items */
    ],
    StringCondition: {
      ComparisonType: STARTS_WITH | CONTAINS | EXACT,
      FieldName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    }
  }
};
connect.searchPredefinedAttributes(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 instance ID in the Amazon Resource Name (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 predefined attributes.

      • 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 values for FieldName are name and description.
          • 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 values for FieldName are name and description.
          • 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 values for FieldName are name and description.
        • 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:

      • PredefinedAttributes — (Array<map>)

        Predefined attributes matched by the search criteria.

        • Name — (String)

          The name of the predefined attribute.

        • Values — (map)

          The values of the predefined attribute.

          • StringList — (Array<String>)

            Predefined attribute values of type string list.

        • LastModifiedTime — (Date)

          Last modified time.

        • LastModifiedRegion — (String)

          Last modified region.

      • 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.

      • ApproximateTotalCount — (Integer)

        The approximate number of predefined attributes which matched your search query.

Returns:

  • (AWS.Request)

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

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

Searches prompts in an Amazon Connect instance, with optional filtering.

Service Reference:

Examples:

Calling the searchPrompts operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* PromptSearchCriteria */
    AndConditions: [
      /* recursive PromptSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive PromptSearchCriteria */,
      /* 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.searchPrompts(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 instance ID in the Amazon Resource Name (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 prompts.

      • 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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
        • 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:

      • Prompts — (Array<map>)

        Information about the prompts.

        • PromptARN — (String)

          The Amazon Resource Name (ARN) of the prompt.

        • PromptId — (String)

          A unique identifier for the prompt.

        • Name — (String)

          The name of the prompt.

        • Description — (String)

          The description of the prompt.

        • Tags — (map<String>)

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

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • NextToken — (String)

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

      • ApproximateTotalCount — (Integer)

        The total number of quick connects which matched your search query.

Returns:

  • (AWS.Request)

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

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

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 instance ID in the Amazon Resource Name (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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
        • 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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • 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.

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

Searches quick connects in an Amazon Connect instance, with optional filtering.

Service Reference:

Examples:

Calling the searchQuickConnects operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SearchCriteria: { /* QuickConnectSearchCriteria */
    AndConditions: [
      /* recursive QuickConnectSearchCriteria */,
      /* more items */
    ],
    OrConditions: [
      /* recursive QuickConnectSearchCriteria */,
      /* 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.searchQuickConnects(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 instance ID in the Amazon Resource Name (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 quick connects.

      • 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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
        • 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:

      • QuickConnects — (Array<map>)

        Information about the quick connects.

        • 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 admin website, 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" }.

        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

      • NextToken — (String)

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

      • ApproximateTotalCount — (Integer)

        The total number of quick connects which matched your search query.

Returns:

  • (AWS.Request)

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

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

Searches tags used in an Amazon Connect instance using optional search criteria.

Service Reference:

Examples:

Calling the searchResourceTags operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  SearchCriteria: {
    TagSearchCondition: {
      tagKey: 'STRING_VALUE',
      tagKeyComparisonType: STARTS_WITH | CONTAINS | EXACT,
      tagValue: 'STRING_VALUE',
      tagValueComparisonType: STARTS_WITH | CONTAINS | EXACT
    }
  }
};
connect.searchResourceTags(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 Amazon Resource Name (ARN) of the instance.

    • ResourceTypes — (Array<String>)

      The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.

    • 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 tags.

      • TagSearchCondition — (map)

        The search criteria to be used to return tags.

        • tagKey — (String)

          The tag key used in the tag search condition.

        • tagValue — (String)

          The tag value used in the tag search condition.

        • tagKeyComparisonType — (String)

          The type of comparison to be made when evaluating the tag key in tag search condition.

          Possible values include:
          • "STARTS_WITH"
          • "CONTAINS"
          • "EXACT"
        • tagValueComparisonType — (String)

          The type of comparison to be made when evaluating the tag value in tag search 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:

      • Tags — (Array<map>)

        A list of tags used in the Amazon Connect instance.

        • key — (String)

          The tag key in the tagSet.

        • value — (String)

          The tag value in the tagSet.

      • 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.

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

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 instance ID in the Amazon Resource Name (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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
          • 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 values for FieldName are name, description, and resourceID.
        • 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 instance ID in the Amazon Resource Name (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.

          • CrossChannelBehavior — (map)

            Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.

            • BehaviorTyperequired — (String)

              Specifies the other channels that can be routed to an agent handling their current channel.

              Possible values include:
              • "ROUTE_CURRENT_CHANNEL_ONLY"
              • "ROUTE_ANY_CHANNEL"
        • 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.

        • AgentAvailabilityTimer — (String)

          Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

          Possible values include:
          • "TIME_SINCE_LAST_ACTIVITY"
          • "TIME_SINCE_LAST_INBOUND"
        • LastModifiedTime — (Date)

          The timestamp when this resource was last modified.

        • LastModifiedRegion — (String)

          The Amazon Web Services Region where this resource was last modified.

        • IsDefault — (Boolean)

          Whether this a default 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

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 instance ID in the Amazon Resource Name (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 values for FieldName are name and description.
          • 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 values for FieldName are name and description.
          • 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 values for FieldName are name and description.
        • 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', /* required */
  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'
      }
    },
    UserAttributeFilter: {
      AndCondition: {
        HierarchyGroupCondition: {
          HierarchyGroupMatchType: EXACT | WITH_CHILD_GROUPS,
          Value: 'STRING_VALUE'
        },
        TagConditions: [
          {
            TagKey: 'STRING_VALUE',
            TagValue: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      HierarchyGroupCondition: {
        HierarchyGroupMatchType: EXACT | WITH_CHILD_GROUPS,
        Value: 'STRING_VALUE'
      },
      OrConditions: [
        {
          HierarchyGroupCondition: {
            HierarchyGroupMatchType: EXACT | WITH_CHILD_GROUPS,
            Value: 'STRING_VALUE'
          },
          TagConditions: [
            {
              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 instance ID in the Amazon Resource Name (ARN) of the instance.

      Note: InstanceID is a required field. The "Required: No" below is incorrect.
    • 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.

      • UserAttributeFilter — (map)

        An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

        This accepts an OR of AND (List of List) input where:

        • The top level list specifies conditions that need to be applied with OR operator.

        • The inner list specifies conditions that need to be applied with AND operator.

        Note: Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.
        • OrConditions — (Array<map>)

          A list of conditions which would be applied together with an OR condition.

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

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

          A list of conditions which would be applied together with an AND condition.

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

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

          A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

          • TagKey — (String)

            The tag key in the tag condition.

          • TagValue — (String)

            The tag value in the tag condition.

        • 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"
    • 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.

          The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.

          • 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.

          The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.

          • 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.

        The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.

        • 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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

            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 | en-NZ | en-ZA,
  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 instance ID in the Amazon Resource Name (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"
      • "en-NZ"
      • "en-ZA"

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"
          • "en-NZ"
          • "en-ZA"
        • 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.

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

Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

  • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

  • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

Service Reference:

Examples:

Calling the sendChatIntegrationEvent operation

var params = {
  DestinationId: 'STRING_VALUE', /* required */
  Event: { /* required */
    Type: DISCONNECT | MESSAGE | EVENT, /* required */
    Content: 'STRING_VALUE',
    ContentType: 'STRING_VALUE'
  },
  SourceId: 'STRING_VALUE', /* required */
  NewSessionDetails: {
    Attributes: {
      '<AttributeName>': 'STRING_VALUE',
      /* '<AttributeName>': ... */
    },
    ParticipantDetails: {
      DisplayName: 'STRING_VALUE' /* required */
    },
    StreamingConfiguration: {
      StreamingEndpointArn: 'STRING_VALUE' /* required */
    },
    SupportedMessagingContentTypes: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Subtype: 'STRING_VALUE'
};
connect.sendChatIntegrationEvent(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: {})
    • SourceId — (String)

      External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.

    • DestinationId — (String)

      Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.

    • Subtype — (String)

      Classification of a channel. This is used in part to uniquely identify chat.

      Valid value: ["connect:sms"]

    • Event — (map)

      Chat integration event payload

      • Typerequired — (String)

        Type of chat integration event.

        Possible values include:
        • "DISCONNECT"
        • "MESSAGE"
        • "EVENT"
      • ContentType — (String)

        Type of content. This is required when Type is MESSAGE or EVENT.

        • For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.

        • For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.

      • Content — (String)

        Content of the message or event. This is required when Type is MESSAGE and for certain ContentTypes when Type is EVENT.

        • For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.

        • For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.

    • NewSessionDetails — (map)

      Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.

      • SupportedMessagingContentTypes — (Array<String>)

        The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

        Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

      • ParticipantDetails — (map)

        The customer's details.

        • DisplayNamerequired — (String)

          Display name of the participant.

      • 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.

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

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:

      • InitialContactId — (String)

        Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.

      • NewChatCreated — (Boolean)

        Whether handling the integration event resulted in creating a new chat or acting on existing chat.

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 */
  },
  PersistentChat: {
    RehydrationType: ENTIRE_PAST_SESSION | FROM_SEGMENT,
    SourceContactId: 'STRING_VALUE'
  },
  RelatedContactId: 'STRING_VALUE',
  SegmentAttributes: {
    '<SegmentAttributeName>': {
      ValueString: 'STRING_VALUE'
    },
    /* '<SegmentAttributeName>': ... */
  },
  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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactFlowId — (String)

      The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, 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. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.

      • ContentTyperequired — (String)

        The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.

      • Contentrequired — (String)

        The content of the chat message.

        • For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.

        • For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.

        • For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.

    • 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 minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

    • SupportedMessagingContentTypes — (Array<String>)

      The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

      Note: The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.
    • PersistentChat — (map)

      Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

      • RehydrationType — (String)

        The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.

        • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.

        • FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the sourceContactId field.

        The actual contactId used for rehydration is provided in the response of this API.

        Possible values include:
        • "ENTIRE_PAST_SESSION"
        • "FROM_SEGMENT"
      • SourceContactId — (String)

        The contactId from which a persistent chat session must be started.

    • RelatedContactId — (String)

      The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

      Note: You cannot provide data for both RelatedContactId and PersistentChat.
    • SegmentAttributes — (map<map>)

      A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

      Attribute keys can include only alphanumeric, -, and _.

      This field can be used to show channel subtype, such as connect:Guide.

      Note: The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as "connect:Subtype": {"valueString" : "connect:Guide" }.
      • ValueString — (String)

        The value of a segment attribute.

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.

      • ContinuedFromContactId — (String)

        The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

Returns:

  • (AWS.Request)

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

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

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

Note: Evaluations created through the public API do not contain answer values suggested from automation.

Service Reference:

Examples:

Calling the startContactEvaluation operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  EvaluationFormId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connect.startContactEvaluation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactId — (String)

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

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • 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:

      • EvaluationId — (String)

        A unique identifier for the contact evaluation.

      • EvaluationArn — (String)

        The Amazon Resource Name (ARN) for the contact evaluation resource.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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',
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  QueueId: 'STRING_VALUE',
  References: {
    '<ReferenceKey>': {
      Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* '<ReferenceKey>': ... */
  },
  RelatedContactId: '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: {})
    • Name — (String)

      The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).

    • Description — (String)

      A description of the voice contact 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). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.

      • 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"
    • RelatedContactId — (String)

      The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

    • 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 admin website, 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 instance ID in the Amazon Resource Name (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 contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.

When using PreviousContactId and RelatedContactId input parameters, note the following:

  • PreviousContactId

    • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

    • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

  • RelatedContactId

    • Copies contact attributes from the related task contact to the new contact.

    • Any update on attributes in a new task contact does not update attributes on previous contact.

    • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.

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>': ... */
  },
  RelatedContactId: 'STRING_VALUE',
  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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PreviousContactId — (String)

      The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

    • ContactFlowId — (String)

      The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, 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). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

      • 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. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.

    • QuickConnectId — (String)

      The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

    • RelatedContactId — (String)

      The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

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.

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

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

Service Reference:

Examples:

Calling the startWebRTCContact operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ParticipantDetails: { /* required */
    DisplayName: 'STRING_VALUE' /* required */
  },
  AllowedCapabilities: {
    Agent: {
      Video: SEND
    },
    Customer: {
      Video: SEND
    }
  },
  Attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  References: {
    '<ReferenceKey>': {
      Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* '<ReferenceKey>': ... */
  },
  RelatedContactId: 'STRING_VALUE'
};
connect.startWebRTCContact(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: {})
    • 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, -, and _ characters.

    • 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.
    • ContactFlowId — (String)

      The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, 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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • AllowedCapabilities — (map)

      Information about the video sharing capabilities of the participants (customer, agent).

      • Customer — (map)

        Information about the customer's video sharing capabilities.

        • Video — (String)

          The configuration having the video sharing capabilities for participants over the call.

          Possible values include:
          • "SEND"
      • Agent — (map)

        Information about the agent's video sharing capabilities.

        • Video — (String)

          The configuration having the video sharing capabilities for participants over the call.

          Possible values include:
          • "SEND"
    • ParticipantDetails — (map)

      The customer's details.

      • DisplayNamerequired — (String)

        Display name of the participant.

    • RelatedContactId — (String)

      The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

    • References — (map<map>)

      A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

      • 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).

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:

      • ConnectionData — (map)

        Information required for the client application (mobile application or website) to connect to the call.

        • Attendee — (map)

          The attendee information, including attendee ID and join token.

          • AttendeeId — (String)

            The Amazon Chime SDK attendee ID.

          • JoinToken — (String)

            The join token used by the Amazon Chime SDK attendee.

        • Meeting — (map)

          A meeting created using the Amazon Chime SDK.

          • MediaRegion — (String)

            The Amazon Web Services Region in which you create the meeting.

          • MediaPlacement — (map)

            The media placement for the meeting.

            • AudioHostUrl — (String)

              The audio host URL.

            • AudioFallbackUrl — (String)

              The audio fallback URL.

            • SignalingUrl — (String)

              The signaling URL.

            • TurnControlUrl — (String)

              The turn control URL.

            • EventIngestionUrl — (String)

              The event ingestion URL to which you send client meeting events.

          • MeetingFeatures — (map)

            The configuration settings of the features available to a meeting.

            • Audio — (map)

              The configuration settings for the audio features available to a meeting.

              • EchoReduction — (String)

                Makes echo reduction available to clients who connect to the meeting.

                Possible values include:
                • "AVAILABLE"
                • "UNAVAILABLE"
          • MeetingId — (String)

            The Amazon Chime SDK meeting ID.

      • ContactId — (String)

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

      • ParticipantId — (String)

        The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.

      • ParticipantToken — (String)

        The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.

Returns:

  • (AWS.Request)

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

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

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

  • DISCONNECT

  • TRANSFER

  • QUEUE_TRANSFER

Chat and task contacts can be terminated in any state, regardless of initiation method.

Service Reference:

Examples:

Calling the stopContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  DisconnectReason: {
    Code: 'STRING_VALUE'
  }
};
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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • DisconnectReason — (map)

      The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.

      • Code — (String)

        A code that indicates how the contact was terminated.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

Service Reference:

Examples:

Calling the submitContactEvaluation operation

var params = {
  EvaluationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Answers: {
    '<ResourceId>': {
      Value: {
        NotApplicable: true || false,
        NumericValue: 'NUMBER_VALUE',
        StringValue: 'STRING_VALUE'
      }
    },
    /* '<ResourceId>': ... */
  },
  Notes: {
    '<ResourceId>': {
      Value: 'STRING_VALUE'
    },
    /* '<ResourceId>': ... */
  }
};
connect.submitContactEvaluation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationId — (String)

      A unique identifier for the contact evaluation.

    • Answers — (map<map>)

      A map of question identifiers to answer value.

      • Value — (map)

        The value for an answer in a contact evaluation.

        • StringValue — (String)

          The string value for an answer in a contact evaluation.

        • NumericValue — (Float)

          The numeric value for an answer in a contact evaluation.

        • NotApplicable — (Boolean)

          The flag to mark the question as not applicable.

    • Notes — (map<map>)

      A map of question identifiers to note value.

      • Value — (String)

        The note for an item (section or question) in a contact evaluation.

        Note: Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.

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:

      • EvaluationId — (String)

        A unique identifier for the contact evaluation.

      • EvaluationArn — (String)

        The Amazon Resource Name (ARN) for the contact evaluation resource.

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 whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

The period of time that the recording is suspended is filled with silence in the final recording.

Voice and screen recordings are supported.

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 instance ID in the Amazon Resource Name (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.

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

Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

Service Reference:

Examples:

Calling the tagContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<ContactTagKey>': 'STRING_VALUE',
    /* '<ContactTagKey>': ... */
  }
};
connect.tagContact(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 identifier of the contact in this instance of Amazon Connect.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • Tags — (map<String>)

      The tags to be assigned to the contact resource. For example, { "Tags": "key2":"value2" }.

      Note: Authorization is not supported by this tag.

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 instance ID in the Amazon Resource Name (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. This can be the ID or the ARN of 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.

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

Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

Service Reference:

Examples:

Calling the untagContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connect.untagContact(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 identifier of the contact in this instance of Amazon Connect.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • TagKeys — (Array<String>)

      A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (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.

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

Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

Service Reference:

Examples:

Calling the updateContactEvaluation operation

var params = {
  EvaluationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Answers: {
    '<ResourceId>': {
      Value: {
        NotApplicable: true || false,
        NumericValue: 'NUMBER_VALUE',
        StringValue: 'STRING_VALUE'
      }
    },
    /* '<ResourceId>': ... */
  },
  Notes: {
    '<ResourceId>': {
      Value: 'STRING_VALUE'
    },
    /* '<ResourceId>': ... */
  }
};
connect.updateContactEvaluation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationId — (String)

      A unique identifier for the contact evaluation.

    • Answers — (map<map>)

      A map of question identifiers to answer value.

      • Value — (map)

        The value for an answer in a contact evaluation.

        • StringValue — (String)

          The string value for an answer in a contact evaluation.

        • NumericValue — (Float)

          The numeric value for an answer in a contact evaluation.

        • NotApplicable — (Boolean)

          The flag to mark the question as not applicable.

    • Notes — (map<map>)

      A map of question identifiers to note value.

      • Value — (String)

        The note for an item (section or question) in a contact evaluation.

        Note: Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.

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:

      • EvaluationId — (String)

        A unique identifier for the contact evaluation.

      • EvaluationArn — (String)

        The Amazon Resource Name (ARN) for the contact evaluation resource.

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 the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

      Length Constraints: Minimum length of 1. Maximum length of 256000.

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 instance ID in the Amazon Resource Name (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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactFlowModuleId — (String)

      The identifier of the flow module.

    • Content — (String)

      The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

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 instance ID in the Amazon Resource Name (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.

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

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

Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

Service Reference:

Examples:

Calling the updateContactRoutingData operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  QueuePriority: 'NUMBER_VALUE',
  QueueTimeAdjustmentSeconds: 'NUMBER_VALUE'
};
connect.updateContactRoutingData(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactId — (String)

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

    • QueueTimeAdjustmentSeconds — (Integer)

      The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.

    • QueuePriority — (Integer)

      Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.

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 instance ID in the Amazon Resource Name (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.

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

Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

This operation does not support partial updates. Instead it does a full update of evaluation form content.

Service Reference:

Examples:

Calling the updateEvaluationForm operation

var params = {
  EvaluationFormId: 'STRING_VALUE', /* required */
  EvaluationFormVersion: 'NUMBER_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Items: [ /* EvaluationFormItemsList */ /* required */
    {
      Question: {
        QuestionType: TEXT | SINGLESELECT | NUMERIC, /* required */
        RefId: 'STRING_VALUE', /* required */
        Title: 'STRING_VALUE', /* required */
        Instructions: 'STRING_VALUE',
        NotApplicableEnabled: true || false,
        QuestionTypeProperties: {
          Numeric: {
            MaxValue: 'NUMBER_VALUE', /* required */
            MinValue: 'NUMBER_VALUE', /* required */
            Automation: {
              PropertyValue: {
                Label: OVERALL_CUSTOMER_SENTIMENT_SCORE | OVERALL_AGENT_SENTIMENT_SCORE | NON_TALK_TIME | NON_TALK_TIME_PERCENTAGE | NUMBER_OF_INTERRUPTIONS | CONTACT_DURATION | AGENT_INTERACTION_DURATION | CUSTOMER_HOLD_TIME /* required */
              }
            },
            Options: [
              {
                MaxValue: 'NUMBER_VALUE', /* required */
                MinValue: 'NUMBER_VALUE', /* required */
                AutomaticFail: true || false,
                Score: 'NUMBER_VALUE'
              },
              /* more items */
            ]
          },
          SingleSelect: {
            Options: [ /* required */
              {
                RefId: 'STRING_VALUE', /* required */
                Text: 'STRING_VALUE', /* required */
                AutomaticFail: true || false,
                Score: 'NUMBER_VALUE'
              },
              /* more items */
            ],
            Automation: {
              Options: [ /* required */
                {
                  RuleCategory: {
                    Category: 'STRING_VALUE', /* required */
                    Condition: PRESENT | NOT_PRESENT, /* required */
                    OptionRefId: 'STRING_VALUE' /* required */
                  }
                },
                /* more items */
              ],
              DefaultOptionRefId: 'STRING_VALUE'
            },
            DisplayAs: DROPDOWN | RADIO
          }
        },
        Weight: 'NUMBER_VALUE'
      },
      Section: {
        Items: /* recursive EvaluationFormItemsList */,
        RefId: 'STRING_VALUE', /* required */
        Title: 'STRING_VALUE', /* required */
        Instructions: 'STRING_VALUE',
        Weight: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  Title: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  CreateNewVersion: true || false,
  Description: 'STRING_VALUE',
  ScoringStrategy: {
    Mode: QUESTION_ONLY | SECTION_ONLY, /* required */
    Status: ENABLED | DISABLED /* required */
  }
};
connect.updateEvaluationForm(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • EvaluationFormId — (String)

      The unique identifier for the evaluation form.

    • EvaluationFormVersion — (Integer)

      A version of the evaluation form to update.

    • CreateNewVersion — (Boolean)

      A flag indicating whether the operation must create a new version.

    • Title — (String)

      A title of the evaluation form.

    • Description — (String)

      The description of the evaluation form.

    • Items — (Array<map>)

      Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

      • Section — (map)

        The information of the section.

        • Titlerequired — (String)

          The title of the section.

        • RefIdrequired — (String)

          The identifier of the section. An identifier must be unique within the evaluation form.

        • Instructions — (String)

          The instructions of the section.

        • Itemsrequired — (Array<map>)

          The items of the section.

        • Weight — (Float)

          The scoring weight of the section.

      • Question — (map)

        The information of the question.

        • Titlerequired — (String)

          The title of the question.

        • Instructions — (String)

          The instructions of the section.

        • RefIdrequired — (String)

          The identifier of the question. An identifier must be unique within the evaluation form.

        • NotApplicableEnabled — (Boolean)

          The flag to enable not applicable answers to the question.

        • QuestionTyperequired — (String)

          The type of the question.

          Possible values include:
          • "TEXT"
          • "SINGLESELECT"
          • "NUMERIC"
        • QuestionTypeProperties — (map)

          The properties of the type of question. Text questions do not have to define question type properties.

          • Numeric — (map)

            The properties of the numeric question.

            • MinValuerequired — (Integer)

              The minimum answer value.

            • MaxValuerequired — (Integer)

              The maximum answer value.

            • Options — (Array<map>)

              The scoring options of the numeric question.

              • MinValuerequired — (Integer)

                The minimum answer value of the range option.

              • MaxValuerequired — (Integer)

                The maximum answer value of the range option.

              • Score — (Integer)

                The score assigned to answer values within the range option.

              • AutomaticFail — (Boolean)

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

            • Automation — (map)

              The automation properties of the numeric question.

              • PropertyValue — (map)

                The property value of the automation.

                • Labelrequired — (String)

                  The property label of the automation.

                  Possible values include:
                  • "OVERALL_CUSTOMER_SENTIMENT_SCORE"
                  • "OVERALL_AGENT_SENTIMENT_SCORE"
                  • "NON_TALK_TIME"
                  • "NON_TALK_TIME_PERCENTAGE"
                  • "NUMBER_OF_INTERRUPTIONS"
                  • "CONTACT_DURATION"
                  • "AGENT_INTERACTION_DURATION"
                  • "CUSTOMER_HOLD_TIME"
          • SingleSelect — (map)

            The properties of the numeric question.

            • Optionsrequired — (Array<map>)

              The answer options of the single select question.

              • RefIdrequired — (String)

                The identifier of the answer option. An identifier must be unique within the question.

              • Textrequired — (String)

                The title of the answer option.

              • Score — (Integer)

                The score assigned to the answer option.

              • AutomaticFail — (Boolean)

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

            • DisplayAs — (String)

              The display mode of the single select question.

              Possible values include:
              • "DROPDOWN"
              • "RADIO"
            • Automation — (map)

              The display mode of the single select question.

              • Optionsrequired — (Array<map>)

                The automation options of the single select question.

                • RuleCategory — (map)

                  The automation option based on a rule category for the single select question.

                  • Categoryrequired — (String)

                    The category name, as defined in Rules.

                  • Conditionrequired — (String)

                    The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                    Possible values include:
                    • "PRESENT"
                    • "NOT_PRESENT"
                  • OptionRefIdrequired — (String)

                    The identifier of the answer option.

              • DefaultOptionRefId — (String)

                The identifier of the default answer option, when none of the automation options match the criteria.

        • Weight — (Float)

          The scoring weight of the section.

    • ScoringStrategy — (map)

      A scoring strategy of the evaluation form.

      • Moderequired — (String)

        The scoring mode of the evaluation form.

        Possible values include:
        • "QUESTION_ONLY"
        • "SECTION_ONLY"
      • Statusrequired — (String)

        The scoring status of the evaluation form.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • 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:

      • EvaluationFormId — (String)

        The unique identifier for the evaluation form.

      • EvaluationFormArn — (String)

        The Amazon Resource Name (ARN) for the contact evaluation resource.

      • EvaluationFormVersion — (Integer)

        The version of the updated evaluation form resource.

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 instance ID in the Amazon Resource Name (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 | ENHANCED_CHAT_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 instance ID in the Amazon Resource Name (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"
      • "ENHANCED_CHAT_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 | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_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 instance ID in the Amazon Resource Name (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"
      • "ATTACHMENTS"
      • "CONTACT_EVALUATIONS"
      • "SCREEN_RECORDINGS"
      • "REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS"
      • "REAL_TIME_CONTACT_ANALYSIS_VOICE_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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
      • 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. Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .
      • 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.

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

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

  • Customer idle timeout

  • Customer auto-disconnect timeout

  • Agent idle timeout

  • Agent auto-disconnect timeout

For more information about how chat timeouts work, see Set up chat timeouts for human participants.

Service Reference:

Examples:

Calling the updateParticipantRoleConfig operation

var params = {
  ChannelConfiguration: { /* required */
    Chat: {
      ParticipantTimerConfigList: [ /* required */
        {
          ParticipantRole: CUSTOMER | AGENT, /* required */
          TimerType: IDLE | DISCONNECT_NONCUSTOMER, /* required */
          TimerValue: { /* required */
            ParticipantTimerAction: Unset,
            ParticipantTimerDurationInMinutes: 'NUMBER_VALUE'
          }
        },
        /* more items */
      ]
    }
  },
  ContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.updateParticipantRoleConfig(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • ContactId — (String)

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

    • ChannelConfiguration — (map)

      The Amazon Connect channel you want to configure.

      • Chat — (map)

        Configuration information for the chat participant role.

        • ParticipantTimerConfigListrequired — (Array<map>)

          A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.

          • ParticipantRolerequired — (String)

            The role of the participant in the chat conversation.

            Possible values include:
            • "CUSTOMER"
            • "AGENT"
          • TimerTyperequired — (String)

            The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to idleness.

            Possible values include:
            • "IDLE"
            • "DISCONNECT_NONCUSTOMER"
          • TimerValuerequired — (map)

            The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.

            • ParticipantTimerAction — (String)

              The timer action. Currently only one value is allowed: Unset. It deletes a timer.

              Possible values include:
              • "Unset"
            • ParticipantTimerDurationInMinutes — (Integer)

              The duration of a timer, in 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.

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.

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

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 */
  ClientToken: 'STRING_VALUE',
  InstanceId: 'STRING_VALUE',
  TargetArn: '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 number inbound traffic is routed through. You must enter InstanceId or TargetArn.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

    • 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.

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

Updates a phone number’s metadata.

To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

Service Reference:

Examples:

Calling the updatePhoneNumberMetadata operation

var params = {
  PhoneNumberId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  PhoneNumberDescription: 'STRING_VALUE'
};
connect.updatePhoneNumberMetadata(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)

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

    • PhoneNumberDescription — (String)

      The description of 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.

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

Updates a predefined attribute for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the updatePredefinedAttribute operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Values: {
    StringList: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
connect.updatePredefinedAttribute(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the predefined attribute.

    • Values — (map)

      The values of the predefined attribute.

      • StringList — (Array<String>)

        Predefined attribute values of type string 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.

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

Updates a prompt.

Service Reference:

Examples:

Calling the updatePrompt operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PromptId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  S3Uri: 'STRING_VALUE'
};
connect.updatePrompt(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • PromptId — (String)

      A unique identifier for the prompt.

    • Name — (String)

      The name of the prompt.

    • Description — (String)

      A description of the prompt.

    • S3Uri — (String)

      The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

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:

      • PromptARN — (String)

        The Amazon Resource Name (ARN) of the prompt.

      • PromptId — (String)

        A unique identifier for the prompt.

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:

Examples:

Calling the updateQueueHoursOfOperation operation

var params = {
  HoursOfOperationId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE' /* required */
};
connect.updateQueueHoursOfOperation(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • 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.

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

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

Updates the maximum number of contacts allowed in a queue before it is considered full.

Service Reference:

Examples:

Calling the updateQueueMaxContacts operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  MaxContacts: 'NUMBER_VALUE'
};
connect.updateQueueMaxContacts(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • MaxContacts — (Integer)

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

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.

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

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

Updates the name and description of a queue. At least Name or Description must be provided.

Service Reference:

Examples:

Calling the updateQueueName operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
connect.updateQueueName(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • Name — (String)

      The name of the queue.

    • Description — (String)

      The description of 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.

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

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

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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.

  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

Service Reference:

Examples:

Calling the updateQueueOutboundCallerConfig operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  OutboundCallerConfig: { /* required */
    OutboundCallerIdName: 'STRING_VALUE',
    OutboundCallerIdNumberId: 'STRING_VALUE',
    OutboundFlowId: 'STRING_VALUE'
  },
  QueueId: 'STRING_VALUE' /* required */
};
connect.updateQueueOutboundCallerConfig(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QueueId — (String)

      The identifier for 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.

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.

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

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

Updates the status of the queue.

Service Reference:

Examples:

Calling the updateQueueStatus operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QueueId: 'STRING_VALUE', /* required */
  Status: ENABLED | DISABLED /* required */
};
connect.updateQueueStatus(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QueueId — (String)

      The identifier for the queue.

    • Status — (String)

      The status of the queue.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

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.

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

Updates the configuration settings for the specified quick connect.

Service Reference:

Examples:

Calling the updateQuickConnectConfig operation

var params = {
  InstanceId: '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 */
    }
  },
  QuickConnectId: 'STRING_VALUE' /* required */
};
connect.updateQuickConnectConfig(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QuickConnectId — (String)

      The identifier for the quick connect.

    • QuickConnectConfig — (map)

      Information about the configuration settings for the quick connect.

      • QuickConnectTyperequired — (String)

        The type of quick connect. In the Amazon Connect admin website, 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.

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.

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

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

Service Reference:

Examples:

Calling the updateQuickConnectName operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  QuickConnectId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
connect.updateQuickConnectName(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • QuickConnectId — (String)

      The identifier for the quick connect.

    • Name — (String)

      The name of the quick connect.

    • Description — (String)

      The description of 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.

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

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

Examples:

Calling the updateRoutingProfileAgentAvailabilityTimer operation

var params = {
  AgentAvailabilityTimer: TIME_SINCE_LAST_ACTIVITY | TIME_SINCE_LAST_INBOUND, /* required */
  InstanceId: 'STRING_VALUE', /* required */
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.updateRoutingProfileAgentAvailabilityTimer(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • AgentAvailabilityTimer — (String)

      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

      Possible values include:
      • "TIME_SINCE_LAST_ACTIVITY"
      • "TIME_SINCE_LAST_INBOUND"

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.

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

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

Service Reference:

Examples:

Calling the updateRoutingProfileConcurrency operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MediaConcurrencies: [ /* required */
    {
      Channel: VOICE | CHAT | TASK, /* required */
      Concurrency: 'NUMBER_VALUE', /* required */
      CrossChannelBehavior: {
        BehaviorType: ROUTE_CURRENT_CHANNEL_ONLY | ROUTE_ANY_CHANNEL /* required */
      }
    },
    /* more items */
  ],
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.updateRoutingProfileConcurrency(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • MediaConcurrencies — (Array<map>)

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

      • 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.

      • CrossChannelBehavior — (map)

        Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.

        • BehaviorTyperequired — (String)

          Specifies the other channels that can be routed to an agent handling their current channel.

          Possible values include:
          • "ROUTE_CURRENT_CHANNEL_ONLY"
          • "ROUTE_ANY_CHANNEL"

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.

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

Updates the default outbound queue of a routing profile.

Examples:

Calling the updateRoutingProfileDefaultOutboundQueue operation

var params = {
  DefaultOutboundQueueId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  RoutingProfileId: 'STRING_VALUE' /* required */
};
connect.updateRoutingProfileDefaultOutboundQueue(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • DefaultOutboundQueueId — (String)

      The identifier for the default outbound 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.

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

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

Service Reference:

Examples:

Calling the updateRoutingProfileName operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  RoutingProfileId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
connect.updateRoutingProfileName(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • Name — (String)

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

    • Description — (String)

      The description of the routing profile. Must not be more than 250 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.

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

Updates the properties associated with a set of queues for a routing profile.

Service Reference:

Examples:

Calling the updateRoutingProfileQueues 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.updateRoutingProfileQueues(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • RoutingProfileId — (String)

      The identifier of the routing profile.

    • QueueConfigs — (Array<map>)

      The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.

      • 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.

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

Updates a rule for the specified Amazon Connect instance.

Use the Rules Function language to code conditions for the rule.

Service Reference:

Examples:

Calling the updateRule operation

var params = {
  Actions: [ /* required */
    {
      ActionType: CREATE_TASK | ASSIGN_CONTACT_CATEGORY | GENERATE_EVENTBRIDGE_EVENT | SEND_NOTIFICATION | CREATE_CASE | UPDATE_CASE | END_ASSOCIATED_TASKS, /* required */
      AssignContactCategoryAction: {
      },
      CreateCaseAction: {
        Fields: [ /* required */
          {
            Id: 'STRING_VALUE', /* required */
            Value: { /* required */
              BooleanValue: true || false,
              DoubleValue: 'NUMBER_VALUE',
              EmptyValue: {
              },
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        TemplateId: 'STRING_VALUE' /* required */
      },
      EndAssociatedTasksAction: {
      },
      EventBridgeAction: {
        Name: 'STRING_VALUE' /* required */
      },
      SendNotificationAction: {
        Content: 'STRING_VALUE', /* required */
        ContentType: PLAIN_TEXT, /* required */
        DeliveryMethod: EMAIL, /* required */
        Recipient: { /* required */
          UserIds: [
            'STRING_VALUE',
            /* more items */
          ],
          UserTags: {
            '<String>': 'STRING_VALUE',
            /* '<String>': ... */
          }
        },
        Subject: 'STRING_VALUE'
      },
      TaskAction: {
        ContactFlowId: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        Description: 'STRING_VALUE',
        References: {
          '<ReferenceKey>': {
            Type: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL, /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* '<ReferenceKey>': ... */
        }
      },
      UpdateCaseAction: {
        Fields: [ /* required */
          {
            Id: 'STRING_VALUE', /* required */
            Value: { /* required */
              BooleanValue: true || false,
              DoubleValue: 'NUMBER_VALUE',
              EmptyValue: {
              },
              StringValue: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  Function: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  PublishStatus: DRAFT | PUBLISHED, /* required */
  RuleId: 'STRING_VALUE' /* required */
};
connect.updateRule(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: {})
    • RuleId — (String)

      A unique identifier for the rule.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • Name — (String)

      The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

    • Function — (String)

      The conditions of the rule.

    • Actions — (Array<map>)

      A list of actions to be run when the rule is triggered.

      • ActionTyperequired — (String)

        The type of action that creates a rule.

        Possible values include:
        • "CREATE_TASK"
        • "ASSIGN_CONTACT_CATEGORY"
        • "GENERATE_EVENTBRIDGE_EVENT"
        • "SEND_NOTIFICATION"
        • "CREATE_CASE"
        • "UPDATE_CASE"
        • "END_ASSOCIATED_TASKS"
      • TaskAction — (map)

        Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

        • Namerequired — (String)

          The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • Description — (String)

          The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • ContactFlowIdrequired — (String)

          The identifier of the flow.

        • References — (map<map>)

          Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)

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

        Information about the EventBridge action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

        • Namerequired — (String)

          The name.

      • AssignContactCategoryAction — (map)

        Information about the contact category action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

      • SendNotificationAction — (map)

        Information about the send notification action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

        • DeliveryMethodrequired — (String)

          Notification delivery method.

          Possible values include:
          • "EMAIL"
        • Subject — (String)

          The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • Contentrequired — (String)

          Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.

        • ContentTyperequired — (String)

          Content type format.

          Possible values include:
          • "PLAIN_TEXT"
        • Recipientrequired — (map)

          Notification recipient.

          • UserTags — (map<String>)

            The tags used to organize, track, or control access for this resource. For example, { "Tags": "key2":"value2" }. Amazon Connect users with the specified tags will be notified.

          • UserIds — (Array<String>)

            A list of user IDs.

      • CreateCaseAction — (map)

        Information about the create case action.

        Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.

        • Fieldsrequired — (Array<map>)

          An array of objects with Field ID and Value data.

          • Idrequired — (String)

            Unique identifier of a field.

          • Valuerequired — (map)

            Union of potential field value types.

            • BooleanValue — (Boolean)

              A Boolean number value type.

            • DoubleValue — (Float)

              a Double number value type.

            • EmptyValue — (map)

              An empty value.

            • StringValue — (String)

              String value type.

        • TemplateIdrequired — (String)

          A unique identifier of a template.

      • UpdateCaseAction — (map)

        Information about the update case action.

        Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.

        • Fieldsrequired — (Array<map>)

          An array of objects with Field ID and Value data.

          • Idrequired — (String)

            Unique identifier of a field.

          • Valuerequired — (map)

            Union of potential field value types.

            • BooleanValue — (Boolean)

              A Boolean number value type.

            • DoubleValue — (Float)

              a Double number value type.

            • EmptyValue — (map)

              An empty value.

            • StringValue — (String)

              String value type.

      • EndAssociatedTasksAction — (map)

        Information about the end associated tasks action.

        Supported only for TriggerEventSource values: OnCaseUpdate.

    • PublishStatus — (String)

      The publish status of the rule.

      Possible values include:
      • "DRAFT"
      • "PUBLISHED"

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.

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

Updates a security profile.

Service Reference:

Examples:

Calling the updateSecurityProfile operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  SecurityProfileId: 'STRING_VALUE', /* required */
  AllowedAccessControlHierarchyGroupId: 'STRING_VALUE',
  AllowedAccessControlTags: {
    '<SecurityProfilePolicyKey>': 'STRING_VALUE',
    /* '<SecurityProfilePolicyKey>': ... */
  },
  Applications: [
    {
      ApplicationPermissions: [
        'STRING_VALUE',
        /* more items */
      ],
      Namespace: 'STRING_VALUE'
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  HierarchyRestrictedResources: [
    'STRING_VALUE',
    /* more items */
  ],
  Permissions: [
    'STRING_VALUE',
    /* more items */
  ],
  TagRestrictedResources: [
    'STRING_VALUE',
    /* more items */
  ]
};
connect.updateSecurityProfile(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: {})
    • Description — (String)

      The description of the security profile.

    • Permissions — (Array<String>)

      The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.

    • SecurityProfileId — (String)

      The identifier for the security profle.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • 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.

    • Applications — (Array<map>)

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

      A list of the third-party application's metadata.

      • Namespace — (String)

        Namespace of the application that you want to give access to.

      • ApplicationPermissions — (Array<String>)

        The permissions that the agent is granted on the application. Only the ACCESS permission is supported.

    • HierarchyRestrictedResources — (Array<String>)

      The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

    • AllowedAccessControlHierarchyGroupId — (String)

      The identifier of the hierarchy group that a security profile uses to restrict access to resources 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.

Returns:

  • (AWS.Request)

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

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

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

Service Reference:

Examples:

Calling the updateTaskTemplate operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  TaskTemplateId: 'STRING_VALUE', /* required */
  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',
  Fields: [
    {
      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 */
  ],
  Name: 'STRING_VALUE',
  Status: ACTIVE | INACTIVE
};
connect.updateTaskTemplate(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: {})
    • TaskTemplateId — (String)

      A unique identifier for the task template.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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 instance ID in the Amazon Resource Name (ARN) of the instance.

      • Id — (String)

        The identifier of the task template resource.

      • Arn — (String)

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

      • 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.

Returns:

  • (AWS.Request)

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

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

Updates the traffic distribution for a given traffic distribution group.

Note: The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the updateTrafficDistribution operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AgentConfig: {
    Distributions: [ /* required */
      {
        Percentage: 'NUMBER_VALUE', /* required */
        Region: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  SignInConfig: {
    Distributions: [ /* required */
      {
        Enabled: true || false, /* required */
        Region: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  TelephonyConfig: {
    Distributions: [ /* required */
      {
        Percentage: 'NUMBER_VALUE', /* required */
        Region: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  }
};
connect.updateTrafficDistribution(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. 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.

    • TelephonyConfig — (map)

      The distribution of traffic between the instance and its replica(s).

      • 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.

    • SignInConfig — (map)

      The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

      • Distributionsrequired — (Array<map>)

        Information about traffic distributions.

        • Regionrequired — (String)

          The Amazon Web Services Region of the sign in distribution.

        • Enabledrequired — (Boolean)

          Whether sign in distribution is enabled.

    • AgentConfig — (map)

      The distribution of agents between the instance and its replica(s).

      • 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.

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.

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

Assigns the specified hierarchy group to the specified user.

Service Reference:

Examples:

Calling the updateUserHierarchy operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  HierarchyGroupId: 'STRING_VALUE'
};
connect.updateUserHierarchy(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.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Updates the name of the user hierarchy group.

Service Reference:

Examples:

Calling the updateUserHierarchyGroupName operation

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

    • HierarchyGroupId — (String)

      The identifier of the hierarchy group.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

Service Reference:

Examples:

Calling the updateUserHierarchyStructure operation

var params = {
  HierarchyStructure: { /* required */
    LevelFive: {
      Name: 'STRING_VALUE' /* required */
    },
    LevelFour: {
      Name: 'STRING_VALUE' /* required */
    },
    LevelOne: {
      Name: 'STRING_VALUE' /* required */
    },
    LevelThree: {
      Name: 'STRING_VALUE' /* required */
    },
    LevelTwo: {
      Name: 'STRING_VALUE' /* required */
    }
  },
  InstanceId: 'STRING_VALUE' /* required */
};
connect.updateUserHierarchyStructure(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: {})
    • HierarchyStructure — (map)

      The hierarchy levels to update.

      • LevelOne — (map)

        The update for level one.

        • Namerequired — (String)

          The name of the user hierarchy level. Must not be more than 50 characters.

      • LevelTwo — (map)

        The update for level two.

        • Namerequired — (String)

          The name of the user hierarchy level. Must not be more than 50 characters.

      • LevelThree — (map)

        The update for level three.

        • Namerequired — (String)

          The name of the user hierarchy level. Must not be more than 50 characters.

      • LevelFour — (map)

        The update for level four.

        • Namerequired — (String)

          The name of the user hierarchy level. Must not be more than 50 characters.

      • LevelFive — (map)

        The update for level five.

        • Namerequired — (String)

          The name of the user hierarchy level. Must not be more than 50 characters.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Updates the identity information for the specified user.

We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the updateUserIdentityInfo operation

var params = {
  IdentityInfo: { /* required */
    Email: 'STRING_VALUE',
    FirstName: 'STRING_VALUE',
    LastName: 'STRING_VALUE',
    Mobile: 'STRING_VALUE',
    SecondaryEmail: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.updateUserIdentityInfo(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: {})
    • IdentityInfo — (map)

      The identity information for 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.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Updates the phone configuration settings for the specified user.

Service Reference:

Examples:

Calling the updateUserPhoneConfig operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PhoneConfig: { /* required */
    PhoneType: SOFT_PHONE | DESK_PHONE, /* required */
    AfterContactWorkTimeLimit: 'NUMBER_VALUE',
    AutoAccept: true || false,
    DeskPhoneNumber: 'STRING_VALUE'
  },
  UserId: 'STRING_VALUE' /* required */
};
connect.updateUserPhoneConfig(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: {})
    • PhoneConfig — (map)

      Information about phone configuration 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. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

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

        The phone number for the user's desk phone.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Updates the properties associated with the proficiencies of a user.

Service Reference:

Examples:

Calling the updateUserProficiencies operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  UserProficiencies: [ /* required */
    {
      AttributeName: 'STRING_VALUE', /* required */
      AttributeValue: 'STRING_VALUE', /* required */
      Level: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ]
};
connect.updateUserProficiencies(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 instance ID in the Amazon Resource Name (ARN) of the instance.

    • UserId — (String)

      The identifier of the user account.

    • UserProficiencies — (Array<map>)

      The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.

      • AttributeNamerequired — (String)

        The name of user's proficiency. You must use name of predefined attribute present in the Amazon Connect instance.

      • AttributeValuerequired — (String)

        The value of user's proficiency. You must use value of predefined attribute present in the Amazon Connect instance.

      • Levelrequired — (Float)

        The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.

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.

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

Assigns the specified routing profile to the specified user.

Service Reference:

Examples:

Calling the updateUserRoutingProfile operation

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

      The identifier of the routing profile for the user.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Assigns the specified security profiles to the specified user.

Service Reference:

Examples:

Calling the updateUserSecurityProfiles operation

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

      The identifiers of the security profiles for the user.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (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.

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

Updates the view content of the given view identifier in the specified Amazon Connect instance.

It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.

Service Reference:

Examples:

Calling the updateViewContent operation

var params = {
  Content: { /* required */
    Actions: [
      'STRING_VALUE',
      /* more items */
    ],
    Template: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  Status: PUBLISHED | SAVED, /* required */
  ViewId: 'STRING_VALUE' /* required */
};
connect.updateViewContent(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.

    • ViewId — (String)

      The identifier of the view. Both ViewArn and ViewId can be used.

    • Status — (String)

      Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

      Possible values include:
      • "PUBLISHED"
      • "SAVED"
    • Content — (map)

      View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.

      The total uncompressed content has a maximum file size of 400kB.

      • Template — (String)

        The view template representing the structure of the view.

      • Actions — (Array<String>)

        A list of possible actions from the view.

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:

      • View — (map)

        A view resource object. Contains metadata and content necessary to render the view.

        • Id — (String)

          The identifier of the view.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the view.

        • Name — (String)

          The name of the view.

        • Status — (String)

          Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

          Possible values include:
          • "PUBLISHED"
          • "SAVED"
        • Type — (String)

          The type of the view - CUSTOMER_MANAGED.

          Possible values include:
          • "CUSTOMER_MANAGED"
          • "AWS_MANAGED"
        • Description — (String)

          The description of the view.

        • Version — (Integer)

          Current version of the view.

        • VersionDescription — (String)

          The description of the version.

        • Content — (map)

          View content containing all content necessary to render a view except for runtime input data.

          • InputSchema — (String)

            The data schema matching data that the view template must be provided to render.

          • Template — (String)

            The view template representing the structure of the view.

          • Actions — (Array<String>)

            A list of possible actions from the view.

        • Tags — (map<String>)

          The tags associated with the view resource (not specific to view version).

        • CreatedTime — (Date)

          The timestamp of when the view was created.

        • LastModifiedTime — (Date)

          Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

        • ViewContentSha256 — (String)

          Indicates the checksum value of the latest published view content.

Returns:

  • (AWS.Request)

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

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

Updates the view metadata. Note that either Name or Description must be provided.

Service Reference:

Examples:

Calling the updateViewMetadata operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ViewId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
connect.updateViewMetadata(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.

    • ViewId — (String)

      The identifier of the view. Both ViewArn and ViewId can be used.

    • Name — (String)

      The name of the view.

    • Description — (String)

      The description of the view.

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.