libZSservicesZSamazonka-mqZSamazonka-mq
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MQ.DescribeUser

Description

Returns information about an ActiveMQ user.

Synopsis

Creating a Request

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser' 

Fields

  • username :: Text

    The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • brokerId :: Text

    The unique ID that Amazon MQ generates for the broker.

Instances

Instances details
Eq DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Read DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Show DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Generic DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Associated Types

type Rep DescribeUser :: Type -> Type #

NFData DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Methods

rnf :: DescribeUser -> () #

Hashable DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

AWSRequest DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Associated Types

type AWSResponse DescribeUser #

ToHeaders DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

ToPath DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

ToQuery DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

type Rep DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.MQ.DescribeUser" "libZSservicesZSamazonka-mqZSamazonka-mq" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeUser Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

newDescribeUser Source #

Create a value of DescribeUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:username:DescribeUser', describeUser_username - The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

$sel:brokerId:DescribeUser', describeUser_brokerId - The unique ID that Amazon MQ generates for the broker.

Request Lenses

describeUser_username :: Lens' DescribeUser Text Source #

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

describeUser_brokerId :: Lens' DescribeUser Text Source #

The unique ID that Amazon MQ generates for the broker.

Destructuring the Response

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Constructors

DescribeUserResponse' 

Fields

  • groups :: Maybe [Text]

    The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • pending :: Maybe UserPendingChanges

    The status of the changes pending for the ActiveMQ user.

  • consoleAccess :: Maybe Bool

    Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

  • username :: Maybe Text

    Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • brokerId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeUserResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Read DescribeUserResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Show DescribeUserResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Generic DescribeUserResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Associated Types

type Rep DescribeUserResponse :: Type -> Type #

NFData DescribeUserResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

Methods

rnf :: DescribeUserResponse -> () #

type Rep DescribeUserResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeUser

newDescribeUserResponse Source #

Create a value of DescribeUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groups:DescribeUserResponse', describeUserResponse_groups - The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

$sel:pending:DescribeUserResponse', describeUserResponse_pending - The status of the changes pending for the ActiveMQ user.

$sel:consoleAccess:DescribeUserResponse', describeUserResponse_consoleAccess - Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

$sel:username:DescribeUser', describeUserResponse_username - Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

$sel:brokerId:DescribeUser', describeUserResponse_brokerId - Required. The unique ID that Amazon MQ generates for the broker.

$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

Response Lenses

describeUserResponse_groups :: Lens' DescribeUserResponse (Maybe [Text]) Source #

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

describeUserResponse_pending :: Lens' DescribeUserResponse (Maybe UserPendingChanges) Source #

The status of the changes pending for the ActiveMQ user.

describeUserResponse_consoleAccess :: Lens' DescribeUserResponse (Maybe Bool) Source #

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

describeUserResponse_username :: Lens' DescribeUserResponse (Maybe Text) Source #

Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

describeUserResponse_brokerId :: Lens' DescribeUserResponse (Maybe Text) Source #

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