ssm_get_ops_item: Get information about an OpsItem by using the ID

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about 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
ssm_get_ops_item(OpsItemId)

Arguments

OpsItemId

[required] The ID of the OpsItem that you want to get.

Value

A list with the following 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
41
42
43
44
45
46
47
48
49
50
list(
  OpsItem = list(
    CreatedBy = "string",
    OpsItemType = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    Description = "string",
    LastModifiedBy = "string",
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    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",
    Version = "string",
    Title = "string",
    Source = "string",
    OperationalData = list(
      list(
        Value = "string",
        Type = "SearchableString"|"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"
    )
  )
)

Request syntax

1
2
3
svc$get_ops_item(
  OpsItemId = "string"
)

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