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

Inherits:

Struct

• Object
• Struct
• Aws::MQ::Types::ListUsersOutput

Includes:

Structure

Defined in:

lib/aws-sdk-mq/types.rb

Overview

Returns a list of all ActiveMQ users.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #broker_id ⇒ String

  Required.

• #max_results ⇒ Integer

  Required.

• #next_token ⇒ String

  The token that specifies the next page of results Amazon MQ should return.

• #users ⇒ Array<Types::UserSummary>

  Required.

Instance Attribute Details

#broker_id ⇒ String

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

Returns:

• (String)

# 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_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)

# 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_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)

# 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

#users ⇒ Array<Types::UserSummary>

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

Returns:

• (Array<Types::UserSummary>)

# 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