Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IdentityStore.CreateGroupMembership

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Synopsis

data CreateGroupMembership = CreateGroupMembership' {
- identityStoreId :: Text
- groupId :: Text
- memberId :: MemberId
}
newCreateGroupMembership :: Text -> Text -> MemberId -> CreateGroupMembership
createGroupMembership_identityStoreId :: Lens' CreateGroupMembership Text
createGroupMembership_groupId :: Lens' CreateGroupMembership Text
createGroupMembership_memberId :: Lens' CreateGroupMembership MemberId
data CreateGroupMembershipResponse = CreateGroupMembershipResponse' {
- httpStatus :: Int
- membershipId :: Text
- identityStoreId :: Text
}
newCreateGroupMembershipResponse :: Int -> Text -> Text -> CreateGroupMembershipResponse
createGroupMembershipResponse_httpStatus :: Lens' CreateGroupMembershipResponse Int
createGroupMembershipResponse_membershipId :: Lens' CreateGroupMembershipResponse Text
createGroupMembershipResponse_identityStoreId :: Lens' CreateGroupMembershipResponse Text

Creating a Request

data CreateGroupMembership Source #

See: newCreateGroupMembership smart constructor.

Constructors

CreateGroupMembership'
Fields identityStoreId :: Text The globally unique identifier for the identity store. groupId :: Text The identifier for a group in the identity store. memberId :: MemberId An object that contains the identifier of a group member. Setting the `UserID` field to the specific identifier for a user indicates that the user is a member of the group.

Instances

Instances details

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

newCreateGroupMembership Source #

Arguments

:: Text	`CreateGroupMembership`
-> Text	`CreateGroupMembership`
-> MemberId	`CreateGroupMembership`
-> CreateGroupMembership

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

CreateGroupMembership, createGroupMembership_identityStoreId - The globally unique identifier for the identity store.

CreateGroupMembership, createGroupMembership_groupId - The identifier for a group in the identity store.

CreateGroupMembership, createGroupMembership_memberId - An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Request Lenses

createGroupMembership_identityStoreId :: Lens' CreateGroupMembership Text Source #

The globally unique identifier for the identity store.

createGroupMembership_groupId :: Lens' CreateGroupMembership Text Source #

The identifier for a group in the identity store.

createGroupMembership_memberId :: Lens' CreateGroupMembership MemberId Source #

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Destructuring the Response

data CreateGroupMembershipResponse Source #

See: newCreateGroupMembershipResponse smart constructor.

Constructors

CreateGroupMembershipResponse'
Fields httpStatus :: Int The response's http status code. membershipId :: Text The identifier for a newly created `GroupMembership` in an identity store. identityStoreId :: Text The globally unique identifier for the identity store.

Instances

Instances details

Generic CreateGroupMembershipResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroupMembership Associated Types type Rep CreateGroupMembershipResponse :: Type -> Type # Methods from :: CreateGroupMembershipResponse -> Rep CreateGroupMembershipResponse x # to :: Rep CreateGroupMembershipResponse x -> CreateGroupMembershipResponse #
Read CreateGroupMembershipResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroupMembership Methods readsPrec :: Int -> ReadS CreateGroupMembershipResponse # readList :: ReadS [CreateGroupMembershipResponse] # readPrec :: ReadPrec CreateGroupMembershipResponse # readListPrec :: ReadPrec [CreateGroupMembershipResponse] #
Show CreateGroupMembershipResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroupMembership Methods showsPrec :: Int -> CreateGroupMembershipResponse -> ShowS # show :: CreateGroupMembershipResponse -> String # showList :: [CreateGroupMembershipResponse] -> ShowS #
NFData CreateGroupMembershipResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroupMembership Methods rnf :: CreateGroupMembershipResponse -> () #
Eq CreateGroupMembershipResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroupMembership Methods (==) :: CreateGroupMembershipResponse -> CreateGroupMembershipResponse -> Bool # (/=) :: CreateGroupMembershipResponse -> CreateGroupMembershipResponse -> Bool #
type Rep CreateGroupMembershipResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroupMembership type Rep CreateGroupMembershipResponse = D1 ('MetaData "CreateGroupMembershipResponse" "Amazonka.IdentityStore.CreateGroupMembership" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "CreateGroupMembershipResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "membershipId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateGroupMembershipResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateGroupMembershipResponse'`
-> Text	`CreateGroupMembershipResponse`
-> Text	`CreateGroupMembership`
-> CreateGroupMembershipResponse

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

CreateGroupMembershipResponse, createGroupMembershipResponse_membershipId - The identifier for a newly created GroupMembership in an identity store.

CreateGroupMembership, createGroupMembershipResponse_identityStoreId - The globally unique identifier for the identity store.

Response Lenses

createGroupMembershipResponse_httpStatus :: Lens' CreateGroupMembershipResponse Int Source #

The response's http status code.

createGroupMembershipResponse_membershipId :: Lens' CreateGroupMembershipResponse Text Source #

The identifier for a newly created GroupMembership in an identity store.

createGroupMembershipResponse_identityStoreId :: Lens' CreateGroupMembershipResponse Text Source #

The globally unique identifier for the identity store.