Class: AWS.ConnectCases

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.

    • active — required — (Boolean)

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

    • name — required — (String)

      FieldOptionName has max length 100 and disallows trailing spaces.

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

      • errorCode — required — (String)

        Error code from creating or updating field option.

      • message — required — (String)

        Error message from creating or updating field option.

      • value — required — (String)

        The field option value that caused the error.

Returns:

• (AWS.Request) —

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

var params = {
  domainId: 'STRING_VALUE', /* required */
  fields: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      value: { /* required */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        emptyValue: {
        },
        stringValue: 'STRING_VALUE',
        userArnValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  templateId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  performedBy: {
    userArn: '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.

    • id — required — (String)

      Unique identifier of a field.

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

      • emptyValue — (map)

        An empty value.

      • stringValue — (String)

        String value type.

      • userArnValue — (String)

        Represents the user that performed the audit.

  • performedBy — (map)

    Represents the identity of the person who performed the action.

    • userArn — (String)

      Represents the Amazon Connect ARN of the user.

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

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.

var params = {
  domainId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  type: Text | Number | Boolean | DateTime | SingleSelect | Url | User, /* 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"
    • "Url"
    • "User"

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. 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.

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.

            • fields — required — (Array<map>)

              Represents an ordered list containing field related information.

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

            • fields — required — (Array<map>)

              Represents an ordered list containing field related information.

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

var params = {
  caseId: 'STRING_VALUE', /* required */
  content: { /* required */
    comment: {
      body: 'STRING_VALUE', /* required */
      contentType: Text/Plain /* required */
    },
    contact: {
      contactArn: 'STRING_VALUE' /* required */
    },
    file: {
      fileArn: 'STRING_VALUE' /* required */
    }
  },
  domainId: 'STRING_VALUE', /* required */
  type: Contact | Comment | File, /* required */
  performedBy: {
    userArn: 'STRING_VALUE'
  }
};
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.

      • body — required — (String)

        Text in the body of a Comment on a case.

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

      • contactArn — required — (String)

        A unique identifier of a contact in Amazon Connect.

    • file — (map)

      A file of related items.

      • fileArn — required — (String)

        The Amazon Resource Name (ARN) of a File in Amazon Connect.

  • domainId — (String)

    The unique identifier of the Cases domain.

  • performedBy — (map)

    Represents the creator of the related item.

    • userArn — (String)

      Represents the Amazon Connect ARN of the user.

  • type — (String)

    The type of a related item.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

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

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.

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

var params = {
  domainId: 'STRING_VALUE' /* required */
};
connectcases.deleteDomain(params, 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.

Returns:

• (AWS.Request) —

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

var params = {
  domainId: 'STRING_VALUE', /* required */
  fieldId: 'STRING_VALUE' /* required */
};
connectcases.deleteField(params, 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)

    Unique identifier 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.

var params = {
  domainId: 'STRING_VALUE', /* required */
  layoutId: 'STRING_VALUE' /* required */
};
connectcases.deleteLayout(params, 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.

Returns:

• (AWS.Request) —

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

var params = {
  domainId: 'STRING_VALUE', /* required */
  templateId: 'STRING_VALUE' /* required */
};
connectcases.deleteTemplate(params, 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.

Returns:

• (AWS.Request) —

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

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.

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

      • id — required — (String)

        Unique identifier of a field.

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

        • emptyValue — (map)

          An empty value.

        • stringValue — (String)

          String value type.

        • userArnValue — (String)

          Represents the user that performed the audit.

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

var params = {
  caseId: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
connectcases.getCaseAuditEvents(params, 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.

  • maxResults — (Integer)

    The maximum number of audit events to return. The current maximum supported value is 25. This is also the default 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.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • auditEvents — (Array<map>)

      A list of case audits where each represents a particular edit of the case.

      • eventId — required — (String)

        Unique identifier of a case audit history event.

      • fields — required — (Array<map>)

        A list of Case Audit History event fields.

        • eventFieldId — required — (String)

          Unique identifier of field in an Audit History entry.

        • newValue — required — (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 value type. Only one value can be provided.

          • emptyValue — (map)

            An empty value. You cannot set EmptyFieldValue on a field that is required on a case template.

            This structure will never have any data members. It signifies an empty value on a case field.

          • stringValue — (String)

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

          • userArnValue — (String)

            Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.

        • oldValue — (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 value type. Only one value can be provided.

          • emptyValue — (map)

            An empty value. You cannot set EmptyFieldValue on a field that is required on a case template.

            This structure will never have any data members. It signifies an empty value on a case field.

          • stringValue — (String)

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

          • userArnValue — (String)

            Can be either null, or have a String value type formatted as an ARN. Only one value can be provided.

      • performedBy — (map)

        Information of the user which performed the audit.

        • iamPrincipalArn — required — (String)

          Unique identifier of an IAM role.

        • user — (map)

          Represents the identity of the person who performed the action.

          • userArn — (String)

            Represents the Amazon Connect ARN of the user.

      • performedTime — required — (Date)

        Time at which an Audit History event took place.

      • relatedItemType — (String)

        The Type of the related item.

        Possible values include:
        • "Contact"
        • "Comment"
        • "File"
      • type — required — (String)

        The Type of an audit history event.

        Possible values include:
        • "Case.Created"
        • "Case.Updated"
        • "RelatedItem.Created"
    • 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.

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.

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

          • fields — required — (Array<map>)

            List of field identifiers.

            • id — required — (String)

              Unique identifier of a field.

        • relatedItemData — (map)

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

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

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.

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.

              • fields — required — (Array<map>)

                Represents an ordered list containing field related information.

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

              • fields — required — (Array<map>)

                Represents an ordered list containing field related information.

                • id — required — (String)

                  Unique identifier of a field.

              • name — (String)

                Name of the field group.

    • createdTime — (Date)

      Timestamp at which the resource was created.

    • deleted — (Boolean)

      Denotes whether or not the resource has been deleted.

    • lastModifiedTime — (Date)

      Timestamp at which the resource was created or last modified.

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

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:

    • createdTime — (Date)

      Timestamp at which the resource was created.

    • deleted — (Boolean)

      Denotes whether or not the resource has been deleted.

    • description — (String)

      A brief description of the template.

    • lastModifiedTime — (Date)

      Timestamp at which the resource was created or last modified.

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

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

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.

      • caseId — required — (String)

        A unique identifier of the case.

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

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.

      • domainArn — required — (String)

        The Amazon Resource Name (ARN) of the domain.

      • domainId — required — (String)

        The unique identifier of the domain.

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

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.

      • active — required — (Boolean)

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

      • name — required — (String)

        FieldOptionName has max length 100 and disallows trailing spaces.

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

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.

      • fieldArn — required — (String)

        The Amazon Resource Name (ARN) of the field.

      • fieldId — required — (String)

        The unique identifier of a field.

      • name — required — (String)

        Name of the field.

      • namespace — required — (String)

        The namespace of a field.

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

        The type of a field.

        Possible values include:
        • "Text"
        • "Number"
        • "Boolean"
        • "DateTime"
        • "SingleSelect"
        • "Url"
        • "User"
    • 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.

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.

      • layoutArn — required — (String)

        The Amazon Resource Name (ARN) of the layout.

      • layoutId — required — (String)

        The unique identifier for of the layout.

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

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.

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.

      • name — required — (String)

        The template name.

      • status — required — (String)

        The status of the template.

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

        The Amazon Resource Name (ARN) of the template.

      • templateId — required — (String)

        The unique identifier for the template.

Returns:

• (AWS.Request) —

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

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.

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

        • fields — required — (Array<map>)

          List of field identifiers.

          • id — required — (String)

            Unique identifier of a field.

      • relatedItemData — (map)

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

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

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',
          emptyValue: {
          },
          stringValue: 'STRING_VALUE',
          userArnValue: 'STRING_VALUE'
        }
      },
      equalTo: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          emptyValue: {
          },
          stringValue: 'STRING_VALUE',
          userArnValue: 'STRING_VALUE'
        }
      },
      greaterThan: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          emptyValue: {
          },
          stringValue: 'STRING_VALUE',
          userArnValue: 'STRING_VALUE'
        }
      },
      greaterThanOrEqualTo: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          emptyValue: {
          },
          stringValue: 'STRING_VALUE',
          userArnValue: 'STRING_VALUE'
        }
      },
      lessThan: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          emptyValue: {
          },
          stringValue: 'STRING_VALUE',
          userArnValue: 'STRING_VALUE'
        }
      },
      lessThanOrEqualTo: {
        id: 'STRING_VALUE', /* required */
        value: { /* required */
          booleanValue: true || false,
          doubleValue: 'NUMBER_VALUE',
          emptyValue: {
          },
          stringValue: 'STRING_VALUE',
          userArnValue: 'STRING_VALUE'
        }
      }
    },
    not: /* recursive CaseFilter */,
    orAll: [
      /* recursive CaseFilter */,
      /* more items */
    ]
  },
  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.

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

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • equalTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • greaterThan — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • greaterThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • lessThan — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • lessThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

      • orAll — (Array<map>)

        Provides "or all" filtering.

    • field — (map)

      A list of fields to filter on.

      • contains — (map)

        Object containing field identifier and value information.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

      • equalTo — (map)

        Object containing field identifier and value information.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

      • greaterThan — (map)

        Object containing field identifier and value information.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

      • greaterThanOrEqualTo — (map)

        Object containing field identifier and value information.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

      • lessThan — (map)

        Object containing field identifier and value information.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

      • lessThanOrEqualTo — (map)

        Object containing field identifier and value information.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

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

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • equalTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • greaterThan — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • greaterThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • lessThan — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • lessThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

      • orAll — (Array<map>)

        Provides "or all" filtering.

    • orAll — (Array<map>)

      Provides "or all" filtering.

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

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • equalTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • greaterThan — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • greaterThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • lessThan — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

        • lessThanOrEqualTo — (map)

          Object containing field identifier and value information.

          • id — required — (String)

            Unique identifier of a field.

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

            • emptyValue — (map)

              An empty value.

            • stringValue — (String)

              String value type.

            • userArnValue — (String)

              Represents the user that performed the audit.

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

    • fieldId — required — (String)

      Unique identifier of a field.

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

      • caseId — required — (String)

        A unique identifier of the case.

      • fields — required — (Array<map>)

        List of case field values.

        • id — required — (String)

          Unique identifier of a field.

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

          • emptyValue — (map)

            An empty value.

          • stringValue — (String)

            String value type.

          • userArnValue — (String)

            Represents the user that performed the audit.

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

