Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MQ.DescribeUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about an ActiveMQ user.

Synopsis

data DescribeUser = DescribeUser' {
- username :: Text
- brokerId :: Text
}
newDescribeUser :: Text -> Text -> DescribeUser
describeUser_username :: Lens' DescribeUser Text
describeUser_brokerId :: Lens' DescribeUser Text
data DescribeUserResponse = DescribeUserResponse' {
- brokerId :: Maybe Text
- consoleAccess :: Maybe Bool
- groups :: Maybe [Text]
- pending :: Maybe UserPendingChanges
- username :: Maybe Text
- httpStatus :: Int
}
newDescribeUserResponse :: Int -> DescribeUserResponse
describeUserResponse_brokerId :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_consoleAccess :: Lens' DescribeUserResponse (Maybe Bool)
describeUserResponse_groups :: Lens' DescribeUserResponse (Maybe [Text])
describeUserResponse_pending :: Lens' DescribeUserResponse (Maybe UserPendingChanges)
describeUserResponse_username :: Lens' DescribeUserResponse (Maybe Text)
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int

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

ToHeaders DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods toHeaders :: DescribeUser -> [Header] #
ToPath DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods toPath :: DescribeUser -> ByteString #
ToQuery DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods toQuery :: DescribeUser -> QueryString #
AWSRequest DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Associated Types type AWSResponse DescribeUser # Methods request :: (Service -> Service) -> DescribeUser -> Request DescribeUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUser))) #
Generic DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Associated Types type Rep DescribeUser :: Type -> Type # Methods from :: DescribeUser -> Rep DescribeUser x # to :: Rep DescribeUser x -> DescribeUser #
Read DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUser # readList :: ReadS [DescribeUser] # readPrec :: ReadPrec DescribeUser # readListPrec :: ReadPrec [DescribeUser] #
Show DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods showsPrec :: Int -> DescribeUser -> ShowS # show :: DescribeUser -> String # showList :: [DescribeUser] -> ShowS #
NFData DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods rnf :: DescribeUser -> () #
Eq DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods (==) :: DescribeUser -> DescribeUser -> Bool # (/=) :: DescribeUser -> DescribeUser -> Bool #
Hashable DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods hashWithSalt :: Int -> DescribeUser -> Int # hash :: DescribeUser -> Int #
type AWSResponse DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser type AWSResponse DescribeUser = DescribeUserResponse
type Rep DescribeUser Source #
Instance details Defined in Amazonka.MQ.DescribeUser type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.MQ.DescribeUser" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeUser Source #

Arguments

:: Text	`DescribeUser`
-> Text	`DescribeUser`
-> DescribeUser

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:

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.

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

brokerId :: Maybe Text
Required. The unique ID that Amazon MQ generates for the broker.
consoleAccess :: Maybe Bool
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
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.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeUserResponse Source #
Instance details Defined in Amazonka.MQ.DescribeUser Associated Types type Rep DescribeUserResponse :: Type -> Type # Methods from :: DescribeUserResponse -> Rep DescribeUserResponse x # to :: Rep DescribeUserResponse x -> DescribeUserResponse #
Read DescribeUserResponse Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUserResponse # readList :: ReadS [DescribeUserResponse] # readPrec :: ReadPrec DescribeUserResponse # readListPrec :: ReadPrec [DescribeUserResponse] #
Show DescribeUserResponse Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods showsPrec :: Int -> DescribeUserResponse -> ShowS # show :: DescribeUserResponse -> String # showList :: [DescribeUserResponse] -> ShowS #
NFData DescribeUserResponse Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods rnf :: DescribeUserResponse -> () #
Eq DescribeUserResponse Source #
Instance details Defined in Amazonka.MQ.DescribeUser Methods (==) :: DescribeUserResponse -> DescribeUserResponse -> Bool # (/=) :: DescribeUserResponse -> DescribeUserResponse -> Bool #
type Rep DescribeUserResponse Source #
Instance details Defined in Amazonka.MQ.DescribeUser type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.MQ.DescribeUser" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "consoleAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "pending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPendingChanges)) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserResponse'`
-> DescribeUserResponse

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:

DescribeUser, describeUserResponse_brokerId - Required. The unique ID that Amazon MQ generates for the broker.

DescribeUserResponse, describeUserResponse_consoleAccess - Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

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.

DescribeUserResponse, describeUserResponse_pending - The status of the changes pending for the ActiveMQ user.

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:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

Response Lenses

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

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

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

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

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_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_httpStatus :: Lens' DescribeUserResponse Int Source #

The response's http status code.