Class: Aws::MQ::Types::ListUsersOutput

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

Overview

Returns a list of all ActiveMQ users.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#broker_id ⇒ String

Required. The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String) 


2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 2278

class ListUsersOutput < Struct.new(
  :broker_id,
  :max_results,
  :next_token,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

Returns:

  • (Integer) 


2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 2278

class ListUsersOutput < Struct.new(
  :broker_id,
  :max_results,
  :next_token,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

  • (String) 


2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 2278

class ListUsersOutput < Struct.new(
  :broker_id,
  :max_results,
  :next_token,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#users ⇒ Array<Types::UserSummary>

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Returns:



2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 2278

class ListUsersOutput < Struct.new(
  :broker_id,
  :max_results,
  :next_token,
  :users)
  SENSITIVE = []
  include Aws::Structure
end