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.CreateGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a group within the specified identity store.

Synopsis

Creating a Request

data CreateGroup Source #

See: newCreateGroup smart constructor.

Constructors

CreateGroup'
Fields description :: Maybe (Sensitive Text) A string containing the description of the group. displayName :: Maybe (Sensitive Text) A string containing the name of the group. This value is commonly displayed when the group is referenced. identityStoreId :: Text The globally unique identifier for the identity store.

Instances

Instances details

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

newCreateGroup Source #

Arguments

:: Text	`CreateGroup`
-> CreateGroup

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

CreateGroup, createGroup_description - A string containing the description of the group.

CreateGroup, createGroup_displayName - A string containing the name of the group. This value is commonly displayed when the group is referenced.

CreateGroup, createGroup_identityStoreId - The globally unique identifier for the identity store.

Request Lenses

createGroup_description :: Lens' CreateGroup (Maybe Text) Source #

A string containing the description of the group.

createGroup_displayName :: Lens' CreateGroup (Maybe Text) Source #

A string containing the name of the group. This value is commonly displayed when the group is referenced.

createGroup_identityStoreId :: Lens' CreateGroup Text Source #

The globally unique identifier for the identity store.

Destructuring the Response

data CreateGroupResponse Source #

See: newCreateGroupResponse smart constructor.

Constructors

CreateGroupResponse'
Fields httpStatus :: Int The response's http status code. groupId :: Text The identifier of the newly created group in the identity store. identityStoreId :: Text The globally unique identifier for the identity store.

Instances

Instances details

Generic CreateGroupResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroup Associated Types type Rep CreateGroupResponse :: Type -> Type # Methods from :: CreateGroupResponse -> Rep CreateGroupResponse x # to :: Rep CreateGroupResponse x -> CreateGroupResponse #
Read CreateGroupResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroup Methods readsPrec :: Int -> ReadS CreateGroupResponse # readList :: ReadS [CreateGroupResponse] # readPrec :: ReadPrec CreateGroupResponse # readListPrec :: ReadPrec [CreateGroupResponse] #
Show CreateGroupResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroup Methods showsPrec :: Int -> CreateGroupResponse -> ShowS # show :: CreateGroupResponse -> String # showList :: [CreateGroupResponse] -> ShowS #
NFData CreateGroupResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroup Methods rnf :: CreateGroupResponse -> () #
Eq CreateGroupResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroup Methods (==) :: CreateGroupResponse -> CreateGroupResponse -> Bool # (/=) :: CreateGroupResponse -> CreateGroupResponse -> Bool #
type Rep CreateGroupResponse Source #
Instance details Defined in Amazonka.IdentityStore.CreateGroup type Rep CreateGroupResponse = D1 ('MetaData "CreateGroupResponse" "Amazonka.IdentityStore.CreateGroup" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "CreateGroupResponse'" '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))))

newCreateGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateGroupResponse'`
-> Text	`CreateGroupResponse`
-> Text	`CreateGroup`
-> CreateGroupResponse

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

CreateGroupResponse, createGroupResponse_groupId - The identifier of the newly created group in the identity store.

CreateGroup, createGroupResponse_identityStoreId - The globally unique identifier for the identity store.

Response Lenses

createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int Source #

The response's http status code.

createGroupResponse_groupId :: Lens' CreateGroupResponse Text Source #

The identifier of the newly created group in the identity store.

createGroupResponse_identityStoreId :: Lens' CreateGroupResponse Text Source #

The globally unique identifier for the identity store.