ssm_describe_ops_items: Query a set of OpsItems

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. 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_describe_ops_items(OpsItemFilters, MaxResults, NextToken)

Arguments

OpsItemFilters

One or more filters to limit the response.

  • Key: CreatedTime

    Operations: GreaterThan, LessThan

  • Key: LastModifiedBy

    Operations: Contains, Equals

  • Key: LastModifiedTime

    Operations: GreaterThan, LessThan

  • Key: Priority

    Operations: Equals

  • Key: Source

    Operations: Contains, Equals

  • Key: Status

    Operations: Equals

  • Key: Title

    Operations: Contains

  • Key: OperationalData*

    Operations: Equals

  • Key: OperationalDataKey

    Operations: Equals

  • Key: OperationalDataValue

    Operations: Equals, Contains

  • Key: OpsItemId

    Operations: Equals

  • Key: ResourceId

    Operations: Contains

  • Key: AutomationId

    Operations: Equals

*If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

NextToken

A token to start the list. Use this token to get the next set of results.

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
list(
  NextToken = "string",
  OpsItemSummaries = list(
    list(
      CreatedBy = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedBy = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      Priority = 123,
      Source = "string",
      Status = "Open"|"InProgress"|"Resolved"|"Pending"|"TimedOut"|"Cancelling"|"Cancelled"|"Failed"|"CompletedWithSuccess"|"CompletedWithFailure"|"Scheduled"|"RunbookInProgress"|"PendingChangeCalendarOverride"|"ChangeCalendarOverrideApproved"|"ChangeCalendarOverrideRejected"|"PendingApproval"|"Approved"|"Rejected",
      OpsItemId = "string",
      Title = "string",
      OperationalData = list(
        list(
          Value = "string",
          Type = "SearchableString"|"String"
        )
      ),
      Category = "string",
      Severity = "string",
      OpsItemType = "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
 4
 5
 6
 7
 8
 9
10
11
12
13
svc$describe_ops_items(
  OpsItemFilters = list(
    list(
      Key = "Status"|"CreatedBy"|"Source"|"Priority"|"Title"|"OpsItemId"|"CreatedTime"|"LastModifiedTime"|"ActualStartTime"|"ActualEndTime"|"PlannedStartTime"|"PlannedEndTime"|"OperationalData"|"OperationalDataKey"|"OperationalDataValue"|"ResourceId"|"AutomationId"|"Category"|"Severity"|"OpsItemType"|"ChangeRequestByRequesterArn"|"ChangeRequestByRequesterName"|"ChangeRequestByApproverArn"|"ChangeRequestByApproverName"|"ChangeRequestByTemplate"|"ChangeRequestByTargetsResourceGroup",
      Values = list(
        "string"
      ),
      Operator = "Equal"|"Contains"|"GreaterThan"|"LessThan"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)

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