GetOpsItemCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, GetOpsItemCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, GetOpsItemCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // GetOpsItemRequest
  OpsItemId: "STRING_VALUE", // required
  OpsItemArn: "STRING_VALUE",
};
const command = new GetOpsItemCommand(input);
const response = await client.send(command);
// { // GetOpsItemResponse
//   OpsItem: { // OpsItem
//     CreatedBy: "STRING_VALUE",
//     OpsItemType: "STRING_VALUE",
//     CreatedTime: new Date("TIMESTAMP"),
//     Description: "STRING_VALUE",
//     LastModifiedBy: "STRING_VALUE",
//     LastModifiedTime: new Date("TIMESTAMP"),
//     Notifications: [ // OpsItemNotifications
//       { // OpsItemNotification
//         Arn: "STRING_VALUE",
//       },
//     ],
//     Priority: Number("int"),
//     RelatedOpsItems: [ // RelatedOpsItems
//       { // RelatedOpsItem
//         OpsItemId: "STRING_VALUE", // required
//       },
//     ],
//     Status: "Open" || "InProgress" || "Resolved" || "Pending" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "CompletedWithSuccess" || "CompletedWithFailure" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "PendingApproval" || "Approved" || "Rejected" || "Closed",
//     OpsItemId: "STRING_VALUE",
//     Version: "STRING_VALUE",
//     Title: "STRING_VALUE",
//     Source: "STRING_VALUE",
//     OperationalData: { // OpsItemOperationalData
//       "<keys>": { // OpsItemDataValue
//         Value: "STRING_VALUE",
//         Type: "SearchableString" || "String",
//       },
//     },
//     Category: "STRING_VALUE",
//     Severity: "STRING_VALUE",
//     ActualStartTime: new Date("TIMESTAMP"),
//     ActualEndTime: new Date("TIMESTAMP"),
//     PlannedStartTime: new Date("TIMESTAMP"),
//     PlannedEndTime: new Date("TIMESTAMP"),
//     OpsItemArn: "STRING_VALUE",
//   },
// };

GetOpsItemCommand Input

See GetOpsItemCommandInput for more details

Parameter
Type
Description
OpsItemId
Required
string | undefined

The ID of the OpsItem that you want to get.

OpsItemArn
string | undefined

The OpsItem Amazon Resource Name (ARN).

GetOpsItemCommand Output

See GetOpsItemCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
OpsItem
OpsItem | undefined

The OpsItem.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

OpsItemAccessDeniedException
client

You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.

OpsItemNotFoundException
client

The specified OpsItem ID doesn't exist. Verify the ID and try again.

SSMServiceException
Base exception class for all service exceptions from SSM service.