Amazonka.CognitoIdentityProvider.GetGroup

Gets a group.

Calling this action requires developer credentials.

Creating a Request

data GetGroup

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

ToJSON GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

toJSON :: GetGroup -> Value

toEncoding :: GetGroup -> Encoding

toJSONList :: [GetGroup] -> Value

toEncodingList :: [GetGroup] -> Encoding

ToHeaders GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

toHeaders :: GetGroup -> [Header]

ToPath GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

toPath :: GetGroup -> ByteString

ToQuery GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

toQuery :: GetGroup -> QueryString

AWSRequest GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Associated Types

type AWSResponse GetGroup

Methods

request :: (Service -> Service) -> GetGroup -> Request GetGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetGroup)))

Generic GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Associated Types

type Rep GetGroup :: Type -> Type

Methods

from :: GetGroup -> Rep GetGroup x

to :: Rep GetGroup x -> GetGroup

Read GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

readsPrec :: Int -> ReadS GetGroup

readList :: ReadS [GetGroup]

readPrec :: ReadPrec GetGroup

readListPrec :: ReadPrec [GetGroup]

Show GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

showsPrec :: Int -> GetGroup -> ShowS

show :: GetGroup -> String

showList :: [GetGroup] -> ShowS

NFData GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

rnf :: GetGroup -> ()

Eq GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

(==) :: GetGroup -> GetGroup -> Bool

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

Hashable GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

hashWithSalt :: Int -> GetGroup -> Int

hash :: GetGroup -> Int

type AWSResponse GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

type AWSResponse GetGroup = GetGroupResponse

type Rep GetGroup

Defined in Amazonka.CognitoIdentityProvider.GetGroup

type Rep GetGroup = D1 ('MetaData "GetGroup" "Amazonka.CognitoIdentityProvider.GetGroup" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "GetGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetGroup

Arguments

:: Text

GetGroup

-> Text

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:

GetGroup, getGroup_groupName - The name of the group.

GetGroup, getGroup_userPoolId - The user pool ID for the user pool.

Request Lenses

getGroup_groupName :: Lens' GetGroup Text

The name of the group.

getGroup_userPoolId :: Lens' GetGroup Text

The user pool ID for the user pool.

Destructuring the Response

data GetGroupResponse

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

Generic GetGroupResponse

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Associated Types

type Rep GetGroupResponse :: Type -> Type

Methods

from :: GetGroupResponse -> Rep GetGroupResponse x

to :: Rep GetGroupResponse x -> GetGroupResponse

Read GetGroupResponse

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

readsPrec :: Int -> ReadS GetGroupResponse

readList :: ReadS [GetGroupResponse]

readPrec :: ReadPrec GetGroupResponse

readListPrec :: ReadPrec [GetGroupResponse]

Show GetGroupResponse

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

showsPrec :: Int -> GetGroupResponse -> ShowS

show :: GetGroupResponse -> String

showList :: [GetGroupResponse] -> ShowS

NFData GetGroupResponse

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

rnf :: GetGroupResponse -> ()

Eq GetGroupResponse

Defined in Amazonka.CognitoIdentityProvider.GetGroup

Methods

(==) :: GetGroupResponse -> GetGroupResponse -> Bool

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

type Rep GetGroupResponse

Defined in Amazonka.CognitoIdentityProvider.GetGroup

type Rep GetGroupResponse = D1 ('MetaData "GetGroupResponse" "Amazonka.CognitoIdentityProvider.GetGroup" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" '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

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)

The group object for the group.

getGroupResponse_httpStatus :: Lens' GetGroupResponse Int

The response's http status code.