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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#broker_idString

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

Returns:

  • (String)


1333
1334
1335
1336
1337
1338
1339
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1333

class ListUsersOutput < Struct.new(
  :broker_id,
  :max_results,
  :next_token,
  :users)
  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)


1333
1334
1335
1336
1337
1338
1339
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1333

class ListUsersOutput < Struct.new(
  :broker_id,
  :max_results,
  :next_token,
  :users)
  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)


1333
1334
1335
1336
1337
1338
1339
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1333

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

#usersArray<Types::UserSummary>

Required. The list of all ActiveMQ usernames for the specified broker.

Returns:



1333
1334
1335
1336
1337
1338
1339
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1333

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