Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IdentityStore.Types

Contents

Service Configuration
Errors
Filter
Group
User

Description

Synopsis

defaultService :: Service
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
data Filter = Filter' {
- attributePath :: Text
- attributeValue :: Sensitive Text
}
newFilter :: Text -> Text -> Filter
filter_attributePath :: Lens' Filter Text
filter_attributeValue :: Lens' Filter Text
data Group = Group' {
- groupId :: Text
- displayName :: Text
}
newGroup :: Text -> Text -> Group
group_groupId :: Lens' Group Text
group_displayName :: Lens' Group Text
data User = User' {
- userName :: Sensitive Text
- userId :: Text
}
newUser :: Text -> Text -> User
user_userName :: Lens' User Text
user_userId :: Lens' User Text

Service Configuration

defaultService :: Service Source #

API version 2020-06-15 of the Amazon SSO Identity Store SDK configuration.

Errors

_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request failed because it contains a syntax error.

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You do not have sufficient access to perform this action.

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Indicates that the principal has crossed the throttling limits of the API operations.

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request processing has failed because of an unknown error, exception or failure with an internal server.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Indicates that a requested resource is not found.

Filter

data Filter Source #

A query filter used by ListUsers and ListGroup. This filter object provides the attribute name and attribute value to search users or groups.

See: newFilter smart constructor.

Constructors

Filter'

Fields

attributePath :: Text
The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
attributeValue :: Sensitive Text
Represents the data for an attribute. Each attribute value is described as a name-value pair.

Instances

Instances details

Eq Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Show Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Generic Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Associated Types type Rep Filter :: Type -> Type # Methods from :: Filter -> Rep Filter x # to :: Rep Filter x -> Filter #
NFData Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods rnf :: Filter -> () #
Hashable Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods hashWithSalt :: Int -> Filter -> Int # hash :: Filter -> Int #
ToJSON Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding #
type Rep Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.IdentityStore.Types.Filter" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newFilter Source #

Arguments

:: Text	`$sel:attributePath:Filter'`
-> Text	`$sel:attributeValue:Filter'`
-> Filter

Create a value of Filter 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:attributePath:Filter', filter_attributePath - The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

$sel:attributeValue:Filter', filter_attributeValue - Represents the data for an attribute. Each attribute value is described as a name-value pair.

filter_attributePath :: Lens' Filter Text Source #

The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

filter_attributeValue :: Lens' Filter Text Source #

Represents the data for an attribute. Each attribute value is described as a name-value pair.

Group

data Group Source #

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

See: newGroup smart constructor.

Constructors

Group'

Fields

groupId :: Text
The identifier for a group in the identity store.
displayName :: Text
Contains 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. The characters <>;:% are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

Instances

Instances details

Eq Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods (==) :: Group -> Group -> Bool # (/=) :: Group -> Group -> Bool #
Read Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods readsPrec :: Int -> ReadS Group # readList :: ReadS [Group] # readPrec :: ReadPrec Group # readListPrec :: ReadPrec [Group] #
Show Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods showsPrec :: Int -> Group -> ShowS # show :: Group -> String # showList :: [Group] -> ShowS #
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 #
NFData Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods rnf :: Group -> () #
Hashable Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods hashWithSalt :: Int -> Group -> Int # hash :: Group -> Int #
FromJSON Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group Methods parseJSON :: Value -> Parser Group # parseJSONList :: Value -> Parser [Group] #
type Rep Group Source #
Instance details Defined in Amazonka.IdentityStore.Types.Group type Rep Group = D1 ('MetaData "Group" "Amazonka.IdentityStore.Types.Group" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "Group'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGroup Source #

Arguments

:: Text	`$sel:groupId:Group'`
-> Text	`$sel:displayName: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:groupId:Group', group_groupId - The identifier for a group in the identity store.

$sel:displayName:Group', group_displayName - Contains 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. The characters <>;:% are excluded. 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_groupId :: Lens' Group Text Source #

The identifier for a group in the identity store.

group_displayName :: Lens' Group Text Source #

Contains 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. The characters <>;:% are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

User

data User Source #

A user object, which contains a specified user’s metadata and attributes.

See: newUser smart constructor.

Constructors

User'

Fields

userName :: Sensitive Text
Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
userId :: Text
The identifier for a user in the identity store.

Instances

Instances details

Eq User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Show User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
Generic User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User Associated Types type Rep User :: Type -> Type # Methods from :: User -> Rep User x # to :: Rep User x -> User #
NFData User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User Methods rnf :: User -> () #
Hashable User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User Methods hashWithSalt :: Int -> User -> Int # hash :: User -> Int #
FromJSON User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
type Rep User Source #
Instance details Defined in Amazonka.IdentityStore.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.IdentityStore.Types.User" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUser Source #

Arguments

:: Text	`$sel:userName:User'`
-> Text	`$sel:userId:User'`
-> User

Create a value of User 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:userName:User', user_userName - Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

$sel:userId:User', user_userId - The identifier for a user in the identity store.

user_userName :: Lens' User Text Source #

Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

user_userId :: Lens' User Text Source #

The identifier for a user in the identity store.