/

The Amazon SSM multi-region endpoint

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

POST

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.

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",
    "AssociationType": "string",
    "ResourceType": "string",
    "ResourceUri": "string"
}'

Response Example

200 - Example 1

{
    "AssociationId": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

OpsItemId

string

required

The ID of the OpsItem to which you want to associate a resource as a related item.

Match pattern:

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

AssociationType

string

required

The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.

ResourceType

string

required

The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:

AWS::SSMIncidents::IncidentRecord: an Incident Manager incident.

AWS::SSM::Document: a Systems Manager (SSM) document.

ResourceUri

string

required

The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.

Examples

Responses

🟢200Success

application/json

Body

AssociationId

string

optional

The association ID.

🟠480InternalServerError

🟠481OpsItemNotFoundException

🟠482OpsItemLimitExceededException

🟠483OpsItemInvalidParameterException

🟠484OpsItemRelatedItemAlreadyExistsException