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.CognitoIdentityProvider.GetGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a group.

Calling this action requires developer credentials.

Synopsis

data GetGroup = GetGroup' {
- groupName :: Text
- userPoolId :: Text
}
newGetGroup :: Text -> Text -> GetGroup
getGroup_groupName :: Lens' GetGroup Text
getGroup_userPoolId :: Lens' GetGroup Text
data GetGroupResponse = GetGroupResponse' {
- group' :: Maybe GroupType
- httpStatus :: Int
}
newGetGroupResponse :: Int -> GetGroupResponse
getGroupResponse_group :: Lens' GetGroupResponse (Maybe GroupType)
getGroupResponse_httpStatus :: Lens' GetGroupResponse Int

Creating a Request

data GetGroup Source #

See: newGetGroup smart constructor.

Constructors

GetGroup'
Fields groupName :: Text The name of the group. userPoolId :: Text The user pool ID for the user pool.

Instances

Instances details

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

newGetGroup Source #

Arguments

:: Text	`$sel:groupName:GetGroup'`
-> Text	`$sel:userPoolId:GetGroup'`
-> GetGroup

Create a value of GetGroup 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:groupName:GetGroup', getGroup_groupName - The name of the group.

$sel:userPoolId:GetGroup', getGroup_userPoolId - The user pool ID for the user pool.

Request Lenses

getGroup_groupName :: Lens' GetGroup Text Source #

The name of the group.

getGroup_userPoolId :: Lens' GetGroup Text Source #

The user pool ID for the user pool.

Destructuring the Response

data GetGroupResponse Source #

See: newGetGroupResponse smart constructor.

Constructors

GetGroupResponse'
Fields group' :: Maybe GroupType The group object for the group. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetGroup Methods (==) :: GetGroupResponse -> GetGroupResponse -> Bool # (/=) :: GetGroupResponse -> GetGroupResponse -> Bool #
Read GetGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetGroup Methods readsPrec :: Int -> ReadS GetGroupResponse # readList :: ReadS [GetGroupResponse] # readPrec :: ReadPrec GetGroupResponse # readListPrec :: ReadPrec [GetGroupResponse] #
Show GetGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetGroup Methods showsPrec :: Int -> GetGroupResponse -> ShowS # show :: GetGroupResponse -> String # showList :: [GetGroupResponse] -> ShowS #
Generic GetGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetGroup Associated Types type Rep GetGroupResponse :: Type -> Type # Methods from :: GetGroupResponse -> Rep GetGroupResponse x # to :: Rep GetGroupResponse x -> GetGroupResponse #
NFData GetGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetGroup Methods rnf :: GetGroupResponse -> () #
type Rep GetGroupResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetGroup type Rep GetGroupResponse = D1 ('MetaData "GetGroupResponse" "Amazonka.CognitoIdentityProvider.GetGroup" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "GetGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroupType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetGroupResponse Source #

Arguments

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

Create a value of GetGroupResponse 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:group':GetGroupResponse', getGroupResponse_group - The group object for the group.

$sel:httpStatus:GetGroupResponse', getGroupResponse_httpStatus - The response's http status code.

Response Lenses

getGroupResponse_group :: Lens' GetGroupResponse (Maybe GroupType) Source #

The group object for the group.

getGroupResponse_httpStatus :: Lens' GetGroupResponse Int Source #

The response's http status code.