search-related-items¶

Description¶

Searches for related items that are associated with a case.

Note

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

Synopsis¶

  search-related-items
--case-id <value>
--domain-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Options¶

--case-id (string)

A unique identifier of the case.

--domain-id (string)

The unique identifier of the Cases domain.

--filters (list)

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

(tagged union structure)

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact, file, sla.

comment -> (structure)

A filter for related items of type Comment .

contact -> (structure)

A filter for related items of type Contact .

channel -> (list)

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

(string)

contactArn -> (string)

A unique identifier of a contact in Amazon Connect.

file -> (structure)

A filter for related items of this type of File .

fileArn -> (string)

The Amazon Resource Name (ARN) of the file.

sla -> (structure)

Filter for related items of type SLA .

name -> (string)

Name of an SLA.

status -> (string)

Status of an SLA.

Shorthand Syntax:

comment={},contact={channel=[string,string],contactArn=string},file={fileArn=string},sla={name=string,status=string} ...

JSON Syntax:

[
  {
    "comment": {

    },
    "contact": {
      "channel": ["string", ...],
      "contactArn": "string"
    },
    "file": {
      "fileArn": "string"
    },
    "sla": {
      "name": "string",
      "status": "Active"|"Overdue"|"Met"|"NotMet"
    }
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

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

Output¶

nextToken -> (string)

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

relatedItems -> (list)

A list of items related to a case.

(structure)

A list of items that represent RelatedItems.

associationTime -> (timestamp)

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

content -> (tagged union structure)

Represents the content of a particular type of related item.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact, file, sla.

comment -> (structure)

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

body -> (string)

Text in the body of a Comment on a case.

contentType -> (string)

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

contact -> (structure)

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

channel -> (string)

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

connectedToSystemTime -> (timestamp)

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

contactArn -> (string)

A unique identifier of a contact in Amazon Connect.

file -> (structure)

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

fileArn -> (string)

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

sla -> (structure)

Represents the content of an SLA to be returned to agents.

slaConfiguration -> (structure)

Represents an SLA configuration.

completionTime -> (timestamp)

Time at which an SLA was completed.

fieldId -> (string)

Unique identifier of a field.

name -> (string)

Name of an SLA.

status -> (string)

Status of an SLA.

targetFieldValues -> (list)

Represents a list of target field values for the fieldId specified in SlaConfiguration.

(tagged union structure)

Object to store union of Field values.

Note
The Summary system field accepts 3000 characters while all other fields accept 500 characters.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, emptyValue, stringValue, userArnValue.

booleanValue -> (boolean)

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

doubleValue -> (double)

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

emptyValue -> (structure)

An empty value.

stringValue -> (string)

String value type.

userArnValue -> (string)

Represents the user that performed the audit.

targetTime -> (timestamp)

Target time by which an SLA should be completed.

type -> (string)

Type of SLA.

performedBy -> (tagged union structure)

Represents the creator of the related item.

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

customEntity -> (string)

Any provided entity.

userArn -> (string)

Represents the Amazon Connect ARN of the user.

relatedItemId -> (string)

Unique identifier of a related item.

tags -> (map)

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.

key -> (string)

value -> (string)

type -> (string)

Type of a related item.

Table of Contents

Feedback

User Guide

Note

Note

Note

Note

Note