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 makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

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

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

Sending a Request Using Connect

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

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

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

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

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

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

Creates a user account for the specified Amazon Connect instance.

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'
  },
  Password: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
connect.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • Password — (String)

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

    • IdentityInfo — (map)

      The information about the identity of the user.

      • FirstName — (String)

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

      • LastName — (String)

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

      • Email — (String)

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

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

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

    • Tags — (map<String>)

      One or more tags.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

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

Deletes a user account from the specified Amazon Connect instance.

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.

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

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

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

Service Reference:

Examples:

Calling the describeUser operation

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

Parameters:

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

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

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

          • DeskPhoneNumber — (String)

            The phone number for the user's desk phone.

        • DirectoryUserId — (String)

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

        • SecurityProfileIds — (Array<String>)

          The identifiers of the security profiles for the user.

        • RoutingProfileId — (String)

          The identifier of the routing profile for the user.

        • HierarchyGroupId — (String)

          The identifier of the hierarchy group for the user.

        • Tags — (map<String>)

          The tags.

Returns:

  • (AWS.Request)

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

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

Describes the specified hierarchy group.

Service Reference:

Examples:

Calling the describeUserHierarchyGroup operation

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

Parameters:

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

      The identifier of the hierarchy group.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • HierarchyGroup — (map)

        Information about the hierarchy group.

        • Id — (String)

          The identifier of the hierarchy group.

        • Arn — (String)

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

        • Name — (String)

          The name of the hierarchy group.

        • LevelId — (String)

          The identifier of the level in the hierarchy group.

        • HierarchyPath — (map)

          Information about the levels in the hierarchy group.

          • LevelOne — (map)

            Information about level one.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

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

            • Name — (String)

              The name of the hierarchy group.

          • LevelTwo — (map)

            Information about level two.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

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

            • Name — (String)

              The name of the hierarchy group.

          • LevelThree — (map)

            Information about level three.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

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

            • Name — (String)

              The name of the hierarchy group.

          • LevelFour — (map)

            Information about level four.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

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

            • Name — (String)

              The name of the hierarchy group.

          • LevelFive — (map)

            Information about level five.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

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

            • Name — (String)

              The name of the hierarchy group.

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.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • HierarchyStructure — (map)

        Information about the hierarchy structure.

        • LevelOne — (map)

          Information about level one.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

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

          • Name — (String)

            The name of the hierarchy level.

        • LevelTwo — (map)

          Information about level two.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

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

          • Name — (String)

            The name of the hierarchy level.

        • LevelThree — (map)

          Information about level three.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

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

          • Name — (String)

            The name of the hierarchy level.

        • LevelFour — (map)

          Information about level four.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

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

          • Name — (String)

            The name of the hierarchy level.

        • LevelFive — (map)

          Information about level five.

          • Id — (String)

            The identifier of the hierarchy level.

          • Arn — (String)

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

          • Name — (String)

            The name of the hierarchy level.

