[ aws . ssm ]

list-ops-item-related-items

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-ops-item-related-items is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Summaries

Synopsis

  list-ops-item-related-items
[--ops-item-id <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--ops-item-id (string)

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

--filters (list)

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

(structure)

Describes a filter for a specific list of related-item resources.

Key -> (string)

The name of the filter key. Supported values include ResourceUri , ResourceType , or AssociationId .

Values -> (list)

The values for the filter.

(string)

Operator -> (string)

The operator used by the filter call. The only supported operator is EQUAL .

Shorthand Syntax:

Key=string,Values=string,string,Operator=string ...

JSON Syntax:

[
  {
    "Key": "ResourceType"|"AssociationId"|"ResourceUri",
    "Values": ["string", ...],
    "Operator": "Equal"
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 list the related-item resources of an OpsItem

The following list-ops-item-related-items example lists the related-item resources of an OpsItem.

aws ssm list-ops-item-related-items \
    --ops-item-id "oi-f99f2EXAMPLE"

Output:

{
    "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": "2021-08-11T18:47:14.994000+00:00",
            "LastModifiedBy": {
                "Arn": "arn:aws:sts::111122223333:assumed-role/AWSServiceRoleForIncidentManager/IncidentResponse"
            },
            "LastModifiedTime": "2021-08-11T18:47:14.994000+00:00"
        }
    ]
}

For more information, see Working with Incident Manager incidents in OpsCenter in the AWS Systems Manager User Guide.

Output

NextToken -> (string)

The token for the next set of items to return. Use this token to get the next set of results.

Summaries -> (list)

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

(structure)

Summary information about related-item resources for an OpsItem.

OpsItemId -> (string)

The OpsItem ID.

AssociationId -> (string)

The association ID.

ResourceType -> (string)

The resource type.

AssociationType -> (string)

The association type.

ResourceUri -> (string)

The Amazon Resource Name (ARN) of the related-item resource.

CreatedBy -> (structure)

Information about the user or resource that created an OpsItem event.

Arn -> (string)

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.

CreatedTime -> (timestamp)

The time the related-item association was created.

LastModifiedBy -> (structure)

Information about the user or resource that created an OpsItem event.

Arn -> (string)

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem event.

LastModifiedTime -> (timestamp)

The time the related-item association was last updated.