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

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

Overview

Returns a list of all ActiveMQ users.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#broker_idString

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

Returns:

  • (String)


2295
2296
2297
2298
2299
2300
2301
2302
# File 'lib/aws-sdk-mq/types.rb', line 2295

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

#max_resultsInteger

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)


2295
2296
2297
2298
2299
2300
2301
2302
# File 'lib/aws-sdk-mq/types.rb', line 2295

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

#next_tokenString

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

Returns:

  • (String)


2295
2296
2297
2298
2299
2300
2301
2302
# File 'lib/aws-sdk-mq/types.rb', line 2295

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

#usersArray<Types::UserSummary>

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

Returns:



2295
2296
2297
2298
2299
2300
2301
2302
# File 'lib/aws-sdk-mq/types.rb', line 2295

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