update-related-items¶

Description¶

Add or remove related items from the related items tab of an incident record.

Synopsis¶

  update-related-items
[--client-token <value>]
--incident-record-arn <value>
--related-items-update <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--client-token (string)

A token ensuring that the operation is called only once with the specified details.

--incident-record-arn (string)

The Amazon Resource Name (ARN) of the incident record containing the related items you are updating.

--related-items-update (structure)

Details about the item you are adding or deleting.

itemToAdd -> (structure)

Details about the related item you’re adding.

identifier -> (structure)

Details about the related item.

type -> (string)

The type of related item.

value -> (structure)

Details about the related item.

arn -> (string)

The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

metricDefinition -> (string)

The metric definition, if the related item is a metric in Amazon CloudWatch.

url -> (string)

The URL, if the related item is a non-Amazon Web Services resource.

title -> (string)

The title of the related item.

itemToRemove -> (structure)

Details about the related item you’re deleting.

type -> (string)

The type of related item.

value -> (structure)

Details about the related item.

arn -> (string)

The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

metricDefinition -> (string)

The metric definition, if the related item is a metric in Amazon CloudWatch.

url -> (string)

The URL, if the related item is a non-Amazon Web Services resource.

JSON Syntax:

{
  "itemToAdd": {
    "identifier": {
      "type": "ANALYSIS"|"INCIDENT"|"METRIC"|"PARENT"|"ATTACHMENT"|"OTHER"|"AUTOMATION"|"INVOLVED_RESOURCE",
      "value": {
        "arn": "string",
        "metricDefinition": "string",
        "url": "string"
      }
    },
    "title": "string"
  },
  "itemToRemove": {
    "type": "ANALYSIS"|"INCIDENT"|"METRIC"|"PARENT"|"ATTACHMENT"|"OTHER"|"AUTOMATION"|"INVOLVED_RESOURCE",
    "value": {
      "arn": "string",
      "metricDefinition": "string",
      "url": "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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To update an incidents related item

The following update-related-item example removes a related item from the specified incident record.

aws ssm-incidents update-related-items \
    --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \
    --related-items-update '{"itemToRemove": {"type": "OTHER", "value": {"url": "https://console.aws.amazon.com/systems-manager/opsitems/oi-8ef82158e190/workbench?region=us-east-1"}}}'

This command produces no output.

For more information, see Incident details in the Incident Manager User Guide.

Output¶

None

Table of Contents

Feedback

User Guide