Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkMail.DescribeGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the data available for the group.

Synopsis

data DescribeGroup = DescribeGroup' {
- organizationId :: Text
- groupId :: Text
}
newDescribeGroup :: Text -> Text -> DescribeGroup
describeGroup_organizationId :: Lens' DescribeGroup Text
describeGroup_groupId :: Lens' DescribeGroup Text
data DescribeGroupResponse = DescribeGroupResponse' {
- email :: Maybe Text
- state :: Maybe EntityState
- disabledDate :: Maybe POSIX
- name :: Maybe Text
- groupId :: Maybe Text
- enabledDate :: Maybe POSIX
- httpStatus :: Int
}
newDescribeGroupResponse :: Int -> DescribeGroupResponse
describeGroupResponse_email :: Lens' DescribeGroupResponse (Maybe Text)
describeGroupResponse_state :: Lens' DescribeGroupResponse (Maybe EntityState)
describeGroupResponse_disabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime)
describeGroupResponse_name :: Lens' DescribeGroupResponse (Maybe Text)
describeGroupResponse_groupId :: Lens' DescribeGroupResponse (Maybe Text)
describeGroupResponse_enabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime)
describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int

Creating a Request

data DescribeGroup Source #

See: newDescribeGroup smart constructor.

Constructors

DescribeGroup'
Fields organizationId :: Text The identifier for the organization under which the group exists. groupId :: Text The identifier for the group to be described.

Instances

Instances details

Eq DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods (==) :: DescribeGroup -> DescribeGroup -> Bool # (/=) :: DescribeGroup -> DescribeGroup -> Bool #
Read DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods readsPrec :: Int -> ReadS DescribeGroup # readList :: ReadS [DescribeGroup] # readPrec :: ReadPrec DescribeGroup # readListPrec :: ReadPrec [DescribeGroup] #
Show DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods showsPrec :: Int -> DescribeGroup -> ShowS # show :: DescribeGroup -> String # showList :: [DescribeGroup] -> ShowS #
Generic DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Associated Types type Rep DescribeGroup :: Type -> Type # Methods from :: DescribeGroup -> Rep DescribeGroup x # to :: Rep DescribeGroup x -> DescribeGroup #
NFData DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods rnf :: DescribeGroup -> () #
Hashable DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods hashWithSalt :: Int -> DescribeGroup -> Int # hash :: DescribeGroup -> Int #
ToJSON DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods toJSON :: DescribeGroup -> Value # toEncoding :: DescribeGroup -> Encoding # toJSONList :: [DescribeGroup] -> Value # toEncodingList :: [DescribeGroup] -> Encoding #
AWSRequest DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Associated Types type AWSResponse DescribeGroup # Methods request :: DescribeGroup -> Request DescribeGroup # response :: MonadResource m => Logger -> Service -> Proxy DescribeGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGroup))) #
ToHeaders DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods toHeaders :: DescribeGroup -> [Header] #
ToPath DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods toPath :: DescribeGroup -> ByteString #
ToQuery DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods toQuery :: DescribeGroup -> QueryString #
type Rep DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup type Rep DescribeGroup = D1 ('MetaData "DescribeGroup" "Amazonka.WorkMail.DescribeGroup" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeGroup Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup type AWSResponse DescribeGroup = DescribeGroupResponse

newDescribeGroup Source #

Arguments

:: Text	`$sel:organizationId:DescribeGroup'`
-> Text	`$sel:groupId:DescribeGroup'`
-> DescribeGroup

Create a value of DescribeGroup 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:organizationId:DescribeGroup', describeGroup_organizationId - The identifier for the organization under which the group exists.

$sel:groupId:DescribeGroup', describeGroup_groupId - The identifier for the group to be described.

Request Lenses

describeGroup_organizationId :: Lens' DescribeGroup Text Source #

The identifier for the organization under which the group exists.

describeGroup_groupId :: Lens' DescribeGroup Text Source #

The identifier for the group to be described.

Destructuring the Response

data DescribeGroupResponse Source #

See: newDescribeGroupResponse smart constructor.

Constructors

DescribeGroupResponse'

Fields

email :: Maybe Text
The email of the described group.
state :: Maybe EntityState
The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
disabledDate :: Maybe POSIX
The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.
name :: Maybe Text
The name of the described group.
groupId :: Maybe Text
The identifier of the described group.
enabledDate :: Maybe POSIX
The date and time when a user was registered to WorkMail, in UNIX epoch time format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeGroupResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods (==) :: DescribeGroupResponse -> DescribeGroupResponse -> Bool # (/=) :: DescribeGroupResponse -> DescribeGroupResponse -> Bool #
Read DescribeGroupResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods readsPrec :: Int -> ReadS DescribeGroupResponse # readList :: ReadS [DescribeGroupResponse] # readPrec :: ReadPrec DescribeGroupResponse # readListPrec :: ReadPrec [DescribeGroupResponse] #
Show DescribeGroupResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods showsPrec :: Int -> DescribeGroupResponse -> ShowS # show :: DescribeGroupResponse -> String # showList :: [DescribeGroupResponse] -> ShowS #
Generic DescribeGroupResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Associated Types type Rep DescribeGroupResponse :: Type -> Type # Methods from :: DescribeGroupResponse -> Rep DescribeGroupResponse x # to :: Rep DescribeGroupResponse x -> DescribeGroupResponse #
NFData DescribeGroupResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup Methods rnf :: DescribeGroupResponse -> () #
type Rep DescribeGroupResponse Source #
Instance details Defined in Amazonka.WorkMail.DescribeGroup type Rep DescribeGroupResponse = D1 ('MetaData "DescribeGroupResponse" "Amazonka.WorkMail.DescribeGroup" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DescribeGroupResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityState)) :: S1 ('MetaSel ('Just "disabledDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "enabledDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeGroupResponse Source #

Arguments

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

Create a value of DescribeGroupResponse 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:email:DescribeGroupResponse', describeGroupResponse_email - The email of the described group.

$sel:state:DescribeGroupResponse', describeGroupResponse_state - The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

$sel:disabledDate:DescribeGroupResponse', describeGroupResponse_disabledDate - The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

$sel:name:DescribeGroupResponse', describeGroupResponse_name - The name of the described group.

$sel:groupId:DescribeGroup', describeGroupResponse_groupId - The identifier of the described group.

$sel:enabledDate:DescribeGroupResponse', describeGroupResponse_enabledDate - The date and time when a user was registered to WorkMail, in UNIX epoch time format.

$sel:httpStatus:DescribeGroupResponse', describeGroupResponse_httpStatus - The response's http status code.

Response Lenses

describeGroupResponse_email :: Lens' DescribeGroupResponse (Maybe Text) Source #

The email of the described group.

describeGroupResponse_state :: Lens' DescribeGroupResponse (Maybe EntityState) Source #

The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

describeGroupResponse_disabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime) Source #

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

describeGroupResponse_name :: Lens' DescribeGroupResponse (Maybe Text) Source #

The name of the described group.

describeGroupResponse_groupId :: Lens' DescribeGroupResponse (Maybe Text) Source #

The identifier of the described group.

describeGroupResponse_enabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime) Source #

The date and time when a user was registered to WorkMail, in UNIX epoch time format.

describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int Source #

The response's http status code.