ssm_update_ops_item: Edit or change an OpsItem

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Usage

1
2
3
4
ssm_update_ops_item(Description, OperationalData,
  OperationalDataToDelete, Notifications, Priority, RelatedOpsItems,
  Status, OpsItemId, Title, Category, Severity, ActualStartTime,
  ActualEndTime, PlannedStartTime, PlannedEndTime)

Arguments

Description

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

OperationalData

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the get_ops_item API action).

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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.

OperationalDataToDelete

Keys that you want to remove from the OperationalData map.

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.

Status

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

OpsItemId

[required] The ID of the OpsItem.

Title

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

Category

Specify a new category for an OpsItem.

Severity

Specify a new severity for 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.

Value

An empty list.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
svc$update_ops_item(
  Description = "string",
  OperationalData = list(
    list(
      Value = "string",
      Type = "SearchableString"|"String"
    )
  ),
  OperationalDataToDelete = list(
    "string"
  ),
  Notifications = list(
    list(
      Arn = "string"
    )
  ),
  Priority = 123,
  RelatedOpsItems = list(
    list(
      OpsItemId = "string"
    )
  ),
  Status = "Open"|"InProgress"|"Resolved"|"Pending"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|"CompletedWithSuccess"|"CompletedWithFailure"|"Scheduled"|"RunbookInProgress"|"PendingChangeCalendarOverride"|"ChangeCalendarOverrideApproved"|"ChangeCalendarOverrideRejected"|"PendingApproval"|"Approved"|"Rejected",
  OpsItemId = "string",
  Title = "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"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.