Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateRelatedItems

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

Request Syntax


POST /updateRelatedItems HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "incidentRecordArn": "string",
   "relatedItemsUpdate": { ... }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A token that ensures that a client calls the operation only once with the specified details.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No

incidentRecordArn

The Amazon Resource Name (ARN) of the incident record that contains the related items that you update.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$

Required: Yes

relatedItemsUpdate

Details about the item that you are add to, or delete from, an incident.

Type: RelatedItemsUpdate object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 204

Response Elements

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

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this operation.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource causes an inconsistent state.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of UpdateRelatedItems.

Sample Request


POST /updateRelatedItems HTTP/1.1
Host: ssm-incidents.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-incidents.update-related-items
X-Amz-Date: 20210811T185139Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 325

{
	"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", 
	"relatedItemsUpdate": {
		"itemToRemove": {
			"type": "PARENT", 
			"value": {"arn": "arn:aws:ssm:us-east-1:111122223333:opsItem/oi-86700a5297dc"}
		}
	}, 
	"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}

Sample Response

{}