Skip to content

aws.ssm.get_ops_item

Example SQL Queries

SELECT * FROM
aws.ssm.get_ops_item
WHERE
"ops_item_id" = 'VALUE';

Description

Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. 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_id Required Input Column

The ID of the OpsItem that you want to get.

VARCHAR
ops_item_arn Input Column

The OpsItem Amazon Resource Name (ARN).

VARCHAR
_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
ops_item

The OpsItem.

STRUCT(
"created_by" VARCHAR,
"ops_item_type" VARCHAR,
"created_time" TIMESTAMP_S,
"description" VARCHAR,
"last_modified_by" VARCHAR,
"last_modified_time" TIMESTAMP_S,
"notifications" STRUCT(
"arn" VARCHAR
)[],
"priority" BIGINT,
"related_ops_items" STRUCT(
"ops_item_id" VARCHAR
)[],
"status" VARCHAR,
"ops_item_id" VARCHAR,
"version" VARCHAR,
"title" VARCHAR,
"source" VARCHAR,
"operational_data" MAP(VARCHAR, STRUCT(
"value" VARCHAR,
"type" VARCHAR
)),
"category" VARCHAR,
"severity" VARCHAR,
"actual_start_time" TIMESTAMP_S,
"actual_end_time" TIMESTAMP_S,
"planned_start_time" TIMESTAMP_S,
"planned_end_time" TIMESTAMP_S,
"ops_item_arn" VARCHAR
)
Show child fields
ops_item.actual_end_time

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

ops_item.actual_start_time

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

ops_item.category

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

ops_item.created_by

The ARN of the Amazon Web Services account that created the OpsItem.

ops_item.created_time

The date and time the OpsItem was created.

ops_item.description

The OpsItem description.

ops_item.last_modified_by

The ARN of the Amazon Web Services account that last updated the OpsItem.

ops_item.last_modified_time

The date and time the OpsItem was last updated.

ops_item.notifications[]
Show child fields
ops_item.notifications[].arn

The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.

ops_item.operational_data

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

ops_item.ops_item_arn

The OpsItem Amazon Resource Name (ARN).

ops_item.ops_item_id

The ID of the OpsItem.

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

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

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

ops_item.priority

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

ops_item.related_ops_items[]
Show child fields
ops_item.related_ops_items[].ops_item_id

The ID of an OpsItem related to the current OpsItem.

ops_item.severity

The severity of the OpsItem. Severity options range from 1 to 4.

ops_item.source

The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

ops_item.status

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

ops_item.title

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

ops_item.version

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.