Create Ops Item
ssm_create_ops_item | R Documentation |
Creates a new OpsItem¶
Description¶
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.
Usage¶
ssm_create_ops_item(Description, OpsItemType, OperationalData,
Notifications, Priority, RelatedOpsItems, Source, Title, Tags, Category,
Severity, ActualStartTime, ActualEndTime, PlannedStartTime,
PlannedEndTime, AccountId)
Arguments¶
Description
[required] 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.
OpsItemType
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.
OperationalData
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
describe_ops_items
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 theget_ops_item
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.Notifications
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Priority
The importance of this OpsItem in relation to other OpsItems in the system.
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.
Source
[required] The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
The source name can't contain the following strings:
aws
,amazon
, andamzn
.Title
[required] A short heading that describes the nature of the OpsItem and the impacted resource.
Tags
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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use theadd_tags_to_resource
operation.Category
Specify a category to assign to an OpsItem.
Severity
Specify a severity to assign to an OpsItem.
ActualStartTime
The time a runbook workflow started. Currently reported only for the OpsItem type
/aws/changerequest
.ActualEndTime
The time a runbook workflow ended. Currently reported only for the OpsItem type
/aws/changerequest
.PlannedStartTime
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type
/aws/changerequest
.PlannedEndTime
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type
/aws/changerequest
.AccountId
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.
Value¶
A list with the following syntax:
Request syntax¶
svc$create_ops_item(
Description = "string",
OpsItemType = "string",
OperationalData = list(
list(
Value = "string",
Type = "SearchableString"|"String"
)
),
Notifications = list(
list(
Arn = "string"
)
),
Priority = 123,
RelatedOpsItems = list(
list(
OpsItemId = "string"
)
),
Source = "string",
Title = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
Category = "string",
Severity = "string",
ActualStartTime = as.POSIXct(
"2015-01-01"
),
ActualEndTime = as.POSIXct(
"2015-01-01"
),
PlannedStartTime = as.POSIXct(
"2015-01-01"
),
PlannedEndTime = as.POSIXct(
"2015-01-01"
),
AccountId = "string"
)