/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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 Getting started with 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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "OpsItemId": "string",
    "OpsItemArn": "string"
}'

Response Example

200 - Example 1

{
    "OpsItem": {}
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

OpsItemId

string

required

The ID of the OpsItem that you want to get.

Match pattern:

^(oi)-[0-9a-f]{12}$

OpsItemArn

string

optional

The OpsItem Amazon Resource Name (ARN).

>= 20 characters<= 2048 characters

Match pattern:

arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[0-9]{12}:opsitem.*

Examples

Responses

🟢200Success

application/json

Body

OpsItem

object

optional

The OpsItem.

🟠480InternalServerError

🟠481OpsItemNotFoundException

🟠482OpsItemAccessDeniedException