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

Class: AWS.ConnectCases

Inherits:
AWS.Service show all
Identifier:
connectcases
API Version:
2022-10-03
Defined in:
(unknown)

Overview

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

Service Description

Welcome to the Amazon Connect Cases API Reference. This guide provides information about the Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains, fields, field options, layouts, templates, cases, related items, and tags.

 <p>For more information about Amazon Connect Cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html&quot;&gt;Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>. </p> 

Sending a Request Using ConnectCases

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

var connectcases = new AWS.ConnectCases({apiVersion: '2022-10-03'});

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

AWS.config.apiVersions = {
  connectcases: '2022-10-03',
  // other service API versions
};

var connectcases = new AWS.ConnectCases();

Version:

  • 2022-10-03

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

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

Examples:

Constructing a ConnectCases object

var connectcases = new AWS.ConnectCases({apiVersion: '2022-10-03'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ConnectCases.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ConnectCases.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Returns the description for the list of fields in the request parameters.

Service Reference:

Examples:

Calling the batchGetField operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  fields: [ /* required */
    {
      id: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
connectcases.batchGetField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • fields — (Array<map>)

      A list of unique field identifiers.

      • idrequired — (String)

        Unique identifier of a field.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • errors — (Array<map>)

        A list of field errors.

        • errorCoderequired — (String)

          The error code from getting a field.

        • idrequired — (String)

          The field identifier that caused the error.

        • message — (String)

          The error message from getting a field.

      • fields — (Array<map>)

        A list of detailed field information.

        • description — (String)

          Description of the field.

        • fieldArnrequired — (String)

          The Amazon Resource Name (ARN) of the field.

        • fieldIdrequired — (String)

          Unique identifier of the field.

        • namerequired — (String)

          Name of the field.

        • namespacerequired — (String)

          Namespace of the field.

          Possible values include:
          • "System"
          • "Custom"
        • tags — (map<String>)

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

        • typerequired — (String)

          Type of the field.

          Possible values include:
          • "Text"
          • "Number"
          • "Boolean"
          • "DateTime"
          • "SingleSelect"

Returns:

  • (AWS.Request)

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

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

Creates and updates a set of field options for a single select field in a Cases domain.

Service Reference:

Examples:

Calling the batchPutFieldOptions operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  fieldId: 'STRING_VALUE', /* required */
  options: [ /* required */
    {
      active: true || false, /* required */
      name: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
connectcases.batchPutFieldOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • fieldId — (String)

      The unique identifier of a field.

    • options — (Array<map>)

      A list of FieldOption objects.

      • activerequired — (Boolean)

        Describes whether the FieldOption is active (displayed) or inactive.

      • namerequired — (String)

        FieldOptionName has max length 100 and disallows trailing spaces.

      • valuerequired — (String)

        FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • errors — (Array<map>)

        A list of field errors.

        • errorCoderequired — (String)

          Error code from creating or updating field option.

        • messagerequired — (String)

          Error message from creating or updating field option.

        • valuerequired — (String)

          The field option value that caused the error.

Returns:

  • (AWS.Request)

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

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

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

Note: customer_id is a required field when creating a case.

Service Reference:

Examples:

Calling the createCase operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  fields: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      value: { /* required */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  templateId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
connectcases.createCase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

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

      The unique identifier of the Cases domain.

    • fields — (Array<map>)

      An array of objects with field ID (matching ListFields/DescribeField) and value union data.

      • idrequired — (String)

        Unique identifier of a field.

      • valuerequired — (map)

        Union of potential field value types.

        • booleanValue — (Boolean)

          Can be either null, or have a Boolean value type. Only one value can be provided.

        • doubleValue — (Float)

          Can be either null, or have a Double number value type. Only one value can be provided.

        • stringValue — (String)

          String value type.

    • templateId — (String)

      A unique identifier of a template.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • caseArn — (String)

        The Amazon Resource Name (ARN) of the case.

      • caseId — (String)

        A unique identifier of the case.

Returns:

  • (AWS.Request)

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

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

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API.

Service Reference:

Examples:

Calling the createDomain operation

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

Parameters:

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

      The name for your Cases domain. It must be unique for your Amazon Web Services account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • domainArn — (String)

        The Amazon Resource Name (ARN) for the Cases domain.

      • domainId — (String)

        The unique identifier of the Cases domain.

      • domainStatus — (String)

        The status of the domain.

        Possible values include:
        • "Active"
        • "CreationInProgress"
        • "CreationFailed"

Returns:

  • (AWS.Request)

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

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

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

Service Reference:

Examples:

Calling the createField operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  type: Text | Number | Boolean | DateTime | SingleSelect, /* required */
  description: 'STRING_VALUE'
};
connectcases.createField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The description of the field.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • name — (String)

      The name of the field.

    • type — (String)

      Defines the data type, some system constraints, and default display of the field.

      Possible values include:
      • "Text"
      • "Number"
      • "Boolean"
      • "DateTime"
      • "SingleSelect"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • fieldArn — (String)

        The Amazon Resource Name (ARN) of the field.

      • fieldId — (String)

        The unique identifier of a field.

Returns:

  • (AWS.Request)

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

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

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

  • Fields to display to the users

  • Field ordering

Note: Title and Status fields cannot be part of layouts since they are not configurable.

Service Reference:

Examples:

Calling the createLayout operation

var params = {
  content: { /* required */
    basic: {
      moreInfo: {
        sections: [
          {
            fieldGroup: {
              fields: [ /* required */
                {
                  id: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              name: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      },
      topPanel: {
        sections: [
          {
            fieldGroup: {
              fields: [ /* required */
                {
                  id: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              name: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      }
    }
  },
  domainId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
connectcases.createLayout(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Information about which fields will be present in the layout, and information about the order of the fields.

      • basic — (map)

        Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

        • moreInfo — (map)

          This represents sections in a tab of the page layout.

          • sections — (Array<map>)

            Ordered list containing different kinds of sections that can be added.

            • fieldGroup — (map)

              Consists of a group of fields and associated properties.

              • fieldsrequired — (Array<map>)

                Represents an ordered list containing field related information.

                • idrequired — (String)

                  Unique identifier of a field.

              • name — (String)

                Name of the field group.

        • topPanel — (map)

          This represents sections in a panel of the page layout.

          • sections — (Array<map>)

            Ordered list containing different kinds of sections that can be added.

            • fieldGroup — (map)

              Consists of a group of fields and associated properties.

              • fieldsrequired — (Array<map>)

                Represents an ordered list containing field related information.

                • idrequired — (String)

                  Unique identifier of a field.

              • name — (String)

                Name of the field group.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • name — (String)

      The name of the layout. It must be unique for the Cases domain.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • layoutArn — (String)

        The Amazon Resource Name (ARN) of the newly created layout.

      • layoutId — (String)

        The unique identifier of the layout.

Returns:

  • (AWS.Request)

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

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

Creates a related item (comments, tasks, and contacts) and associates it with a case.

Note: A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

Service Reference:

Examples:

Calling the createRelatedItem operation

var params = {
  caseId: 'STRING_VALUE', /* required */
  content: { /* required */
    comment: {
      body: 'STRING_VALUE', /* required */
      contentType: Text/Plain /* required */
    },
    contact: {
      contactArn: 'STRING_VALUE' /* required */
    }
  },
  domainId: 'STRING_VALUE', /* required */
  type: Contact | Comment /* required */
};
connectcases.createRelatedItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A unique identifier of the case.

    • content — (map)

      The content of a related item to be created.

      • comment — (map)

        Represents the content of a comment to be returned to agents.

        • bodyrequired — (String)

          Text in the body of a Comment on a case.

        • contentTyperequired — (String)

          Type of the text in the box of a Comment on a case.

          Possible values include:
          • "Text/Plain"
      • contact — (map)

        Object representing a contact in Amazon Connect as an API request field.

        • contactArnrequired — (String)

          A unique identifier of a contact in Amazon Connect.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • type — (String)

      The type of a related item.

      Possible values include:
      • "Contact"
      • "Comment"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • relatedItemArn — (String)

        The Amazon Resource Name (ARN) of the related item.

      • relatedItemId — (String)

        The unique identifier of the related item.

Returns:

  • (AWS.Request)

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

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

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Service Reference:

Examples:

Calling the createTemplate operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  layoutConfiguration: {
    defaultLayout: 'STRING_VALUE'
  },
  requiredFields: [
    {
      fieldId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  status: Active | Inactive
};
connectcases.createTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A brief description of the template.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • layoutConfiguration — (map)

      Configuration of layouts associated to the template.

      • defaultLayout — (String)

        Unique identifier of a layout.

    • name — (String)

      A name for the template. It must be unique per domain.

    • requiredFields — (Array<map>)

      A list of fields that must contain a value for a case to be successfully created with this template.

      • fieldIdrequired — (String)

        Unique identifier of a field.

    • status — (String)

      The status of the template.

      Possible values include:
      • "Active"
      • "Inactive"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • templateArn — (String)

        The Amazon Resource Name (ARN) of the newly created template.

      • templateId — (String)

        A unique identifier of a template.

Returns:

  • (AWS.Request)

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

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

Returns information about a specific case if it exists.

Service Reference:

Examples:

Calling the getCase operation

var params = {
  caseId: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  fields: [ /* required */
    {
      id: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  nextToken: 'STRING_VALUE'
};
connectcases.getCase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A unique identifier of the case.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • fields — (Array<map>)

      A list of unique field identifiers.

      • idrequired — (String)

        Unique identifier of a field.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • fields — (Array<map>)

        A list of detailed field information.

        • idrequired — (String)

          Unique identifier of a field.

        • valuerequired — (map)

          Union of potential field value types.

          • booleanValue — (Boolean)

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue — (Float)

            Can be either null, or have a Double number value type. Only one value can be provided.

          • stringValue — (String)

            String value type.

      • nextToken — (String)

        The token for the next set of results. This is null if there are no more results to return.

      • tags — (map<String>)

        A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • templateId — (String)

        A unique identifier of a template.

Returns:

  • (AWS.Request)

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

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

Returns the case event publishing configuration.

Service Reference:

Examples:

Calling the getCaseEventConfiguration operation

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

Parameters:

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

      The unique identifier of the Cases domain.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • eventBridge — (map)

        Configuration to enable EventBridge case event delivery and determine what data is delivered.

        • enabledrequired — (Boolean)

          Indicates whether the to broadcast case event data to the customer.

        • includedData — (map)

          Details of what case and related item data is published through the case event stream.

          • caseData — (map)

            Details of what case data is published through the case event stream.

            • fieldsrequired — (Array<map>)

              List of field identifiers.

              • idrequired — (String)

                Unique identifier of a field.

          • relatedItemData — (map)

            Details of what related item data is published through the case event stream.

            • includeContentrequired — (Boolean)

              Details of what related item data is published through the case event stream.

Returns:

  • (AWS.Request)

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

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

Returns information about a specific domain if it exists.

Service Reference:

Examples:

Calling the getDomain operation

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

Parameters:

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

      The unique identifier of the Cases domain.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • createdTime — (Date)

        The timestamp when the Cases domain was created.

      • domainArn — (String)

        The Amazon Resource Name (ARN) for the Cases domain.

      • domainId — (String)

        The unique identifier of the Cases domain.

      • domainStatus — (String)

        The status of the Cases domain.

        Possible values include:
        • "Active"
        • "CreationInProgress"
        • "CreationFailed"
      • name — (String)

        The name of the Cases domain.

      • tags — (map<String>)

        A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Returns the details for the requested layout.

Service Reference:

Examples:

Calling the getLayout operation

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

Parameters:

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

      The unique identifier of the Cases domain.

    • layoutId — (String)

      The unique identifier of the layout.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • content — (map)

        Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.

        • basic — (map)

          Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

          • moreInfo — (map)

            This represents sections in a tab of the page layout.

            • sections — (Array<map>)

              Ordered list containing different kinds of sections that can be added.

              • fieldGroup — (map)

                Consists of a group of fields and associated properties.

                • fieldsrequired — (Array<map>)

                  Represents an ordered list containing field related information.

                  • idrequired — (String)

                    Unique identifier of a field.

                • name — (String)

                  Name of the field group.

          • topPanel — (map)

            This represents sections in a panel of the page layout.

            • sections — (Array<map>)

              Ordered list containing different kinds of sections that can be added.

              • fieldGroup — (map)

                Consists of a group of fields and associated properties.

                • fieldsrequired — (Array<map>)

                  Represents an ordered list containing field related information.

                  • idrequired — (String)

                    Unique identifier of a field.

                • name — (String)

                  Name of the field group.

      • layoutArn — (String)

        The Amazon Resource Name (ARN) of the newly created layout.

      • layoutId — (String)

        The unique identifier of the layout.

      • name — (String)

        The name of the layout. It must be unique.

      • tags — (map<String>)

        A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Returns the details for the requested template.

Service Reference:

Examples:

Calling the getTemplate operation

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

Parameters:

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

      The unique identifier of the Cases domain.

    • templateId — (String)

      A unique identifier of a template.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • description — (String)

        A brief description of the template.

      • layoutConfiguration — (map)

        Configuration of layouts associated to the template.

        • defaultLayout — (String)

          Unique identifier of a layout.

      • name — (String)

        The name of the template.

      • requiredFields — (Array<map>)

        A list of fields that must contain a value for a case to be successfully created with this template.

        • fieldIdrequired — (String)

          Unique identifier of a field.

      • status — (String)

        The status of the template.

        Possible values include:
        • "Active"
        • "Inactive"
      • tags — (map<String>)

        A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • templateArn — (String)

        The Amazon Resource Name (ARN) of the template.

      • templateId — (String)

        A unique identifier of a template.

Returns:

  • (AWS.Request)

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

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

Lists cases for a given contact.

Service Reference:

Examples:

Calling the listCasesForContact operation

var params = {
  contactArn: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcases.listCasesForContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A unique identifier of a contact in Amazon Connect.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • cases — (Array<map>)

        A list of Case summary information.

        • caseIdrequired — (String)

          A unique identifier of the case.

        • templateIdrequired — (String)

          A unique identifier of a template.

      • nextToken — (String)

        The token for the next set of results. This is null if there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcases.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • domains — (Array<map>)

        The Cases domain.

        • domainArnrequired — (String)

          The Amazon Resource Name (ARN) of the domain.

        • domainIdrequired — (String)

          The unique identifier of the domain.

        • namerequired — (String)

          The name of the domain.

      • nextToken — (String)

        The token for the next set of results. This is null if there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists all of the field options for a field identifier in the domain.

Service Reference:

Examples:

Calling the listFieldOptions operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  fieldId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  values: [
    'STRING_VALUE',
    /* more items */
  ]
};
connectcases.listFieldOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • fieldId — (String)

      The unique identifier of a field.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

    • values — (Array<String>)

      A list of FieldOption values to filter on for ListFieldOptions.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

        The token for the next set of results. This is null if there are no more results to return.

      • options — (Array<map>)

        A list of FieldOption objects.

        • activerequired — (Boolean)

          Describes whether the FieldOption is active (displayed) or inactive.

        • namerequired — (String)

          FieldOptionName has max length 100 and disallows trailing spaces.

        • valuerequired — (String)

          FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.

Returns:

  • (AWS.Request)

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

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

Lists all fields in a Cases domain.

Service Reference:

Examples:

Calling the listFields operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcases.listFields(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • fields — (Array<map>)

        List of detailed field information.

        • fieldArnrequired — (String)

          The Amazon Resource Name (ARN) of the field.

        • fieldIdrequired — (String)

          The unique identifier of a field.

        • namerequired — (String)

          Name of the field.

        • namespacerequired — (String)

          The namespace of a field.

          Possible values include:
          • "System"
          • "Custom"
        • typerequired — (String)

          The type of a field.

          Possible values include:
          • "Text"
          • "Number"
          • "Boolean"
          • "DateTime"
          • "SingleSelect"
      • nextToken — (String)

        The token for the next set of results. This is null if there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

Service Reference:

Examples:

Calling the listLayouts operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcases.listLayouts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • layouts — (Array<map>)

        The layouts for the domain.

        • layoutArnrequired — (String)

          The Amazon Resource Name (ARN) of the layout.

        • layoutIdrequired — (String)

          The unique identifier for of the layout.

        • namerequired — (String)

          The name of the layout.

      • nextToken — (String)

        The token for the next set of results. This is null if there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

      The Amazon Resource Name (ARN)

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • tags — (map<String>)

        A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Service Reference:

Examples:

Calling the listTemplates operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: [
    Active | Inactive,
    /* more items */
  ]
};
connectcases.listTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

    • status — (Array<String>)

      A list of status values to filter on.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

        The token for the next set of results. This is null if there are no more results to return.

      • templates — (Array<map>)

        List of template summary objects.

        • namerequired — (String)

          The template name.

        • statusrequired — (String)

          The status of the template.

          Possible values include:
          • "Active"
          • "Inactive"
        • templateArnrequired — (String)

          The Amazon Resource Name (ARN) of the template.

        • templateIdrequired — (String)

          The unique identifier for the template.

Returns:

  • (AWS.Request)

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

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

API for adding case event publishing configuration

Service Reference:

Examples:

Calling the putCaseEventConfiguration operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  eventBridge: { /* required */
    enabled: true || false, /* required */
    includedData: {
      caseData: {
        fields: [ /* required */
          {
            id: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      relatedItemData: {
        includeContent: true || false /* required */
      }
    }
  }
};
connectcases.putCaseEventConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • eventBridge — (map)

      Configuration to enable EventBridge case event delivery and determine what data is delivered.

      • enabledrequired — (Boolean)

        Indicates whether the to broadcast case event data to the customer.

      • includedData — (map)

        Details of what case and related item data is published through the case event stream.

        • caseData — (map)

          Details of what case data is published through the case event stream.

          • fieldsrequired — (Array<map>)

            List of field identifiers.

            • idrequired — (String)

              Unique identifier of a field.

        • relatedItemData — (map)

          Details of what related item data is published through the case event stream.

          • includeContentrequired — (Boolean)

            Details of what related item data is published through the case event stream.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

Service Reference:

Examples:

Calling the searchCases operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  fields: [
    {
      id: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  filter: { /* CaseFilter */
    andAll: [
      /* recursive CaseFilter */,
      /* more items */
    ],
    field: {
      contains: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          stringValue: 'STRING_VALUE'
        }
      },
      equalTo: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          stringValue: 'STRING_VALUE'
        }
      },
      greaterThan: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          stringValue: 'STRING_VALUE'
        }
      },
      greaterThanOrEqualTo: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          stringValue: 'STRING_VALUE'
        }
      },
      lessThan: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          stringValue: 'STRING_VALUE'
        }
      },
      lessThanOrEqualTo: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          stringValue: 'STRING_VALUE'
        }
      }
    },
    not: /* recursive CaseFilter */
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  searchTerm: 'STRING_VALUE',
  sorts: [
    {
      fieldId: 'STRING_VALUE', /* required */
      sortOrder: Asc | Desc /* required */
    },
    /* more items */
  ]
};
connectcases.searchCases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The unique identifier of the Cases domain.

    • fields — (Array<map>)

      The list of field identifiers to be returned as part of the response.

      • idrequired — (String)

        Unique identifier of a field.

    • filter — (map)

      A list of filter objects.

      • andAll — (Array<map>)

        Provides "and all" filtering.

        • field — (map)

          A list of fields to filter on.

          • contains — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • equalTo — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • greaterThan — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • greaterThanOrEqualTo — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • lessThan — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • lessThanOrEqualTo — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

      • field — (map)

        A list of fields to filter on.

        • contains — (map)

          Object containing field identifier and value information.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

        • equalTo — (map)

          Object containing field identifier and value information.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

        • greaterThan — (map)

          Object containing field identifier and value information.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

        • greaterThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

        • lessThan — (map)

          Object containing field identifier and value information.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

        • lessThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

      • not — (map)

        A filter for cases. Only one value can be provided.

        • andAll — (Array<map>)

          Provides "and all" filtering.

        • field — (map)

          A list of fields to filter on.

          • contains — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • equalTo — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • greaterThan — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • greaterThanOrEqualTo — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • lessThan — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

          • lessThanOrEqualTo — (map)

            Object containing field identifier and value information.

            • idrequired — (String)

              Unique identifier of a field.

            • valuerequired — (map)

              Union of potential field value types.

              • booleanValue — (Boolean)

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • doubleValue — (Float)

                Can be either null, or have a Double number value type. Only one value can be provided.

              • stringValue — (String)

                String value type.

    • maxResults — (Integer)

      The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

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

    • searchTerm — (String)

      A word or phrase used to perform a quick search.

    • sorts — (Array<map>)

      A list of sorts where each sort specifies a field and their sort order to be applied to the results.

      • fieldIdrequired — (String)

        Unique identifier of a field.

      • sortOrderrequired — (String)

        A structured set of sort terms

        Possible values include:
        • "Asc"
        • "Desc"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • cases — (Array<map>)

        A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

        • caseIdrequired — (String)

          A unique identifier of the case.

        • fieldsrequired — (Array<map>)

          List of case field values.

          • idrequired — (String)

            Unique identifier of a field.

          • valuerequired — (map)

            Union of potential field value types.

            • booleanValue — (Boolean)

              Can be either null, or have a Boolean value type. Only one value can be provided.

            • doubleValue — (Float)

              Can be either null, or have a Double number value type. Only one value can be provided.

            • stringValue — (String)

              String value type.

        • tags — (map<String>)

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

        • templateIdrequired — (String)

          A unique identifier of a template.

      • nextToken — (String)

        The token for the next set of results. This is null if there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Searches for related items that are associated with a case.

Note: If no filters are provided, this returns all related items associated with a case.

Service Reference:

Examples:

Calling the searchRelatedItems operation

var params = {
  caseId: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  filters: [
    {
      comment: {
      },
      contact: {
        channel: [
          'STRING_VALUE',
          /* more items */
        ],
        contactArn: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcases.searchRelatedItems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A unique identifier of the case.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • filters — (Array<map>)

      The list of types of related items and their parameters to use for filtering.

      • comment — (map)

        A filter for related items of type Comment.

      • contact — (map)

        A filter for related items of type Contact.

        • channel — (Array<String>)

          A list of channels to filter on for related items of type Contact.

        • contactArn — (String)

          A unique identifier of a contact in Amazon Connect.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

        The token for the next set of results. This is null if there are no more results to return.

      • relatedItems — (Array<map>)

        A list of items related to a case.

        • associationTimerequired — (Date)

          Time at which a related item was associated with a case.

        • contentrequired — (map)

          Represents the content of a particular type of related item.

          • comment — (map)

            Represents the content of a comment to be returned to agents.

            • bodyrequired — (String)

              Text in the body of a Comment on a case.

            • contentTyperequired — (String)

              Type of the text in the box of a Comment on a case.

              Possible values include:
              • "Text/Plain"
          • contact — (map)

            Represents the content of a contact to be returned to agents.

            • channelrequired — (String)

              A list of channels to filter on for related items of type Contact.

            • connectedToSystemTimerequired — (Date)

              The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.

            • contactArnrequired — (String)

              A unique identifier of a contact in Amazon Connect.

        • relatedItemIdrequired — (String)

          Unique identifier of a related item.

        • tags — (map<String>)

          A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

        • typerequired — (String)

          Type of a related item.

          Possible values include:
          • "Contact"
          • "Comment"

Returns:

  • (AWS.Request)

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

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

Adds tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  arn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
connectcases.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: {})
    • arn — (String)

      The Amazon Resource Name (ARN)

    • tags — (map<String>)

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this 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.

Returns:

  • (AWS.Request)

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

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

Untags a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  arn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
connectcases.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: {})
    • arn — (String)

      The Amazon Resource Name (ARN)

    • tagKeys — (Array<String>)

      List of 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.

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

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Service Reference:

Examples:

Calling the updateCase operation

var params = {
  caseId: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  fields: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      value: { /* required */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
connectcases.updateCase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A unique identifier of the case.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • fields — (Array<map>)

      An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.

      • idrequired — (String)

        Unique identifier of a field.

      • valuerequired — (map)

        Union of potential field value types.

        • booleanValue — (Boolean)

          Can be either null, or have a Boolean value type. Only one value can be provided.

        • doubleValue — (Float)

          Can be either null, or have a Double number value type. Only one value can be provided.

        • stringValue — (String)

          String value type.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

Updates the properties of an existing field.

Service Reference:

Examples:

Calling the updateField operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  fieldId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
connectcases.updateField(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The description of a field.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • fieldId — (String)

      The unique identifier of a field.

    • name — (String)

      The name of the field.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A ValidationException is returned when you add non-existent fieldIds to a layout.

Note: Title and Status fields cannot be part of layouts because they are not configurable.

Service Reference:

Examples:

Calling the updateLayout operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  layoutId: 'STRING_VALUE', /* required */
  content: {
    basic: {
      moreInfo: {
        sections: [
          {
            fieldGroup: {
              fields: [ /* required */
                {
                  id: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              name: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      },
      topPanel: {
        sections: [
          {
            fieldGroup: {
              fields: [ /* required */
                {
                  id: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              name: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      }
    }
  },
  name: 'STRING_VALUE'
};
connectcases.updateLayout(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Information about which fields will be present in the layout, the order of the fields, and a read-only attribute of the field.

      • basic — (map)

        Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

        • moreInfo — (map)

          This represents sections in a tab of the page layout.

          • sections — (Array<map>)

            Ordered list containing different kinds of sections that can be added.

            • fieldGroup — (map)

              Consists of a group of fields and associated properties.

              • fieldsrequired — (Array<map>)

                Represents an ordered list containing field related information.

                • idrequired — (String)

                  Unique identifier of a field.

              • name — (String)

                Name of the field group.

        • topPanel — (map)

          This represents sections in a panel of the page layout.

          • sections — (Array<map>)

            Ordered list containing different kinds of sections that can be added.

            • fieldGroup — (map)

              Consists of a group of fields and associated properties.

              • fieldsrequired — (Array<map>)

                Represents an ordered list containing field related information.

                • idrequired — (String)

                  Unique identifier of a field.

              • name — (String)

                Name of the field group.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • layoutId — (String)

      The unique identifier of the layout.

    • name — (String)

      The name of the layout. It must be unique per domain.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Service Reference:

Examples:

Calling the updateTemplate operation

var params = {
  domainId: 'STRING_VALUE', /* required */
  templateId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  layoutConfiguration: {
    defaultLayout: 'STRING_VALUE'
  },
  name: 'STRING_VALUE',
  requiredFields: [
    {
      fieldId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  status: Active | Inactive
};
connectcases.updateTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      A brief description of the template.

    • domainId — (String)

      The unique identifier of the Cases domain.

    • layoutConfiguration — (map)

      Configuration of layouts associated to the template.

      • defaultLayout — (String)

        Unique identifier of a layout.

    • name — (String)

      The name of the template. It must be unique per domain.

    • requiredFields — (Array<map>)

      A list of fields that must contain a value for a case to be successfully created with this template.

      • fieldIdrequired — (String)

        Unique identifier of a field.

    • status — (String)

      The status of the template.

      Possible values include:
      • "Active"
      • "Inactive"
    • templateId — (String)

      A unique identifier for the template.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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