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.Types.Group

Description

Synopsis

data Group = Group' {
- description :: Maybe (Sensitive Text)
- displayName :: Maybe (Sensitive Text)
- externalIds :: Maybe (NonEmpty ExternalId)
- groupId :: Text
- identityStoreId :: Text
}
newGroup :: Text -> Text -> Group
group_description :: Lens' Group (Maybe Text)
group_displayName :: Lens' Group (Maybe Text)
group_externalIds :: Lens' Group (Maybe (NonEmpty ExternalId))
group_groupId :: Lens' Group Text
group_identityStoreId :: Lens' Group Text

Documentation

data Group Source #

A group object that contains a specified group’s metadata and attributes.

See: newGroup smart constructor.

Constructors

Group'

Fields

description :: Maybe (Sensitive Text)
A string containing a description of the specified group.
displayName :: Maybe (Sensitive Text)
The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
externalIds :: Maybe (NonEmpty ExternalId)
A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
groupId :: Text
The identifier for a group in the identity store.
identityStoreId :: Text
The globally unique identifier for the identity store.

Instances

Instances details

FromJSON Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods parseJSON :: Value -> Parser Group # parseJSONList :: Value -> Parser [Group] #
Generic Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Associated Types type Rep Group :: Type -> Type # Methods from :: Group -> Rep Group x # to :: Rep Group x -> Group #
Show Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods showsPrec :: Int -> Group -> ShowS # show :: Group -> String # showList :: [Group] -> ShowS #
NFData Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods rnf :: Group -> () #
Eq Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods (==) :: Group -> Group -> Bool # (/=) :: Group -> Group -> Bool #
Hashable Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods hashWithSalt :: Int -> Group -> Int # hash :: Group -> Int #
type Rep Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group type Rep Group = D1 ('MetaData "Group" "Amazonka.IdentityStore.Types.Group" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "Group'" '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 "externalIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ExternalId))) :: (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGroup Source #

Arguments

:: Text	`$sel:groupId:Group'`
-> Text	`$sel:identityStoreId:Group'`
-> Group

Create a value of Group 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:description:Group', group_description - A string containing a description of the specified group.

$sel:displayName:Group', group_displayName - The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

$sel:externalIds:Group', group_externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

$sel:groupId:Group', group_groupId - The identifier for a group in the identity store.

$sel:identityStoreId:Group', group_identityStoreId - The globally unique identifier for the identity store.

group_description :: Lens' Group (Maybe Text) Source #

A string containing a description of the specified group.

group_displayName :: Lens' Group (Maybe Text) Source #

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

group_externalIds :: Lens' Group (Maybe (NonEmpty ExternalId)) Source #

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

group_groupId :: Lens' Group Text Source #

The identifier for a group in the identity store.

group_identityStoreId :: Lens' Group Text Source #

The globally unique identifier for the identity store.