Describe Ops Items

ssm_describe_ops_items

R Documentation

Query a set of OpsItems

Description

Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. 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_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: Equals,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

• Key: AccountId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**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:

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"|"Closed",
      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

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"|"InsightByType"|"AccountId",
      Values = list(
        "string"
      ),
      Operator = "Equal"|"Contains"|"GreaterThan"|"LessThan"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)