Class: Aws::SSM::Types::DescribeOpsItemsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DescribeOpsItemsRequest data as a hash:

{
  ops_item_filters: [
    {
      key: "Status", # required, accepts Status, CreatedBy, Source, Priority, Title, OpsItemId, CreatedTime, LastModifiedTime, OperationalData, OperationalDataKey, OperationalDataValue, ResourceId, AutomationId, Category, Severity
      values: ["OpsItemFilterValue"], # required
      operator: "Equal", # required, accepts Equal, Contains, GreaterThan, LessThan
    },
  ],
  max_results: 1,
  next_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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.

Returns:

  • (Integer)


5774
5775
5776
5777
5778
5779
5780
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5774

class DescribeOpsItemsRequest < Struct.new(
  :ops_item_filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


5774
5775
5776
5777
5778
5779
5780
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5774

class DescribeOpsItemsRequest < Struct.new(
  :ops_item_filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_filtersArray<Types::OpsItemFilter>

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"\}

Returns:



5774
5775
5776
5777
5778
5779
5780
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5774

class DescribeOpsItemsRequest < Struct.new(
  :ops_item_filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end