Network.AWS.WorkMail.DescribeGroup

Returns the data available for the group.

Creating a Request

describeGroup

Arguments

:: Text

dgOrganizationId

-> Text

dgGroupId

-> DescribeGroup

Creates a value of DescribeGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dgOrganizationId - The identifier for the organization under which the group exists.
• dgGroupId - The identifier for the group to be described.

data DescribeGroup

See: describeGroup smart constructor.

Instances

Eq DescribeGroup

Methods

(==) :: DescribeGroup -> DescribeGroup -> Bool

(/=) :: DescribeGroup -> DescribeGroup -> Bool

Data DescribeGroup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGroup -> c DescribeGroup

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGroup

toConstr :: DescribeGroup -> Constr

dataTypeOf :: DescribeGroup -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGroup)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGroup)

gmapT :: (forall b. Data b => b -> b) -> DescribeGroup -> DescribeGroup

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroup -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroup -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeGroup -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGroup -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGroup -> m DescribeGroup

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroup -> m DescribeGroup

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroup -> m DescribeGroup

Read DescribeGroup

Methods

readsPrec :: Int -> ReadS DescribeGroup

readList :: ReadS [DescribeGroup]

readPrec :: ReadPrec DescribeGroup

readListPrec :: ReadPrec [DescribeGroup]

Show DescribeGroup

Methods

showsPrec :: Int -> DescribeGroup -> ShowS

show :: DescribeGroup -> String

showList :: [DescribeGroup] -> ShowS

Generic DescribeGroup

Associated Types

type Rep DescribeGroup :: * -> *

Methods

from :: DescribeGroup -> Rep DescribeGroup x

to :: Rep DescribeGroup x -> DescribeGroup

Hashable DescribeGroup

Methods

hashWithSalt :: Int -> DescribeGroup -> Int

hash :: DescribeGroup -> Int

ToJSON DescribeGroup

Methods

toJSON :: DescribeGroup -> Value

toEncoding :: DescribeGroup -> Encoding

toJSONList :: [DescribeGroup] -> Value

toEncodingList :: [DescribeGroup] -> Encoding

NFData DescribeGroup

Methods

rnf :: DescribeGroup -> ()

AWSRequest DescribeGroup

Associated Types

type Rs DescribeGroup :: *

Methods

request :: DescribeGroup -> Request DescribeGroup

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeGroup -> ClientResponse -> m (Response DescribeGroup)

ToHeaders DescribeGroup

Methods

toHeaders :: DescribeGroup -> [Header]

ToPath DescribeGroup

Methods

toPath :: DescribeGroup -> ByteString

ToQuery DescribeGroup

Methods

toQuery :: DescribeGroup -> QueryString

type Rep DescribeGroup

type Rep DescribeGroup = D1 * (MetaData "DescribeGroup" "Network.AWS.WorkMail.DescribeGroup" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "DescribeGroup'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dgOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dgGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs DescribeGroup

type Rs DescribeGroup = DescribeGroupResponse

Request Lenses

dgOrganizationId :: Lens' DescribeGroup Text

The identifier for the organization under which the group exists.

dgGroupId :: Lens' DescribeGroup Text

The identifier for the group to be described.

Destructuring the Response

describeGroupResponse

Arguments

:: Int

desrsResponseStatus

-> DescribeGroupResponse

Creates a value of DescribeGroupResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• desrsEmail - The email of the described group.
• desrsState - The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).
• desrsDisabledDate - The date and time when a user was deregistered from Amazon WorkMail, in UNIX epoch time format.
• desrsName - The name of the described group.
• desrsGroupId - The identifier of the described group.
• desrsEnabledDate - The date and time when a user was registered to Amazon WorkMail, in UNIX epoch time format.
• desrsResponseStatus - -- | The response status code.

data DescribeGroupResponse

See: describeGroupResponse smart constructor.

Instances

Eq DescribeGroupResponse

Methods

(==) :: DescribeGroupResponse -> DescribeGroupResponse -> Bool

(/=) :: DescribeGroupResponse -> DescribeGroupResponse -> Bool

Data DescribeGroupResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGroupResponse -> c DescribeGroupResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGroupResponse

toConstr :: DescribeGroupResponse -> Constr

dataTypeOf :: DescribeGroupResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGroupResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGroupResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeGroupResponse -> DescribeGroupResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroupResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroupResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeGroupResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGroupResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGroupResponse -> m DescribeGroupResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroupResponse -> m DescribeGroupResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroupResponse -> m DescribeGroupResponse

Read DescribeGroupResponse

Methods

readsPrec :: Int -> ReadS DescribeGroupResponse

readList :: ReadS [DescribeGroupResponse]

readPrec :: ReadPrec DescribeGroupResponse

readListPrec :: ReadPrec [DescribeGroupResponse]

Show DescribeGroupResponse

Methods

showsPrec :: Int -> DescribeGroupResponse -> ShowS

show :: DescribeGroupResponse -> String

showList :: [DescribeGroupResponse] -> ShowS

Generic DescribeGroupResponse

Associated Types

type Rep DescribeGroupResponse :: * -> *

Methods

from :: DescribeGroupResponse -> Rep DescribeGroupResponse x

to :: Rep DescribeGroupResponse x -> DescribeGroupResponse

NFData DescribeGroupResponse

Methods

rnf :: DescribeGroupResponse -> ()

type Rep DescribeGroupResponse

type Rep DescribeGroupResponse = D1 * (MetaData "DescribeGroupResponse" "Network.AWS.WorkMail.DescribeGroup" "amazonka-workmail-1.6.0-8HAZCS55pFIAg9ZAclEI0R" False) (C1 * (MetaCons "DescribeGroupResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_desrsEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desrsState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EntityState))) (S1 * (MetaSel (Just Symbol "_desrsDisabledDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_desrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_desrsGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desrsEnabledDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_desrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

desrsEmail :: Lens' DescribeGroupResponse (Maybe Text)

The email of the described group.

desrsState :: Lens' DescribeGroupResponse (Maybe EntityState)

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

desrsDisabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime)

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

desrsName :: Lens' DescribeGroupResponse (Maybe Text)

The name of the described group.

desrsGroupId :: Lens' DescribeGroupResponse (Maybe Text)

The identifier of the described group.

desrsEnabledDate :: Lens' DescribeGroupResponse (Maybe UTCTime)

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

desrsResponseStatus :: Lens' DescribeGroupResponse Int

• - | The response status code.