You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EventBridge::Types::ListRulesRequest

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

Overview

Note:

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

{
  name_prefix: "RuleName",
  event_bus_name: "EventBusName",
  next_token: "NextToken",
  limit: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#event_bus_nameString

Limits the results to show only the rules associated with the specified event bus.

Returns:

  • (String)


1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1219

class ListRulesRequest < Struct.new(
  :name_prefix,
  :event_bus_name,
  :next_token,
  :limit)
  include Aws::Structure
end

#limitInteger

The maximum number of results to return.

Returns:

  • (Integer)


1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1219

class ListRulesRequest < Struct.new(
  :name_prefix,
  :event_bus_name,
  :next_token,
  :limit)
  include Aws::Structure
end

#name_prefixString

The prefix matching the rule name.

Returns:

  • (String)


1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1219

class ListRulesRequest < Struct.new(
  :name_prefix,
  :event_bus_name,
  :next_token,
  :limit)
  include Aws::Structure
end

#next_tokenString

The token returned by a previous call to retrieve the next set of results.

Returns:

  • (String)


1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1219

class ListRulesRequest < Struct.new(
  :name_prefix,
  :event_bus_name,
  :next_token,
  :limit)
  include Aws::Structure
end