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

The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. 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.

Throttling limits for the Amazon Connect API operations:

For the GetMetricData and GetCurrentMetricData operations, a RateLimit of 5 per second, and a BurstLimit of 8 per second.

For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.

You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form. You must be signed in to your AWS account to access the form.

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

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

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.

  • 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 returns the amount of time to delay in milliseconds. 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.

Property Details

endpoint ⇒ AWS.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 new user account in your 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'
};
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 in Amazon Connect for the account to create. If you are using SAML for identity management in your Amazon Connect, the value for Username can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

    • Password — (String)

      The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

    • IdentityInfo — (map)

      Information about the user, including email address, first name, and last name.

      • FirstName — (String)

        The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

      • LastName — (String)

        The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

      • Email — (String)

        The email address added to the user account. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

    • PhoneConfig — (map)

      Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

      • PhoneType — required — (String)

        The phone type selected for the user, either Soft phone or Desk phone.

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

        The Auto accept setting for the user, Yes or No.

      • AfterContactWorkTimeLimit — (Integer)

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

      • DeskPhoneNumber — (String)

        The phone number for the user's desk phone.

    • DirectoryUserId — (String)

      The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing 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 InvalidRequestException is returned.

    • SecurityProfileIds — (Array<String>)

      The unique identifier of the security profile to assign to the user created.

    • RoutingProfileId — (String)

      The unique identifier for the routing profile to assign to the user created.

    • HierarchyGroupId — (String)

      The unique identifier for the hierarchy group to assign to the user created.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (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 unique identifier for the user account in Amazon Connect

      • UserArn — (String)

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

Returns:

  • (AWS.Request) —

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

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

Deletes a user account from Amazon Connect.

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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • UserId — (String)

      The unique identifier of the user to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

Returns a User object that contains information about the user account specified by the UserId.

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)

      Unique identifier for the user account to return.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        A User object that contains information about the user account and configuration settings.

        • Id — (String)

          The identifier of the user account.

        • Arn — (String)

          The ARN of the user account.

        • Username — (String)

          The user name assigned to the user account.

        • IdentityInfo — (map)

          A UserIdentityInfo object.

          • FirstName — (String)

            The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

          • LastName — (String)

            The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

          • Email — (String)

            The email address added to the user account. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

        • PhoneConfig — (map)

          A UserPhoneConfig object.

          • PhoneType — required — (String)

            The phone type selected for the user, either Soft phone or Desk phone.

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

            The Auto accept setting for the user, Yes or No.

          • AfterContactWorkTimeLimit — (Integer)

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

          • DeskPhoneNumber — (String)

            The phone number for the user's desk phone.

        • DirectoryUserId — (String)

          The directory Id for the user account in the existing directory used for identity management.

        • SecurityProfileIds — (Array<String>)

          The identifier(s) for the security profile assigned to the user.

        • RoutingProfileId — (String)

          The identifier of the routing profile assigned to the user.

        • HierarchyGroupId — (String)

          The identifier for the hierarchy group assigned to the user.

Returns:

  • (AWS.Request) —

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

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

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

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 for the hierarchy group to return.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        Returns a HierarchyGroup object.

        • Id — (String)

          The identifier for the hierarchy group.

        • Arn — (String)

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

        • Name — (String)

          The name of the hierarchy group in your instance.

        • LevelId — (String)

          The identifier for the level in the hierarchy group.

        • HierarchyPath — (map)

          A HierarchyPath object that contains information about the levels in the hierarchy group.

          • LevelOne — (map)

            A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The ARN for the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelTwo — (map)

            A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The ARN for the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelThree — (map)

            A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The ARN for the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelFour — (map)

            A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The ARN for the hierarchy group.

            • Name — (String)

              The name of the hierarchy group.

          • LevelFive — (map)

            A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

            • Id — (String)

              The identifier of the hierarchy group.

            • Arn — (String)

              The ARN for 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

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        A HierarchyStructure object.

        • LevelOne — (map)

          A HierarchyLevel object that contains information about the hierarchy group level.

          • Id — (String)

            The identifier for the hierarchy group level.

          • Arn — (String)

            The ARN for the hierarchy group level.

          • Name — (String)

            The name of the hierarchy group level.

        • LevelTwo — (map)

          A HierarchyLevel object that contains information about the hierarchy group level.

          • Id — (String)

            The identifier for the hierarchy group level.

          • Arn — (String)

            The ARN for the hierarchy group level.

          • Name — (String)

            The name of the hierarchy group level.

        • LevelThree — (map)

          A HierarchyLevel object that contains information about the hierarchy group level.

          • Id — (String)

            The identifier for the hierarchy group level.

          • Arn — (String)

            The ARN for the hierarchy group level.

          • Name — (String)

            The name of the hierarchy group level.

        • LevelFour — (map)

          A HierarchyLevel object that contains information about the hierarchy group level.

          • Id — (String)

            The identifier for the hierarchy group level.

          • Arn — (String)

            The ARN for the hierarchy group level.

          • Name — (String)

            The name of the hierarchy group level.

        • LevelFive — (map)

          A HierarchyLevel object that contains information about the hierarchy group level.

          • Id — (String)

            The identifier for the hierarchy group level.

          • Arn — (String)

            The ARN for the hierarchy group level.

          • Name — (String)

            The name of the hierarchy group level.