var params = {
  caseId: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  filters: [
    {
      comment: {
      },
      contact: {
        channel: [
          'STRING_VALUE',
          /* more items */
        ],
        contactArn: 'STRING_VALUE'
      },
      file: {
        fileArn: '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.

    • file — (map)

      A filter for related items of this type of File.

      • fileArn — (String)

        The Amazon Resource Name (ARN) of the file.

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

      • associationTime — required — (Date)

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

      • content — required — (map)

        Represents the content of a particular type of related item.

        • comment — (map)

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

          • body — required — (String)

            Text in the body of a Comment on a case.

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

          • channel — required — (String)

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

          • connectedToSystemTime — required — (Date)

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

          • contactArn — required — (String)

            A unique identifier of a contact in Amazon Connect.

        • file — (map)

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

          • fileArn — required — (String)

            The Amazon Resource Name (ARN) of a File in Amazon Connect.

      • performedBy — (map)

        Represents the creator of the related item.

        • userArn — (String)

          Represents the Amazon Connect ARN of the user.

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

      • type — required — (String)

        Type of a related item.

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

Returns:

• (AWS.Request) —

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

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.

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.

var params = {
  caseId: 'STRING_VALUE', /* required */
  domainId: 'STRING_VALUE', /* required */
  fields: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      value: { /* required */
        booleanValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        emptyValue: {
        },
        stringValue: 'STRING_VALUE',
        userArnValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  performedBy: {
    userArn: 'STRING_VALUE'
  }
};
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.

    • id — required — (String)

      Unique identifier of a field.

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

      • emptyValue — (map)

        An empty value.

      • stringValue — (String)

        String value type.

      • userArnValue — (String)

        Represents the user that performed the audit.

  • performedBy — (map)

    Represents the identity of the person who performed the action.

    • userArn — (String)

      Represents the Amazon Connect ARN of the user.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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.

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.

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

            • fields — required — (Array<map>)

              Represents an ordered list containing field related information.

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

            • fields — required — (Array<map>)

              Represents an ordered list containing field related information.

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

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.

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