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.

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

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

Service Reference:

Examples:

Calling the batchGetAttachedFileMetadata operation

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

Parameters:

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

      The unique identifiers of the attached file resource.

    • InstanceId — (String)

      The unique identifier of the Connect instance.

    • AssociatedResourceArn — (String)

      The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

      Note: This value must be a valid 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:

      • Files — (Array<map>)

        List of attached files that were successfully retrieved.

        • CreationTimerequired — (String)

          The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

        • FileArnrequired — (String)

          The unique identifier of the attached file resource (ARN).

        • FileIdrequired — (String)

          The unique identifier of the attached file resource.

        • FileNamerequired — (String)

          A case-sensitive name of the attached file being uploaded.

        • FileSizeInBytesrequired — (Integer)

          The size of the attached file in bytes.

        • FileStatusrequired — (String)

          The current status of the attached file.

          Possible values include:
          • "APPROVED"
          • "REJECTED"
          • "PROCESSING"
          • "FAILED"
        • CreatedBy — (map)

          Represents the identity that created the file.

          • ConnectUserArn — (String)

            An agent ARN representing a connect user.

          • AWSIdentityArn — (String)

            STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

        • FileUseCaseType — (String)

          The use case for the file.

          Possible values include:
          • "ATTACHMENT"
        • AssociatedResourceArn — (String)

          The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

          Note: This value must be a valid ARN.
        • Tags — (map<String>)

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

      • Errors — (Array<map>)

        List of errors of attached files that could not be retrieved.

        • ErrorCode — (String)

          Status code describing the failure.

        • ErrorMessage — (String)

          Why the attached file couldn't be retrieved.

        • FileId — (String)

          The unique identifier of the attached file resource.

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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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.

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

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

Service Reference:

Examples:

Calling the completeAttachedFileUpload operation

var params = {
  AssociatedResourceArn: 'STRING_VALUE', /* required */
  FileId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.completeAttachedFileUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Connect instance.

    • FileId — (String)

      The unique identifier of the attached file resource.

    • AssociatedResourceArn — (String)

      The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

      Note: This value must be a valid 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.

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',
  Status: PUBLISHED | SAVED,
  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.

    • Status — (String)

      Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

      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" }.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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 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 | SUBMIT_AUTO_EVALUATION, /* 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'
      },
      SubmitAutoEvaluationAction: {
        EvaluationFormId: 'STRING_VALUE' /* required */
      },
      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"
        • "SUBMIT_AUTO_EVALUATION"
      • 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.

      • SubmitAutoEvaluationAction — (map)

        Information about the submit automated evaluation action.

        • EvaluationFormIdrequired — (String)

          The identifier of the auto-evaluation enabled form.

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

      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.

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

Deletes an attached file along with the underlying S3 Object.

The attached file is permanently deleted if S3 bucket versioning is not enabled.

Service Reference:

Examples:

Calling the deleteAttachedFile operation