Returns:

  • (AWS.Request) —

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

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

Retrieves the contact attributes associated with a 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 instance ID for the instance from which to retrieve contact attributes.

    • InitialContactId — (String)

      The ID for the initial contact in Amazon Connect associated with the attributes to update.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        The attributes to update.

Returns:

  • (AWS.Request) —

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

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

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

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,
      Unit: SECONDS | COUNT | PERCENT
    },
    /* more items */
  ],
  Filters: { /* required */
    Channels: [
      VOICE,
      /* 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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • Filters — (map)

      A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

      To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.

      • Queues — (Array<String>)

        A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.

      • Channels — (Array<String>)

        The Channel to use as a filter for the metrics returned. Only VOICE is supported.

    • 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 CurrentMetrics is returned.

    • CurrentMetrics — (Array<map>)

      A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data for in the request.

      The following metrics are available:

      AGENTS_AVAILABLE

      Unit: COUNT

      AGENTS_ONLINE

      Unit: COUNT

      AGENTS_ON_CALL

      Unit: COUNT

      AGENTS_STAFFED

      Unit: COUNT

      AGENTS_AFTER_CONTACT_WORK

      Unit: COUNT

      AGENTS_NON_PRODUCTIVE

      Unit: COUNT

      AGENTS_ERROR

      Unit: COUNT

      CONTACTS_IN_QUEUE

      Unit: COUNT

      OLDEST_CONTACT_AGE

      Unit: SECONDS

      CONTACTS_SCHEDULED

      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"
      • 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 NextToken must use the same request parameters as the request that generated the token.

    • MaxResults — (Integer)

      MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

        A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent 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 NextToken must use the same request parameters as the request that generated the token.

      • MetricResults — (Array<map>)

        A list of CurrentMetricResult objects organized by Dimensions combining with CurrentMetricDataCollections.

        Dimensions is the resourceId specified in the Filters of the request.

        Collections is a list of CurrentMetricData objects with corresponding values to the CurrentMetrics specified in the request.

        If no Grouping is specified in the request, Collections is a summary for the CurrentMetric returned.

        • Dimensions — (map)

          The Dimensions for the CurrentMetricResult object.

          • Queue — (map)

            A QueueReference object used as one part of dimension for the metrics results.

            • Id — (String)

              The ID of the queue associated with the metrics returned.

            • Arn — (String)

              The Amazon Resource Name (ARN) of queue.

          • Channel — (String)

            The channel used for grouping and filters. Only VOICE is supported.

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

          The Collections for the CurrentMetricResult object.

          • Metric — (map)

            The metric in a CurrentMetricData object.

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

              The unit for the metric.

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

            The value of the metric in the CurrentMetricData object.

      • DataSnapshotTime — (Date)

        The time at which CurrentMetricData was 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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

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,
      /* 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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

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

      StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect 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 StartTime timestamp.

      The time range between StartTime and EndTime must be less than 24 hours.

    • Filters — (map)

      A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.

      To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.

      • Queues — (Array<String>)

        A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.

      • Channels — (Array<String>)

        The Channel to use as a filter for the metrics returned. Only VOICE is supported.

    • Groupings — (Array<String>)

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

      The current version supports grouping by Queue

      If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.

    • HistoricalMetrics — (Array<map>)

      A list of HistoricalMetric objects that contain the metrics to retrieve with the request.

      A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.

      You must list each metric to retrieve data for in the request. For each historical metric you include in the request, you must include a Unit and a Statistic.

      The following historical metrics are available:

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistics: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistics: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistics: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistics: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistics: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistics: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistics: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistics: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistics: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistics: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistics: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistics: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistics: SUM

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistics: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistics: SUM

      OCCUPANCY

      Unit: PERCENT

      Statistics: AVG

      HANDLE_TIME

      Unit: SECONDS

      Statistics: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistics: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistics: MAX

      ABANDON_TIME

      Unit: COUNT

      Statistics: SUM

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistics: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistics: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistics: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistics: AVG

      SERVICE_LEVEL

      Unit: PERCENT

      Statistics: 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 historical 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 Threshold to use to compare service level metrics to. Only "Less than" (LT) comparisons are supported.

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

          The value of the threshold to compare the metric to. Only "Less than" (LT) comparisons are supported.

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

      Indicates the maximum number of results to return per page in the response, between 1-100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

        A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent 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 NextToken must use the same request parameters as the request that generated the token.

      • MetricResults — (Array<map>)

        A list of HistoricalMetricResult objects, organized by Dimensions, which is the ID of the resource specified in the Filters used for the request. The metrics are combined with the metrics included in Collections, which is a list of HisotricalMetricData objects.

        If no Grouping is specified in the request, Collections includes summary data for the HistoricalMetrics.

        • Dimensions — (map)

          The Dimensions for the metrics.

          • Queue — (map)

            A QueueReference object used as one part of dimension for the metrics results.

            • Id — (String)

              The ID of the queue associated with the metrics returned.

            • Arn — (String)

              The Amazon Resource Name (ARN) of queue.

          • Channel — (String)

            The channel used for grouping and filters. Only VOICE is supported.

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

          A list of HistoricalMetricData objects.

          • Metric — (map)

            A HistoricalMetric object.

            • Name — (String)

              The name of the historical 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 Threshold to use to compare service level metrics to. Only "Less than" (LT) comparisons are supported.

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

                The value of the threshold to compare the metric to. Only "Less than" (LT) comparisons are supported.

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

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

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your 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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of routing profiles to return in the response.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        An array of RoutingProfileSummary objects that include the ARN, Id, and Name of the routing profile.

        • Id — (String)

          The identifier of the routing profile.

        • Arn — (String)

          The ARN of the routing profile.

        • Name — (String)

          The name of the routing profile.

      • NextToken — (String)

        A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

Returns:

  • (AWS.Request) —

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

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

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of security profiles to return.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        An array of SecurityProfileSummary objects.

        • Id — (String)

          The identifier of the security profile.

        • Arn — (String)

          The ARN of the security profile.

        • Name — (String)

          The name of the security profile.

      • NextToken — (String)

        A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

Returns:

  • (AWS.Request) —

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

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

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your 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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of hierarchy groups to return.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        An array of HierarchyGroupSummary objects.

        • Id — (String)

          The identifier of the hierarchy group.

        • Arn — (String)

          The ARN for the hierarchy group.

        • Name — (String)

          The name of the hierarchy group.

      • NextToken — (String)

        A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

Returns:

  • (AWS.Request) —

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

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

Returns a UserSummaryList, which is an array of UserSummary objects.

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 for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of results to return in the response.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

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

        An array of UserSummary objects that contain information about the users in your instance.

        • Id — (String)

          The identifier for the user account.

        • Arn — (String)

          The ARN for the user account.

        • Username — (String)

          The Amazon Connect user name for the user account.

      • NextToken — (String)

        A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

Returns:

  • (AWS.Request) —

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

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

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call 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 for the contact flow to connect the outbound call to.

      To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • 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, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

    • QueueId — (String)

      The queue to add the call to. 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 used will be the queue defined in the contact flow.

      To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

    • Attributes — (map<String>)

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

      For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (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 unique identifier of this contact within your Amazon Connect instance.

Returns:

  • (AWS.Request) —

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

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

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

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 unique identifier of the contact to end.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to 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 use the UpdateContactAttributes operation to 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 unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

    • Attributes — (map<String>)

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

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 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 for the hierarchy group to assign to the user.

    • UserId — (String)

      The identifier of the user account to assign the hierarchy group to.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to 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 in a UserIdentityInfo object, including email, first name, and last name.

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)

      A UserIdentityInfo object.

      • FirstName — (String)

        The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

      • LastName — (String)

        The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

      • Email — (String)

        The email address added to the user account. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

    • UserId — (String)

      The identifier for the user account to update identity information for.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

      A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.

      • PhoneType — required — (String)

        The phone type selected for the user, either Soft phone or Desk phone.

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

        The Auto accept setting for the user, Yes or No.

      • AfterContactWorkTimeLimit — (Integer)

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

      • DeskPhoneNumber — (String)

        The phone number for the user's desk phone.

    • UserId — (String)

      The identifier for the user account to change phone settings for.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • UserId — (String)

      The identifier for the user account to assign the routing profile to.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

Updates the security profiles assigned to the 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 for the security profiles to assign to the user.

    • UserId — (String)

      The identifier of the user account to assign the security profiles.

    • InstanceId — (String)

      The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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