Skip to content
AWS for Query.Farm

aws.ssm.describe_ops_items

Example SQL Queries

SELECT * FROM
aws.ssm.describe_ops_items;

Description

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Table Definition

Column NameColumn Data Type
ops_item_filters Input Column

One or more filters to limit the response.

  • Key: CreatedTime

    Operations: GreaterThan, LessThan

  • Key: LastModifiedBy

    Operations: Contains, Equals

  • Key: LastModifiedTime

    Operations: GreaterThan, LessThan

  • Key: Priority

    Operations: Equals

  • Key: Source

    Operations: Contains, Equals

  • Key: Status

    Operations: Equals

  • Key: Title*

    Operations: Equals,Contains

  • Key: OperationalData**

    Operations: Equals

  • Key: OperationalDataKey

    Operations: Equals

  • Key: OperationalDataValue

    Operations: Equals, Contains

  • Key: OpsItemId

    Operations: Equals

  • Key: ResourceId

    Operations: Contains

  • Key: AutomationId

    Operations: Equals

  • Key: AccountId

    Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

STRUCT(
    "key" VARCHAR,
    "values" VARCHAR[],
    "operator" VARCHAR
)[]
Show child fields
ops_item_filters[]
Show child fields
ops_item_filters[].key

The name of the filter.

ops_item_filters[].operator

The operator used by the filter call.

ops_item_filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
actual_end_time

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

TIMESTAMP_S
actual_start_time

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

TIMESTAMP_S
category

A list of OpsItems by category.

VARCHAR
created_by

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

VARCHAR
created_time

The date and time the OpsItem was created.

TIMESTAMP_S
last_modified_by

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

VARCHAR
last_modified_time

The date and time the OpsItem was last updated.

TIMESTAMP_S
operational_data

Operational data is custom data that provides useful reference details about the OpsItem. 

MAP(VARCHAR, STRUCT(
        "value" VARCHAR,
        "type" VARCHAR
    ))
ops_item_id

The ID of the OpsItem.

VARCHAR
ops_item_type

The type of OpsItem. Systems Manager supports the following types of OpsItems:

  • /aws/issue

    This type of OpsItem is used for default OpsItems created by OpsCenter.

  • /aws/changerequest

    This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

  • /aws/insight

    This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. 

VARCHAR
planned_end_time

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

TIMESTAMP_S
planned_start_time

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

TIMESTAMP_S
priority

The importance of this OpsItem in relation to other OpsItems in the system.

BIGINT
severity

A list of OpsItems by severity.

VARCHAR
source

The impacted Amazon Web Services resource.

VARCHAR
status

The OpsItem status. Status can be Open, In Progress, or Resolved.

VARCHAR
title

A short heading that describes the nature of the OpsItem and the impacted resource.

VARCHAR