amazonka-identitystore-2.0: Amazon SSO Identity Store SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IdentityStore.GetGroupId

Description

Retrieves GroupId in an identity store.

Synopsis

Creating a Request

data GetGroupId Source #

See: newGetGroupId smart constructor.

Constructors

GetGroupId' 

Fields

  • identityStoreId :: Text

    The globally unique identifier for the identity store.

  • alternateIdentifier :: AlternateIdentifier

    A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique GroupDisplayName.

Instances

Instances details
ToJSON GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

toJSON :: GetGroupId -> Value #

toEncoding :: GetGroupId -> Encoding #

toJSONList :: [GetGroupId] -> Value #

toEncodingList :: [GetGroupId] -> Encoding #

ToHeaders GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

toHeaders :: GetGroupId -> [Header] #

ToPath GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

toPath :: GetGroupId -> ByteString #

ToQuery GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

toQuery :: GetGroupId -> QueryString #

AWSRequest GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Associated Types

type AWSResponse GetGroupId #

Methods

request :: (Service -> Service) -> GetGroupId -> Request GetGroupId #

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

Generic GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Associated Types

type Rep GetGroupId :: Type -> Type #

Methods

from :: GetGroupId -> Rep GetGroupId x #

to :: Rep GetGroupId x -> GetGroupId #

Show GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

showsPrec :: Int -> GetGroupId -> ShowS #

show :: GetGroupId -> String #

showList :: [GetGroupId] -> ShowS #

NFData GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

rnf :: GetGroupId -> () #

Eq GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

(==) :: GetGroupId -> GetGroupId -> Bool #

(/=) :: GetGroupId -> GetGroupId -> Bool #

Hashable GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

hashWithSalt :: Int -> GetGroupId -> Int #

hash :: GetGroupId -> Int #

type AWSResponse GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

type AWSResponse GetGroupId = GetGroupIdResponse
type Rep GetGroupId Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

type Rep GetGroupId = D1 ('MetaData "GetGroupId" "Amazonka.IdentityStore.GetGroupId" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "GetGroupId'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "alternateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlternateIdentifier)))

newGetGroupId Source #

Arguments

:: Text

GetGroupId

-> AlternateIdentifier

$sel:alternateIdentifier:GetGroupId'

-> GetGroupId 

Create a value of GetGroupId 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:

GetGroupId, getGroupId_identityStoreId - The globally unique identifier for the identity store.

$sel:alternateIdentifier:GetGroupId', getGroupId_alternateIdentifier - A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique GroupDisplayName.

Request Lenses

getGroupId_identityStoreId :: Lens' GetGroupId Text Source #

The globally unique identifier for the identity store.

getGroupId_alternateIdentifier :: Lens' GetGroupId AlternateIdentifier Source #

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique GroupDisplayName.

Destructuring the Response

data GetGroupIdResponse Source #

See: newGetGroupIdResponse smart constructor.

Constructors

GetGroupIdResponse' 

Fields

Instances

Instances details
Generic GetGroupIdResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Associated Types

type Rep GetGroupIdResponse :: Type -> Type #

Methods

from :: GetGroupIdResponse -> Rep GetGroupIdResponse x #

to :: Rep GetGroupIdResponse x -> GetGroupIdResponse #

Read GetGroupIdResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

readsPrec :: Int -> ReadS GetGroupIdResponse #

readList :: ReadS [GetGroupIdResponse] #

readPrec :: ReadPrec GetGroupIdResponse #

readListPrec :: ReadPrec [GetGroupIdResponse] #

Show GetGroupIdResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

showsPrec :: Int -> GetGroupIdResponse -> ShowS #

show :: GetGroupIdResponse -> String #

showList :: [GetGroupIdResponse] -> ShowS #

NFData GetGroupIdResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

rnf :: GetGroupIdResponse -> () #

Eq GetGroupIdResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

Methods

(==) :: GetGroupIdResponse -> GetGroupIdResponse -> Bool #

(/=) :: GetGroupIdResponse -> GetGroupIdResponse -> Bool #

type Rep GetGroupIdResponse Source # 
Instance details

Defined in Amazonka.IdentityStore.GetGroupId

type Rep GetGroupIdResponse = D1 ('MetaData "GetGroupIdResponse" "Amazonka.IdentityStore.GetGroupId" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "GetGroupIdResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetGroupIdResponse Source #

Arguments

:: Int

$sel:httpStatus:GetGroupIdResponse'

-> Text

GetGroupIdResponse

-> Text

GetGroupId

-> GetGroupIdResponse 

Create a value of GetGroupIdResponse 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:httpStatus:GetGroupIdResponse', getGroupIdResponse_httpStatus - The response's http status code.

GetGroupIdResponse, getGroupIdResponse_groupId - The identifier for a group in the identity store.

GetGroupId, getGroupIdResponse_identityStoreId - The globally unique identifier for the identity store.

Response Lenses

getGroupIdResponse_httpStatus :: Lens' GetGroupIdResponse Int Source #

The response's http status code.

getGroupIdResponse_groupId :: Lens' GetGroupIdResponse Text Source #

The identifier for a group in the identity store.

getGroupIdResponse_identityStoreId :: Lens' GetGroupIdResponse Text Source #

The globally unique identifier for the identity store.