start-merge-cases¶

Description¶

Merges a secondary case into a primary case. The primary case, which you specify in the request URI, remains active. Both cases must belong to the same domain.

The merge runs asynchronously. To track its progress, call GetMergeCasesStatus . When the merge finishes, the selected field values and related items from the secondary case are on the primary case, the two cases are linked, and the secondary case is closed. Both cases record the merge in their audit history. For more information, see GetCaseAuditEvents .

Important things to know

Both cases must have the same customer, or at least one of them must have no customer.
While the merge runs, you can’t modify the secondary case or its related items, and you can’t delete the primary case. These requests return a ConflictException .
After the merge, the secondary case can be reopened, updated, and deleted, but it can’t be merged again.

The request fails with a ValidationException , and no merge starts, if:

The primary case and the secondary case are the same case.
Either case is closed.
Both cases have a customer, and the customers are different.
fieldsConfiguration selects a field that can’t be merged, or a field that the secondary case doesn’t have.
After the merge, the primary case would have more than 500 field values, or would exceed the maximum case size.

The request fails with a ServiceQuotaExceededException if, after the merge, either case would exceed the quota for related items per case. For the primary case, the count is its existing related items, plus the related items moved from the secondary case, plus the new case link. See Connect Customer Cases quotas .

The request fails with a ConflictException if either case is already part of a merge that is running, or was previously merged into another case as the secondary case.

Endpoints : See Connect Customer endpoints and quotas .

Synopsis¶

  start-merge-cases
--domain-id <value>
--case-id <value>
--secondary-case-ids <value>
[--fields-configuration <value>]
[--related-items-configuration <value>]
[--performed-by <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options¶

--domain-id (string) [required]

The unique identifier of the Cases domain.

Constraints:

min: 1

max: 500

--case-id (string) [required]

The unique identifier of the primary case. The primary case remains active and receives the merged field values and related items. The cases can use different templates, and the primary case keeps its template.

Constraints:

min: 1

max: 500

pattern: [A-Za-z0-9\-._/:#=+-]*

--secondary-case-ids (list) [required]

The unique identifier of the secondary case to merge into the primary case. The secondary case is closed when the merge finishes. Specify exactly one case ID.

Constraints:

min: 1

max: 1

(string)

Constraints:

min: 1

max: 500

pattern: [A-Za-z0-9\-._/:#=+-]*

Syntax:

"string" "string" ...

--fields-configuration (list)

The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue , assigned_user , summary , and case_reason . If you select any other system field, the request fails with a ValidationException .

For each field that can be merged, the merge works as follows:

If you select the field, the primary case gets the secondary case’s value. If the secondary case’s value is empty, the primary case’s value is cleared.

If you don’t select the field and the primary case has a value for it, the primary case keeps its value.

If you don’t select the field and the primary case doesn’t have the field, or its value is empty, the primary case gets the secondary case’s value. This applies even when the field isn’t on the primary case’s template.

Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.

Specify at most one entry, and set its sourceCaseId to the secondary case ID.

(structure)

Specifies the fields whose values to take from the secondary case when you merge cases.

fieldIds -> (list) [required]

The fields whose values to take from the source case. Each field must exist on the source case and must be a field that can be merged. Don’t list the same field more than once.

(structure)

Object for unique identifier of a field.

id -> (string) [required]

Unique identifier of a field.

Constraints:

min: 1

max: 500

sourceCaseId -> (string) [required]

The unique identifier of the case to take the field values from. This must be the secondary case.

Constraints:

min: 1

max: 500

pattern: [A-Za-z0-9\-._/:#=+-]*

Shorthand Syntax:

fieldIds=[{id=string},{id=string}],sourceCaseId=string ...

JSON Syntax:

[
  {
    "fieldIds": [
      {
        "id": "string"
      }
      ...
    ],
    "sourceCaseId": "string"
  }
  ...
]

--related-items-configuration (structure)

The types of related items to move from the secondary case to the primary case. Related items of a type that you don’t select, or set to false , stay on the closed secondary case. If you omit this parameter, no related items are moved.

File, SLA, and work plan related items are never moved. They stay on the secondary case.

comment -> (boolean)

Whether to move Comment related items to the primary case.

connectCase -> (boolean)

Whether to move Case related items to the primary case. If the primary case already links to the same case, the secondary case’s link is removed instead of moved.

contact -> (boolean)

Whether to move Contact related items to the primary case. If the same contact is related to both cases, the primary case keeps its related item and gets any tag keys that only the secondary case’s related item has.

custom -> (boolean)

Whether to move Custom related items to the primary case.

Shorthand Syntax:

comment=boolean,connectCase=boolean,contact=boolean,custom=boolean

JSON Syntax:

{
  "comment": true|false,
  "connectCase": true|false,
  "contact": true|false,
  "custom": true|false
}

--performed-by (tagged union structure)

The user who performed the merge. If you provide userArn , you must also have DescribeUser permission on the ARN of that user.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: userArn, customEntity.

userArn -> (string)

Represents the Connect Customer ARN of the user.

Constraints:

min: 1

max: 500

customEntity -> (string)

Any provided entity.

Constraints:

min: 1

max: 500

pattern: [a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]

Shorthand Syntax:

userArn=string,customEntity=string

JSON Syntax:

{
  "userArn": "string",
  "customEntity": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

--help (boolean)

Display help for the command/subcommand.

Output¶

None

Table of Contents

Feedback

User Guide

start-merge-cases¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