/AWS1/CL_SSM=>CREATEOPSITEM()

About CreateOpsItem

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new 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.

Method Signature

IMPORTING

Required arguments:

IV_DESCRIPTION TYPE /AWS1/SSMOPSITEMDESCRIPTION /AWS1/SSMOPSITEMDESCRIPTION

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.

IV_SOURCE TYPE /AWS1/SSMOPSITEMSOURCE /AWS1/SSMOPSITEMSOURCE

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

The source name can't contain the following strings: aws, amazon, and amzn.

IV_TITLE TYPE /AWS1/SSMOPSITEMTITLE /AWS1/SSMOPSITEMTITLE

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

Optional arguments:

IV_OPSITEMTYPE TYPE /AWS1/SSMOPSITEMTYPE /AWS1/SSMOPSITEMTYPE

The type of OpsItem to create. 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.

IT_OPERATIONALDATA TYPE /AWS1/CL_SSMOPSITEMDATAVALUE=>TT_OPSITEMOPERATIONALDATA TT_OPSITEMOPERATIONALDATA

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 Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.

IT_NOTIFICATIONS TYPE /AWS1/CL_SSMOPSITEMNOTIF=>TT_OPSITEMNOTIFICATIONS TT_OPSITEMNOTIFICATIONS

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

IV_PRIORITY TYPE /AWS1/SSMOPSITEMPRIORITY /AWS1/SSMOPSITEMPRIORITY

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

IT_RELATEDOPSITEMS TYPE /AWS1/CL_SSMRELATEDOPSITEM=>TT_RELATEDOPSITEMS TT_RELATEDOPSITEMS

One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

IT_TAGS TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST TT_TAGLIST

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

IV_CATEGORY TYPE /AWS1/SSMOPSITEMCATEGORY /AWS1/SSMOPSITEMCATEGORY

Specify a category to assign to an OpsItem.

IV_SEVERITY TYPE /AWS1/SSMOPSITEMSEVERITY /AWS1/SSMOPSITEMSEVERITY

Specify a severity to assign to an OpsItem.

IV_ACTUALSTARTTIME TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

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

IV_ACTUALENDTIME TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

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

IV_PLANNEDSTARTTIME TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

IV_PLANNEDENDTIME TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

IV_ACCOUNTID TYPE /AWS1/SSMOPSITEMACCOUNTID /AWS1/SSMOPSITEMACCOUNTID

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SSMCREATEOPSITEMRSP /AWS1/CL_SSMCREATEOPSITEMRSP