Returns:

  • (AWS.Request)

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

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 more information, see Real-time Metrics Reports 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,
      /* more items */
    ],
    Queues: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  InstanceId: 'STRING_VALUE', /* required */
  Groupings: [
    QUEUE | CHANNEL,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.getCurrentMetricData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the Amazon Connect instance.

    • 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. The only supported channel is VOICE.

      • Queues — (Array<String>)

        The queues to use to filter the metrics. You can specify up to 100 queues per request.

      • Channels — (Array<String>)

        The channel to use to filter the metrics.

    • Groupings — (Array<String>)

      The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.

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

    • CurrentMetrics — (Array<map>)

      The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:

      AGENTS_AFTER_CONTACT_WORK

      Unit: COUNT

      AGENTS_AVAILABLE

      Unit: COUNT

      AGENTS_ERROR

      Unit: COUNT

      AGENTS_NON_PRODUCTIVE

      Unit: COUNT

      AGENTS_ON_CALL

      Unit: COUNT

      AGENTS_ON_CONTACT

      Unit: COUNT

      AGENTS_ONLINE

      Unit: COUNT

      AGENTS_STAFFED

      Unit: COUNT

      CONTACTS_IN_QUEUE

      Unit: COUNT

      CONTACTS_SCHEDULED

      Unit: COUNT

      OLDEST_CONTACT_AGE

      Unit: SECONDS

      SLOTS_ACTIVE

      Unit: COUNT

      SLOTS_AVAILABLE

      Unit: COUNT

      • 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 maximimum number of results to return per page.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • NextToken — (String)

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

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

      • MetricResults — (Array<map>)

        Information about the real-time metrics.

        • Dimensions — (map)

          The dimensions for the metrics.

          • Queue — (map)

            Information about the queue for which metrics are returned.

            • Id — (String)

              The identifier of the queue.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the queue.

          • Channel — (String)

            The channel used for grouping and filters.

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

          The set of metrics.

          • Metric — (map)

            Information about the metric.

            • Name — (String)

              The name of the metric.

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

              The unit for the metric.

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

            The value of the metric.

      • DataSnapshotTime — (Date)

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

Returns:

  • (AWS.Request)

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

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

Retrieves a token for federation.

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.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

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 more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.

Service Reference:

Examples:

Calling the getMetricData operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Filters: { /* required */
    Channels: [
      VOICE | CHAT,
      /* more items */
    ],
    Queues: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  HistoricalMetrics: [ /* required */
    {
      Name: CONTACTS_QUEUED | CONTACTS_HANDLED | CONTACTS_ABANDONED | CONTACTS_CONSULTED | CONTACTS_AGENT_HUNG_UP_FIRST | CONTACTS_HANDLED_INCOMING | CONTACTS_HANDLED_OUTBOUND | CONTACTS_HOLD_ABANDONS | CONTACTS_TRANSFERRED_IN | CONTACTS_TRANSFERRED_OUT | CONTACTS_TRANSFERRED_IN_FROM_QUEUE | CONTACTS_TRANSFERRED_OUT_FROM_QUEUE | CONTACTS_MISSED | CALLBACK_CONTACTS_HANDLED | API_CONTACTS_HANDLED | OCCUPANCY | HANDLE_TIME | AFTER_CONTACT_WORK_TIME | QUEUED_TIME | ABANDON_TIME | QUEUE_ANSWER_TIME | HOLD_TIME | INTERACTION_TIME | INTERACTION_AND_HOLD_TIME | SERVICE_LEVEL,
      Statistic: SUM | MAX | AVG,
      Threshold: {
        Comparison: LT,
        ThresholdValue: 'NUMBER_VALUE'
      },
      Unit: SECONDS | COUNT | PERCENT
    },
    /* more items */
  ],
  InstanceId: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Groupings: [
    QUEUE | CHANNEL,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.getMetricData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the Amazon Connect instance.

    • 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. The only supported channel is VOICE.

      • Queues — (Array<String>)

        The queues to use to filter the metrics. You can specify up to 100 queues per request.

      • Channels — (Array<String>)

        The channel to use to filter the metrics.

    • Groupings — (Array<String>)

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

      The only supported grouping is QUEUE.

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

    • HistoricalMetrics — (Array<map>)

      The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:

      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

      Unit: PERCENT

      Statistic: AVG

      Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

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

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

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

Service Reference:

Examples:

Calling the listContactFlows operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ContactFlowTypes: [
    CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
connect.listContactFlows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the Amazon Connect instance.

    • ContactFlowTypes — (Array<String>)

      The type of contact flow.

    • NextToken — (String)

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

    • MaxResults — (Integer)

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

      • ContactFlowSummaryList — (Array<map>)

        Information about the contact flows.

        • Id — (String)

          The identifier of the contact flow.

        • Arn — (String)

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

        • Name — (String)

          The name of the contact flow.

        • ContactFlowType — (String)

          The type of contact flow.

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

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

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listHoursOfOperations operation

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

Parameters:

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

      The identifier of the Amazon Connect instance.

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

      • HoursOfOperationSummaryList — (Array<map>)

        Information about the hours of operation.

        • Id — (String)

          The identifier of the hours of operation.

        • Arn — (String)

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

        • Name — (String)

          The name of the hours of operation.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Provides information about the phone numbers for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listPhoneNumbers operation

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

Parameters:

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

      The identifier of the Amazon Connect instance.

    • PhoneNumberTypes — (Array<String>)

      The type of phone number.

    • PhoneNumberCountryCodes — (Array<String>)

      The ISO country code.

    • NextToken — (String)

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

    • MaxResults — (Integer)

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

      • PhoneNumberSummaryList — (Array<map>)

        Information about the phone numbers.

        • Id — (String)

          The identifier of the phone number.

        • Arn — (String)

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

        • PhoneNumber — (String)

          The phone number.

        • PhoneNumberType — (String)

          The type of phone number.

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

          The ISO country code.

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

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

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listQueues operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QueueTypes: [
    STANDARD | AGENT,
    /* more items */
  ]
};
connect.listQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the Amazon Connect instance.

    • QueueTypes — (Array<String>)

      The type of queue.

    • NextToken — (String)

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

    • MaxResults — (Integer)

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

      • QueueSummaryList — (Array<map>)

        Information about the queues.

        • Id — (String)

          The identifier of the queue.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the queue.

        • Name — (String)

          The name of the queue.

        • QueueType — (String)

          The type of queue.

          Possible values include:
          • "STANDARD"
          • "AGENT"
      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Provides summary information about the routing profiles for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listRoutingProfiles operation

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

Parameters:

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

      The identifier of the Amazon Connect instance.

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

      • RoutingProfileSummaryList — (Array<map>)

        Information about the routing profiles.

        • Id — (String)

          The identifier of the routing profile.

        • Arn — (String)

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

        • Name — (String)

          The name of the routing profile.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Provides summary information about the security profiles for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listSecurityProfiles operation

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

Parameters:

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

      The identifier of the Amazon Connect instance.

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

      • SecurityProfileSummaryList — (Array<map>)

        Information about the security profiles.

        • Id — (String)

          The identifier of the security profile.

        • Arn — (String)

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

        • Name — (String)

          The name of the security profile.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Lists the tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • tags — (map<String>)

        Information about the tags.

Returns:

  • (AWS.Request)

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

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

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listUserHierarchyGroups operation

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

Parameters:

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

      The identifier of the Amazon Connect instance.

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

      • UserHierarchyGroupSummaryList — (Array<map>)

        Information about the hierarchy groups.

        • Id — (String)

          The identifier of the hierarchy group.

        • Arn — (String)

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

        • Name — (String)

          The name of the hierarchy group.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Provides summary information about the users for the specified Amazon Connect instance.

Service Reference:

Examples:

Calling the listUsers operation

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

Parameters:

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

      The identifier of the Amazon Connect instance.

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

      • UserSummaryList — (Array<map>)

        Information about the users.

        • Id — (String)

          The identifier of the user account.

        • Arn — (String)

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

        • Username — (String)

          The Amazon Connect user name of the user account.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

Service Reference:

Examples:

Calling the startChatContact operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ParticipantDetails: { /* required */
    DisplayName: 'STRING_VALUE' /* required */
  },
  Attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  ClientToken: 'STRING_VALUE',
  InitialMessage: {
    Content: 'STRING_VALUE', /* required */
    ContentType: 'STRING_VALUE' /* required */
  }
};
connect.startChatContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the Amazon Connect instance.

    • ContactFlowId — (String)

      The identifier of the contact flow for the chat.

    • Attributes — (map<String>)

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

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

    • ParticipantDetails — (map)

      Information identifying the participant.

      • DisplayNamerequired — (String)

        Display name of the participant.

    • InitialMessage — (map)

      The initial message to be sent to the newly created chat.

      • ContentTyperequired — (String)

        The type of the content. Supported types are text/plain.

      • Contentrequired — (String)

        The content of the chat message.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ContactId — (String)

        The identifier of this contact within the Amazon Connect instance.

      • ParticipantId — (String)

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

      • ParticipantToken — (String)

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

Returns:

  • (AWS.Request)

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

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

Initiates a contact flow to place an outbound call to a customer.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

Service Reference:

Examples:

Calling the startOutboundVoiceContact operation

var params = {
  ContactFlowId: 'STRING_VALUE', /* required */
  DestinationPhoneNumber: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  Attributes: {
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  ClientToken: 'STRING_VALUE',
  QueueId: 'STRING_VALUE',
  SourcePhoneNumber: 'STRING_VALUE'
};
connect.startOutboundVoiceContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • ContactFlowId — (String)

      The identifier of the contact flow for the outbound call.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • ClientToken — (String)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.

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

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

    • QueueId — (String)

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

    • Attributes — (map<String>)

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

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ContactId — (String)

        The identifier of this contact within the Amazon Connect instance.

Returns:

  • (AWS.Request)

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

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

Ends the specified contact.

Service Reference:

Examples:

Calling the stopContact operation

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

Parameters:

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

      The ID of the contact.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Adds the specified tags to the specified resource.

The supported resource type is users.

Service Reference:

Examples:

Calling the tagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      One or more tags. For example, { "tags": "key2":"value2" }.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Removes the specified tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The tag keys.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Creates or updates the contact attributes associated with the specified contact.

You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Service Reference:

Examples:

Calling the updateContactAttributes operation

var params = {
  Attributes: { /* required */
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  InitialContactId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
connect.updateContactAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

    • Attributes — (map<String>)

      The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.

      You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Assigns the specified hierarchy group to the specified user.

Service Reference:

Examples:

Calling the updateUserHierarchy operation

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

Parameters:

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

      The identifier of the hierarchy group.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Updates the identity information for the specified user.

Service Reference:

Examples:

Calling the updateUserIdentityInfo operation

var params = {
  IdentityInfo: { /* required */
    Email: 'STRING_VALUE',
    FirstName: 'STRING_VALUE',
    LastName: 'STRING_VALUE'
  },
  InstanceId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
connect.updateUserIdentityInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • IdentityInfo — (map)

      The identity information for the user.

      • FirstName — (String)

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

      • LastName — (String)

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

      • Email — (String)

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

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of 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.

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

Updates the phone configuration settings for the specified user.

Service Reference:

Examples:

Calling the updateUserPhoneConfig operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  PhoneConfig: { /* required */
    PhoneType: SOFT_PHONE | DESK_PHONE, /* required */
    AfterContactWorkTimeLimit: 'NUMBER_VALUE',
    AutoAccept: true || false,
    DeskPhoneNumber: 'STRING_VALUE'
  },
  UserId: 'STRING_VALUE' /* required */
};
connect.updateUserPhoneConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PhoneConfig — (map)

      Information about phone configuration settings for the user.

      • PhoneTyperequired — (String)

        The phone type.

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

        The Auto accept setting.

      • AfterContactWorkTimeLimit — (Integer)

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

      • DeskPhoneNumber — (String)

        The phone number for the user's desk phone.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Assigns the specified routing profile to the specified user.

Service Reference:

Examples:

Calling the updateUserRoutingProfile operation

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

Parameters:

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

      The identifier of the routing profile for the user.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Assigns the specified security profiles to the specified user.

Service Reference:

Examples:

Calling the updateUserSecurityProfiles operation

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

Parameters:

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

      The identifiers of the security profiles for the user.

    • UserId — (String)

      The identifier of the user account.

    • InstanceId — (String)

      The identifier of the Amazon Connect instance.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.