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

ListOpsItemRelatedItems

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of AWS Systems Manager.

Request Syntax


{
   "Filters": [ 
      { 
         "Key": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "OpsItemId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

One or more OpsItem filters. Use a filter to return a more specific list of results.

Type: Array of OpsItemRelatedItemsFilter objects

Required: No

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

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

Required: No

NextToken

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

Type: String

Required: No

OpsItemId

The ID of the OpsItem for which you want to list all related-item resources.

Type: String

Pattern: ^(oi)-[0-9a-f]{12}$

Required: No

Response Syntax


{
   "NextToken": "string",
   "Summaries": [ 
      { 
         "AssociationId": "string",
         "AssociationType": "string",
         "CreatedBy": { 
            "Arn": "string"
         },
         "CreatedTime": number,
         "LastModifiedBy": { 
            "Arn": "string"
         },
         "LastModifiedTime": number,
         "OpsItemId": "string",
         "ResourceType": "string",
         "ResourceUri": "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 token for the next set of items to return. Use this token to get the next set of results.

Type: String

Summaries

A list of related-item resources for the specified OpsItem.

Type: Array of OpsItemRelatedItemSummary objects

Errors

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

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

OpsItemInvalidParameterException

A specified parameter argument isn't valid. Verify the available arguments and try again.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListOpsItemRelatedItems.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListOpsItemRelatedItems
Content-Type: application/x-amz-json-1.1
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.list-ops-item-related-items
X-Amz-Date: 20240910T180314Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240910/us-east-1/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 32

{
	"OpsItemId": "oi-f99f2EXAMPLE"
}

Sample Response


{
    "Summaries": [
        {
            "OpsItemId": "oi-f99f2EXAMPLE",
            "AssociationId": "e2036148-cccb-490e-ac2a-390e5EXAMPLE",
            "ResourceType": "AWS::SSMIncidents::IncidentRecord",
            "AssociationType": "IsParentOf",
            "ResourceUri": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa",
            "CreatedBy": {
                "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse"
            },
            "CreatedTime": "2024-08-11T18:47:14.994000+00:00",
            "LastModifiedBy": {
                "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse"
            },
            "LastModifiedTime": "2024-08-11T18:47:14.994000+00:00"
        }
    ]
}