[ aws . ssm ]

get-ops-summary

Description

View a summary of OpsItems based on specified filters and aggregators.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-ops-summary 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: Entities

Synopsis

  get-ops-summary
[--sync-name <value>]
[--filters <value>]
[--aggregators <value>]
[--result-attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--sync-name (string)

Specify the name of a resource data sync to get.

--filters (list)

Optional filters used to scope down the returned OpsItems.

(structure)

A filter for viewing OpsItem summaries.

Key -> (string)

The name of the filter.

Values -> (list)

The filter value.

(string)

Type -> (string)

The type of filter.

Shorthand Syntax:

Key=string,Values=string,string,Type=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
  }
  ...
]

--aggregators (list)

Optional aggregators that return counts of OpsItems based on one or more expressions.

(structure)

One or more aggregators for viewing counts of OpsItems using different dimensions such as Source , CreatedTime , or Source and CreatedTime , to name a few.

AggregatorType -> (string)

Either a Range or Count aggregator for limiting an OpsItem summary.

TypeName -> (string)

The data type name to use for viewing counts of OpsItems.

AttributeName -> (string)

The name of an OpsItem attribute on which to limit the count of OpsItems.

Values -> (map)

The aggregator value.

key -> (string)

value -> (string)

Filters -> (list)

The aggregator filters.

(structure)

A filter for viewing OpsItem summaries.

Key -> (string)

The name of the filter.

Values -> (list)

The filter value.

(string)

Type -> (string)

The type of filter.

Aggregators -> (list)

A nested aggregator for viewing counts of OpsItems.

(structure)

One or more aggregators for viewing counts of OpsItems using different dimensions such as Source , CreatedTime , or Source and CreatedTime , to name a few.

AggregatorType -> (string)

Either a Range or Count aggregator for limiting an OpsItem summary.

TypeName -> (string)

The data type name to use for viewing counts of OpsItems.

AttributeName -> (string)

The name of an OpsItem attribute on which to limit the count of OpsItems.

Values -> (map)

The aggregator value.

key -> (string)

value -> (string)

Filters -> (list)

The aggregator filters.

(structure)

A filter for viewing OpsItem summaries.

Key -> (string)

The name of the filter.

Values -> (list)

The filter value.

(string)

Type -> (string)

The type of filter.

JSON Syntax:

[
  {
    "AggregatorType": "string",
    "TypeName": "string",
    "AttributeName": "string",
    "Values": {"string": "string"
      ...},
    "Filters": [
      {
        "Key": "string",
        "Values": ["string", ...],
        "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
      }
      ...
    ],
    "Aggregators": [
      {
        "AggregatorType": "string",
        "TypeName": "string",
        "AttributeName": "string",
        "Values": {"string": "string"
          ...},
        "Filters": [
          {
            "Key": "string",
            "Values": ["string", ...],
            "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
          }
          ...
        ],
        "Aggregators":
      }
      ...
    ]
  }
  ...
]

--result-attributes (list)

The OpsItem data type to return.

(structure)

The OpsItem data type to return.

TypeName -> (string)

Name of the data type. Valid value: AWS:OpsItem, AWS:EC2InstanceInformation, AWS:OpsItemTrendline, or AWS:ComplianceSummary.

Shorthand Syntax:

TypeName=string ...

JSON Syntax:

[
  {
    "TypeName": "string"
  }
  ...
]

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view a summary of all OpsItems

The following get-ops-summary example displays a summary of all OpsItems in your AWS account.

aws ssm get-ops-summary

Output:

{
    "Entities": [
        {
            "Id": "oi-4309fEXAMPLE",
            "Data": {
                "AWS:OpsItem": {
                    "CaptureTime": "2020-02-26T18:58:32.918Z",
                    "Content": [
                        {
                            "AccountId": "111222333444",
                            "Category": "Availability",
                            "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "CreatedTime": "2020-02-26T19:10:44.149Z",
                            "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.",
                            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "LastModifiedTime": "2020-02-26T19:10:44.149Z",
                            "Notifications": "",
                            "OperationalData": "{\"/aws/automations\":{\"type\":\"SearchableString\",\"value\":\"[ { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedWindowsInstance\\\" }, { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedLinuxInstance\\\" } ]\"},\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ec2:us-east-2:111222333444:instance/i-0acbd0800fEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-EC2-instance-terminated\\\"}\"}}",
                            "OpsItemId": "oi-4309fEXAMPLE",
                            "RelatedItems": "",
                            "Severity": "3",
                            "Source": "EC2",
                            "Status": "Open",
                            "Title": "EC2 instance terminated"
                        }
                    ]
                }
            }
        },
        {
            "Id": "oi-bb2a0e6a4541",
            "Data": {
                "AWS:OpsItem": {
                    "CaptureTime": "2019-11-26T19:20:06.161Z",
                    "Content": [
                        {
                            "AccountId": "111222333444",
                            "Category": "Availability",
                            "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "CreatedTime": "2019-11-26T20:00:07.237Z",
                            "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.",
                            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "LastModifiedTime": "2019-11-26T20:00:07.237Z",
                            "Notifications": "",
                            "OperationalData": "{\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-0e83ba440dEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM-maintenance-window-execution-failed\\\"}\"}}",
                            "OpsItemId": "oi-bb2a0EXAMPLE",
                            "RelatedItems": "",
                            "Severity": "3",
                            "Source": "SSM",
                            "Status": "Open",
                            "Title": "SSM Maintenance Window execution failed"
                        }
                    ]
                }
            }
        }
    ]
}

For more information, see Working with OpsItems in the AWS Systems Manager User Guide.

Output

Entities -> (list)

The list of aggregated and filtered OpsItems.

(structure)

The result of the query.

Id -> (string)

The query ID.

Data -> (map)

The data returned by the query.

key -> (string)

value -> (structure)

The OpsItem summaries result item.

CaptureTime -> (string)

The time OpsItem data was captured.

Content -> (list)

The detailed data content for an OpsItem summaries result item.

(map)

key -> (string)

value -> (string)

NextToken -> (string)

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