Amazon Simple Systems Manager (SSM)
    Amazon Simple Systems Manager (SSM)
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST

      /

      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      POST
      /
      Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "OpsItemId": "string",
    "Filters": [],
    "MaxResults": 0,
    "NextToken": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "NextToken": "string",
    "Summaries": []
}

      Request

      Query Params
      MaxResults
      string 
      optional
      Pagination limit
      NextToken
      string 
      optional
      Pagination token
      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      OpsItemId
      string 
      optional
      The ID of the OpsItem for which you want to list all related-item resources.
      Match pattern:
      ^(oi)-[0-9a-f]{12}$
      Filters
      array[object (OpsItemRelatedItemsFilter) {3}] 
      optional
      One or more OpsItem filters. Use a filter to return a more specific list of results.
      Key
      enum<string> 
      required
      The name of the filter key. Supported values include ResourceUri, ResourceType, or AssociationId.
      Allowed values:
      ResourceTypeAssociationIdResourceUri
      Values
      array[string]
      required
      The values for the filter.
      Operator
      enum<string> 
      required
      The operator used by the filter call. The only supported operator is EQUAL.
      Allowed value:
      Equal
      MaxResults
      integer 
      optional
      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.
      >= 1<= 50
      NextToken
      string 
      optional
      The token for the next set of items to return. (You received this token from a previous call.)
      Examples

      Responses

      🟢200Success
      application/json
      Body
      NextToken
      string 
      optional
      The token for the next set of items to return. Use this token to get the next set of results.
      Summaries
      array[object (OpsItemRelatedItemSummary) {9}] 
      optional
      A list of related-item resources for the specified OpsItem.
      OpsItemId
      string 
      optional
      The OpsItem ID.
      Match pattern:
      ^(oi)-[0-9a-f]{12}$
      AssociationId
      string 
      optional
      The association ID.
      ResourceType
      string 
      optional
      The resource type.
      AssociationType
      string 
      optional
      The association type.
      ResourceUri
      string 
      optional
      The Amazon Resource Name (ARN) of the related-item resource.
      CreatedBy
      object 
      OpsItemIdentity
      optional
      Information about the user or resource that created an OpsItem event.
      CreatedTime
      string <date-time>
      optional
      The time the related-item association was created.
      LastModifiedBy
      object 
      OpsItemIdentity
      optional
      Information about the user or resource that created an OpsItem event.
      LastModifiedTime
      string <date-time>
      optional
      The time the related-item association was last updated.
      🟠480InternalServerError
      🟠481OpsItemInvalidParameterException
      Previous
      /
      Next
      /
      Built with