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

ListRelatedItems

List all related items for an incident record.

Request Syntax


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

{
   "incidentRecordArn": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

incidentRecordArn

The Amazon Resource Name (ARN) of the incident record containing the listed related items.

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

maxResults

The maximum number of related items per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token for the next set of items to return. (You received this token from a previous call.)

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "generatedId": "string",
         "identifier": { 
            "type": "string",
            "value": { ... }
         },
         "title": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Type: String

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

relatedItems

Details about each related item.

Type: Array of RelatedItem objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

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

InternalServerException

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

HTTP Status Code: 500

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

Sample Request


POST /listRelatedItems 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.list-related-items
X-Amz-Date: 20210811T172030Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 130

{
	"incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/78bd9919-b9ac-962d-91e0-149960600e3f"
}

Sample Response


{
    "relatedItems": [
        {
            "identifier": {
                "type": "OTHER",
                "value": {
                    "url": "https://us-east-1.console.aws.amazon.com/systems-manager/opsitems/oi-cd91EXAMPLE/workbench?region=us-east-1"
                }
            },
            "title": "Example related item",
            "generatedId": "related-item/PARENT/F95638BAA087E072DC56189CB4D2ADEC"

        },
        {
            "identifier": {
                "type": "PARENT",
                "value": {
                    "arn": "arn:aws:ssm:us-east-1:111122223333:opsitem/oi-40089EXAMPLE"
                }
            },
            "title": "parentItem",
            "generatedId": "related-item/PARENT/F95638BAA087E072DC56189CB4D2ADEC"

        }
    ]
}