SSM / Client / associate_ops_item_related_item

associate_ops_item_related_item

SSM.Client.associate_ops_item_related_item(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.associate_ops_item_related_item(
    OpsItemId='string',
    AssociationType='string',
    ResourceType='string',
    ResourceUri='string'
)

Parameters:

• OpsItemId (string) –

  [REQUIRED]

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

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

Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string'
}

Response Structure

• (dict) –

  • AssociationId (string) –

    The association ID.

Exceptions

• SSM.Client.exceptions.InternalServerError

• SSM.Client.exceptions.OpsItemNotFoundException

• SSM.Client.exceptions.OpsItemLimitExceededException

• SSM.Client.exceptions.OpsItemInvalidParameterException

• SSM.Client.exceptions.OpsItemRelatedItemAlreadyExistsException