var params = {
  AssociatedResourceArn: 'STRING_VALUE', /* required */
  FileId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.deleteAttachedFile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Connect instance.

    • FileId — (String)

      The unique identifier of the attached file resource.

    • AssociatedResourceArn — (String)

      The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

      Note: This value must be a valid 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.

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.

          • HierarchyGroups — (map)

            The agent hierarchy groups for the agent.

            • Level1 — (map)

              The group at level one of the agent hierarchy.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the group.

            • Level2 — (map)

              The group at level two of the agent hierarchy.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the group.

            • Level3 — (map)

              The group at level three of the agent hierarchy.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the group.

            • Level4 — (map)

              The group at level four of the agent hierarchy.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the group.

            • Level5 — (map)

              The group at level five of the agent hierarchy.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the group.

          • DeviceInfo — (map)

            Information regarding Agent’s device.

            • PlatformName — (String)

              Name of the platform that the participant used for the call.

            • PlatformVersion — (String)

              Version of the platform that the participant used for the call.

            • OperatingSystem — (String)

              Operating system that the participant used for the call.

          • Capabilities — (map)

            The configuration for the allowed capabilities for participants present over the call.

            • Video — (String)

              The configuration having the video sharing capabilities for participants over the call.

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

        • ConnectedToSystemTimestamp — (Date)

          The timestamp when customer endpoint connected to Amazon Connect.

        • RoutingCriteria — (map)

          Latest routing criteria on the contact.

          • Steps — (Array<map>)

            List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.

            • Expiry — (map)

              An object to specify the expiration of a routing step.

              • DurationInSeconds — (Integer)

                The number of seconds to wait before expiring the routing step.

              • ExpiryTimestamp — (Date)

                The timestamp indicating when the routing step expires.

            • Expression — (map)

              A tagged union to specify expression for a routing step.

              • AttributeCondition — (map)

                An object to specify the predefined attribute condition.

                • Name — (String)

                  The name of predefined attribute.

                • Value — (String)

                  The value of predefined attribute.

                • ProficiencyLevel — (Float)

                  The proficiency level of the condition.

                • ComparisonOperator — (String)

                  The operator of the condition.

              • AndExpression — (Array<map>)

                List of routing expressions which will be AND-ed together.

              • OrExpression — (Array<map>)

                List of routing expressions which will be OR-ed together.

            • Status — (String)

              Represents status of the Routing step.

              Possible values include:
              • "ACTIVE"
              • "INACTIVE"
              • "JOINED"
              • "EXPIRED"
          • ActivationTimestamp — (Date)

            The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.

          • Index — (Integer)

            Information about the index of the routing criteria.

        • Customer — (map)

          Information about the Customer on the contact.

          • DeviceInfo — (map)

            Information regarding Customer’s device.

            • PlatformName — (String)

              Name of the platform that the participant used for the call.

            • PlatformVersion — (String)

              Version of the platform that the participant used for the call.

            • OperatingSystem — (String)

              Operating system that the participant used for the call.

          • Capabilities — (map)

            The configuration for the allowed capabilities for participants present over the call.

            • Video — (String)

              The configuration having the video sharing capabilities for participants over the call.

              Possible values include:
              • "SEND"
        • Campaign — (map)

          Information associated with a campaign.

          • CampaignId — (String)

            A unique identifier for a campaign.

        • AnsweringMachineDetectionStatus — (String)

          Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

          Possible values include:
          • "ANSWERED"
          • "UNDETECTED"
          • "ERROR"
          • "HUMAN_ANSWERED"
          • "SIT_TONE_DETECTED"
          • "SIT_TONE_BUSY"
          • "SIT_TONE_INVALID_NUMBER"
          • "FAX_MACHINE_DETECTED"
          • "VOICEMAIL_BEEP"
          • "VOICEMAIL_NO_BEEP"
          • "AMD_UNRESOLVED"
          • "AMD_UNANSWERED"
          • "AMD_ERROR"
          • "AMD_NOT_APPLICABLE"
        • CustomerVoiceActivity — (map)

          Information about customer’s voice activity.

          • GreetingStartTimestamp — (Date)

            Timestamp that measures the beginning of the customer greeting from an outbound voice call.

          • GreetingEndTimestamp — (Date)

            Timestamp that measures the end of the customer greeting from an outbound voice call.

        • QualityMetrics — (map)

          Information about the quality of the participant's media connection.

          • Agent — (map)

            Information about the quality of Agent media connection.

            • Audio — (map)

              Information about the audio quality of the Agent

              • QualityScore — (Float)

                Number measuring the estimated quality of the media connection.

              • PotentialQualityIssues — (Array<String>)

                List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.

                Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer

          • Customer — (map)

            Information about the quality of Customer media connection.

            • Audio — (map)

              Information about the audio quality of the Customer

              • QualityScore — (Float)

                Number measuring the estimated quality of the media connection.

              • PotentialQualityIssues — (Array<String>)

                List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.

                Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer

        • DisconnectDetails — (map)

          Information about the call disconnect experience.

          • PotentialDisconnectIssue — (String)

            Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.

        • 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 and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

          • ValueString — (String)

            The value of a segment attribute.

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.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

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

          The status of the contact flow.

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

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

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.

        • AssociatedQueueIds — (Array<String>)

          The IDs of the associated queue.

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

          • SubmitAutoEvaluationAction — (map)

            Information about the submit automated evaluation action.

            • EvaluationFormIdrequired — (String)

              The identifier of the auto-evaluation enabled form.

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

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

Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

Service Reference:

Examples:

Calling the getAttachedFile operation

var params = {
  AssociatedResourceArn: 'STRING_VALUE', /* required */
  FileId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  UrlExpiryInSeconds: 'NUMBER_VALUE'
};
connect.getAttachedFile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Connect instance.

    • FileId — (String)

      The unique identifier of the attached file resource.

    • UrlExpiryInSeconds — (Integer)

      Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

    • AssociatedResourceArn — (String)

      The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

      Note: This value must be a valid 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:

      • FileArn — (String)

        The unique identifier of the attached file resource (ARN).

      • FileId — (String)

        The unique identifier of the attached file resource.

      • CreationTime — (String)

        The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

      • FileStatus — (String)

        The current status of the attached file.

        Possible values include:
        • "APPROVED"
        • "REJECTED"
        • "PROCESSING"
        • "FAILED"
      • FileName — (String)

        A case-sensitive name of the attached file being uploaded.

      • FileSizeInBytes — (Integer)

        The size of the attached file in bytes.

      • AssociatedResourceArn — (String)

        The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

      • FileUseCaseType — (String)

        The use case for the file.

        Possible values include:
        • "ATTACHMENT"
      • CreatedBy — (map)

        Represents the identity that created the file.

        • ConnectUserArn — (String)

          An agent ARN representing a connect user.

        • AWSIdentityArn — (String)

          STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

      • DownloadUrlMetadata — (map)

        URL and expiry to be used when downloading the attached file.

        • Url — (String)

          A pre-signed URL that should be used to download the attached file.

        • UrlExpiry — (String)

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

      • Tags — (map<String>)

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

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

      • Agents

      • Channels

      • Feature

      • Queues

      • Routing profiles

      • Routing step expression

      • User hierarchy groups

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

      Note the following limits:

      • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | 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 | CHANNEL | contact/segmentAttributes/connect:Subtype | FEATURE | FLOW_TYPE | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | INITIATION_METHOD | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |

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

        Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.

        • TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.

        • FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow

        This filter is available only for contact record-driven metrics.

      • 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: AGENT | 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 | CHANNEL | contact/segmentAttributes/connect:Subtype | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | INITIATION_METHOD | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | 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 Guide.

      ABANDONMENT_RATE

      Unit: Percent

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

      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, Q in Connect

      UI name: Average queue abandon time

      AVG_ACTIVE_TIME

      Unit: Seconds

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

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      UI name: Average conversation duration

      AVG_FLOW_TIME

      Unit: Seconds

      Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

      UI name: Average flow time

      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, Q in Connect

      UI name: Average agent greeting time

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      UI name: Average agent interruptions

      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, Q in Connect

      UI name: Average agent interruption time

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      UI name: Average agent talk time

      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, Q in Connect

      UI name: Average customer talk time

      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

      Metric filter:

      • Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect

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

      UI name: Contact abandoned

      CONTACTS_ABANDONED_IN_X

      Unit: Count

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

      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

      CONTACTS_ANSWERED_IN_X

      Unit: Count

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

      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

      CONTACTS_CREATED

      Unit: Count

      Valid metric filter key: INITIATION_METHOD

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

      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, Q in Connect

      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, Q in Connect

      UI name: Contacts handled (connected to agent timestamp)

      CONTACTS_HOLD_ABANDONS

      Unit: Count

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

      UI name: Contacts hold disconnect

      CONTACTS_ON_HOLD_AGENT_DISCONNECT

      Unit: Count

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

      UI name: Contacts hold agent disconnect

      CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT

      Unit: Count

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

      UI name: Contacts hold customer disconnect

      CONTACTS_PUT_ON_HOLD

      Unit: Count

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

      UI name: Contacts put on hold

      CONTACTS_TRANSFERRED_OUT_EXTERNAL

      Unit: Count

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

      UI name: Contacts transferred out external

      CONTACTS_TRANSFERRED_OUT_INTERNAL

      Unit: Percent

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

      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, Q in Connect

      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 (enqueue timestamp)

      CONTACTS_RESOLVED_IN_X

      Unit: Count

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

      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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

      FLOWS_OUTCOME

      Unit: Count

      Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

      UI name: Flows outcome

      FLOWS_STARTED

      Unit: Count

      Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp

      UI name: Flows started

      MAX_FLOW_TIME

      Unit: Seconds

      Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

      UI name: Maximum flow time

      MAX_QUEUED_TIME

      Unit: Seconds

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

      UI name: Maximum queued time

      MIN_FLOW_TIME

      Unit: Seconds

      Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

      UI name: Minimum flow 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_FLOWS_OUTCOME

      Unit: Percent

      Valid metric filter key: FLOWS_OUTCOME_TYPE

      Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp

      UI name: Flows outcome percentage.

      Note: The FLOWS_OUTCOME_TYPE is not a valid grouping.
      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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      UI name: Agent talk time 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, Q in Connect

      UI name: Customer talk time 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, Q in Connect

      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, Q in Connect

      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, Q in Connect

      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_DISCONNECTED

      Valid metric filter key: DISCONNECT_REASON

      Unit: Count

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

      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, Q in Connect

      UI name: Contact handle time

      SUM_HOLD_TIME

      Unit: Count

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

      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, Q in Connect

      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, Q in Connect

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

  • f