| 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
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data Address = Address' {}
- newAddress :: Address
- address_country :: Lens' Address (Maybe Text)
- address_formatted :: Lens' Address (Maybe Text)
- address_locality :: Lens' Address (Maybe Text)
- address_postalCode :: Lens' Address (Maybe Text)
- address_primary :: Lens' Address (Maybe Bool)
- address_region :: Lens' Address (Maybe Text)
- address_streetAddress :: Lens' Address (Maybe Text)
- address_type :: Lens' Address (Maybe Text)
- data AlternateIdentifier = AlternateIdentifier' {}
- newAlternateIdentifier :: AlternateIdentifier
- alternateIdentifier_externalId :: Lens' AlternateIdentifier (Maybe ExternalId)
- alternateIdentifier_uniqueAttribute :: Lens' AlternateIdentifier (Maybe UniqueAttribute)
- data AttributeOperation = AttributeOperation' {}
- newAttributeOperation :: Text -> AttributeOperation
- attributeOperation_attributeValue :: Lens' AttributeOperation (Maybe AttributeValue)
- attributeOperation_attributePath :: Lens' AttributeOperation Text
- data AttributeValue = AttributeValue' {
- newAttributeValue :: AttributeValue
- data Email = Email' {}
- newEmail :: Email
- email_primary :: Lens' Email (Maybe Bool)
- email_type :: Lens' Email (Maybe Text)
- email_value :: Lens' Email (Maybe Text)
- data ExternalId = ExternalId' {}
- newExternalId :: Text -> Text -> ExternalId
- externalId_issuer :: Lens' ExternalId Text
- externalId_id :: Lens' ExternalId Text
- data Filter = Filter' {}
- newFilter :: Text -> Text -> Filter
- filter_attributePath :: Lens' Filter Text
- filter_attributeValue :: Lens' Filter Text
- 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
- data GroupMembership = GroupMembership' {}
- newGroupMembership :: Text -> GroupMembership
- groupMembership_groupId :: Lens' GroupMembership (Maybe Text)
- groupMembership_memberId :: Lens' GroupMembership (Maybe MemberId)
- groupMembership_membershipId :: Lens' GroupMembership (Maybe Text)
- groupMembership_identityStoreId :: Lens' GroupMembership Text
- data GroupMembershipExistenceResult = GroupMembershipExistenceResult' {}
- newGroupMembershipExistenceResult :: GroupMembershipExistenceResult
- groupMembershipExistenceResult_groupId :: Lens' GroupMembershipExistenceResult (Maybe Text)
- groupMembershipExistenceResult_memberId :: Lens' GroupMembershipExistenceResult (Maybe MemberId)
- groupMembershipExistenceResult_membershipExists :: Lens' GroupMembershipExistenceResult (Maybe Bool)
- data MemberId = MemberId' {}
- newMemberId :: MemberId
- memberId_userId :: Lens' MemberId (Maybe Text)
- data Name = Name' {}
- newName :: Name
- name_familyName :: Lens' Name (Maybe Text)
- name_formatted :: Lens' Name (Maybe Text)
- name_givenName :: Lens' Name (Maybe Text)
- name_honorificPrefix :: Lens' Name (Maybe Text)
- name_honorificSuffix :: Lens' Name (Maybe Text)
- name_middleName :: Lens' Name (Maybe Text)
- data PhoneNumber = PhoneNumber' {}
- newPhoneNumber :: PhoneNumber
- phoneNumber_primary :: Lens' PhoneNumber (Maybe Bool)
- phoneNumber_type :: Lens' PhoneNumber (Maybe Text)
- phoneNumber_value :: Lens' PhoneNumber (Maybe Text)
- data UniqueAttribute = UniqueAttribute' {}
- newUniqueAttribute :: Text -> AttributeValue -> UniqueAttribute
- uniqueAttribute_attributePath :: Lens' UniqueAttribute Text
- uniqueAttribute_attributeValue :: Lens' UniqueAttribute AttributeValue
- data User = User' {
- addresses :: Maybe (NonEmpty Address)
- displayName :: Maybe (Sensitive Text)
- emails :: Maybe (NonEmpty Email)
- externalIds :: Maybe (NonEmpty ExternalId)
- locale :: Maybe (Sensitive Text)
- name :: Maybe Name
- nickName :: Maybe (Sensitive Text)
- phoneNumbers :: Maybe (NonEmpty PhoneNumber)
- preferredLanguage :: Maybe (Sensitive Text)
- profileUrl :: Maybe (Sensitive Text)
- timezone :: Maybe (Sensitive Text)
- title :: Maybe (Sensitive Text)
- userName :: Maybe (Sensitive Text)
- userType :: Maybe (Sensitive Text)
- userId :: Text
- identityStoreId :: Text
- newUser :: Text -> Text -> User
- user_addresses :: Lens' User (Maybe (NonEmpty Address))
- user_displayName :: Lens' User (Maybe Text)
- user_emails :: Lens' User (Maybe (NonEmpty Email))
- user_externalIds :: Lens' User (Maybe (NonEmpty ExternalId))
- user_locale :: Lens' User (Maybe Text)
- user_name :: Lens' User (Maybe Name)
- user_nickName :: Lens' User (Maybe Text)
- user_phoneNumbers :: Lens' User (Maybe (NonEmpty PhoneNumber))
- user_preferredLanguage :: Lens' User (Maybe Text)
- user_profileUrl :: Lens' User (Maybe Text)
- user_timezone :: Lens' User (Maybe Text)
- user_title :: Lens' User (Maybe Text)
- user_userName :: Lens' User (Maybe Text)
- user_userType :: Lens' User (Maybe Text)
- user_userId :: Lens' User Text
- user_identityStoreId :: Lens' User Text
Service Configuration
defaultService :: Service Source #
API version 2020-06-15 of the Amazon SSO Identity Store SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
This request cannot be completed for one of the following reasons:
- Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
- The requested resource was being concurrently modified by another request.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure with an internal server.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Indicates that a requested resource is not found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Indicates that the principal has crossed the throttling limits of the API operations.
_ValidationException :: AsError a => Fold a ServiceError Source #
The request failed because it contains a syntax error.
Address
The address associated with the specified user.
See: newAddress smart constructor.
Constructors
| Address' | |
Fields
| |
Instances
newAddress :: Address Source #
Create a value of Address 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:country:Address', address_country - The country of the address.
$sel:formatted:Address', address_formatted - A string containing a formatted version of the address for display.
$sel:locality:Address', address_locality - A string of the address locality.
$sel:postalCode:Address', address_postalCode - The postal code of the address.
$sel:primary:Address', address_primary - A Boolean value representing whether this is the primary address for the
associated resource.
$sel:region:Address', address_region - The region of the address.
$sel:streetAddress:Address', address_streetAddress - The street of the address.
$sel:type':Address', address_type - A string representing the type of address. For example, "Home."
address_formatted :: Lens' Address (Maybe Text) Source #
A string containing a formatted version of the address for display.
address_primary :: Lens' Address (Maybe Bool) Source #
A Boolean value representing whether this is the primary address for the associated resource.
address_type :: Lens' Address (Maybe Text) Source #
A string representing the type of address. For example, "Home."
AlternateIdentifier
data 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.
See: newAlternateIdentifier smart constructor.
Constructors
| AlternateIdentifier' | |
Fields
| |
Instances
newAlternateIdentifier :: AlternateIdentifier Source #
Create a value of AlternateIdentifier 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:externalId:AlternateIdentifier', alternateIdentifier_externalId - The identifier issued to this resource by an external identity provider.
$sel:uniqueAttribute:AlternateIdentifier', alternateIdentifier_uniqueAttribute - An entity attribute that's unique to a specific entity.
alternateIdentifier_externalId :: Lens' AlternateIdentifier (Maybe ExternalId) Source #
The identifier issued to this resource by an external identity provider.
alternateIdentifier_uniqueAttribute :: Lens' AlternateIdentifier (Maybe UniqueAttribute) Source #
An entity attribute that's unique to a specific entity.
AttributeOperation
data AttributeOperation Source #
An operation that applies to the requested group. This operation might add, replace, or remove an attribute.
See: newAttributeOperation smart constructor.
Constructors
| AttributeOperation' | |
Fields
| |
Instances
newAttributeOperation Source #
Arguments
| :: Text | |
| -> AttributeOperation |
Create a value of AttributeOperation 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:attributeValue:AttributeOperation', attributeOperation_attributeValue - The value of the attribute. This is a Document type. This type is not
supported by Java V1, Go V1, and older versions of the AWS CLI.
$sel:attributePath:AttributeOperation', attributeOperation_attributePath - A string representation of the path to a given attribute or
sub-attribute. Supports JMESPath.
attributeOperation_attributeValue :: Lens' AttributeOperation (Maybe AttributeValue) Source #
The value of the attribute. This is a Document type. This type is not
supported by Java V1, Go V1, and older versions of the AWS CLI.
attributeOperation_attributePath :: Lens' AttributeOperation Text Source #
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
AttributeValue
data AttributeValue Source #
The value of the attribute. This is a Document type. This type is not
supported by Java V1, Go V1, and older versions of the AWS CLI.
See: newAttributeValue smart constructor.
Constructors
| AttributeValue' | |
Instances
newAttributeValue :: AttributeValue Source #
Create a value of AttributeValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The email address associated with the user.
See: newEmail smart constructor.
Constructors
| Email' | |
Fields
| |
Instances
| FromJSON Email Source # | |
| ToJSON Email Source # | |
Defined in Amazonka.IdentityStore.Types.Email | |
| Generic Email Source # | |
| Show Email Source # | |
| NFData Email Source # | |
Defined in Amazonka.IdentityStore.Types.Email | |
| Eq Email Source # | |
| Hashable Email Source # | |
Defined in Amazonka.IdentityStore.Types.Email | |
| type Rep Email Source # | |
Defined in Amazonka.IdentityStore.Types.Email type Rep Email = D1 ('MetaData "Email" "Amazonka.IdentityStore.Types.Email" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "Email'" 'PrefixI 'True) (S1 ('MetaSel ('Just "primary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Bool))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) | |
Create a value of Email 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:primary:Email', email_primary - A Boolean value representing whether this is the primary email address
for the associated resource.
$sel:type':Email', email_type - A string representing the type of address. For example, "Work."
$sel:value:Email', email_value - A string containing an email address. For example,
"johndoe@amazon.com."
email_primary :: Lens' Email (Maybe Bool) Source #
A Boolean value representing whether this is the primary email address for the associated resource.
email_type :: Lens' Email (Maybe Text) Source #
A string representing the type of address. For example, "Work."
email_value :: Lens' Email (Maybe Text) Source #
A string containing an email address. For example, "johndoe@amazon.com."
ExternalId
data ExternalId Source #
The identifier issued to this resource by an external identity provider.
See: newExternalId smart constructor.
Constructors
| ExternalId' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExternalId |
Create a value of ExternalId 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:issuer:ExternalId', externalId_issuer - The issuer for an external identifier.
$sel:id:ExternalId', externalId_id - The identifier issued to this resource by an external identity provider.
externalId_issuer :: Lens' ExternalId Text Source #
The issuer for an external identifier.
externalId_id :: Lens' ExternalId Text Source #
The identifier issued to this resource by an external identity provider.
Filter
A query filter used by ListUsers and ListGroups. This filter object
provides the attribute name and attribute value to search users or
groups.
See: newFilter smart constructor.
Constructors
| Filter' | |
Fields
| |
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter | |
| Generic Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.IdentityStore.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.IdentityStore.Types.Filter" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" '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)))) | |
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
A group object that contains a specified group’s metadata and attributes.
See: newGroup smart constructor.
Constructors
| Group' | |
Fields
| |
Instances
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_identityStoreId :: Lens' Group Text Source #
The globally unique identifier for the identity store.
GroupMembership
data GroupMembership Source #
Contains the identifiers for a group, a group member, and a
GroupMembership object in the identity store.
See: newGroupMembership smart constructor.
Constructors
| GroupMembership' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GroupMembership |
Create a value of GroupMembership 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:GroupMembership', groupMembership_groupId - The identifier for a group in the identity store.
$sel:memberId:GroupMembership', groupMembership_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.
$sel:membershipId:GroupMembership', groupMembership_membershipId - The identifier for a GroupMembership object in an identity store.
$sel:identityStoreId:GroupMembership', groupMembership_identityStoreId - The globally unique identifier for the identity store.
groupMembership_groupId :: Lens' GroupMembership (Maybe Text) Source #
The identifier for a group in the identity store.
groupMembership_memberId :: Lens' GroupMembership (Maybe 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.
groupMembership_membershipId :: Lens' GroupMembership (Maybe Text) Source #
The identifier for a GroupMembership object in an identity store.
groupMembership_identityStoreId :: Lens' GroupMembership Text Source #
The globally unique identifier for the identity store.
GroupMembershipExistenceResult
data GroupMembershipExistenceResult Source #
Indicates whether a resource is a member of a group in the identity store.
See: newGroupMembershipExistenceResult smart constructor.
Constructors
| GroupMembershipExistenceResult' | |
Fields
| |
Instances
newGroupMembershipExistenceResult :: GroupMembershipExistenceResult Source #
Create a value of GroupMembershipExistenceResult 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:GroupMembershipExistenceResult', groupMembershipExistenceResult_groupId - The identifier for a group in the identity store.
$sel:memberId:GroupMembershipExistenceResult', groupMembershipExistenceResult_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.
$sel:membershipExists:GroupMembershipExistenceResult', groupMembershipExistenceResult_membershipExists - Indicates whether a membership relation exists or not.
groupMembershipExistenceResult_groupId :: Lens' GroupMembershipExistenceResult (Maybe Text) Source #
The identifier for a group in the identity store.
groupMembershipExistenceResult_memberId :: Lens' GroupMembershipExistenceResult (Maybe 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.
groupMembershipExistenceResult_membershipExists :: Lens' GroupMembershipExistenceResult (Maybe Bool) Source #
Indicates whether a membership relation exists or not.
MemberId
An object containing the identifier of a group member.
See: newMemberId smart constructor.
Constructors
| MemberId' | |
Instances
| FromJSON MemberId Source # | |
| ToJSON MemberId Source # | |
Defined in Amazonka.IdentityStore.Types.MemberId | |
| Generic MemberId Source # | |
| Read MemberId Source # | |
| Show MemberId Source # | |
| NFData MemberId Source # | |
Defined in Amazonka.IdentityStore.Types.MemberId | |
| Eq MemberId Source # | |
| Hashable MemberId Source # | |
Defined in Amazonka.IdentityStore.Types.MemberId | |
| type Rep MemberId Source # | |
Defined in Amazonka.IdentityStore.Types.MemberId | |
newMemberId :: MemberId Source #
Create a value of MemberId 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:userId:MemberId', memberId_userId - An object containing the identifiers of resources that can be members.
memberId_userId :: Lens' MemberId (Maybe Text) Source #
An object containing the identifiers of resources that can be members.
Name
The full name of the user.
See: newName smart constructor.
Constructors
| Name' | |
Fields
| |
Instances
Create a value of Name 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:familyName:Name', name_familyName - The family name of the user.
$sel:formatted:Name', name_formatted - A string containing a formatted version of the name for display.
$sel:givenName:Name', name_givenName - The given name of the user.
$sel:honorificPrefix:Name', name_honorificPrefix - The honorific prefix of the user. For example, "Dr."
$sel:honorificSuffix:Name', name_honorificSuffix - The honorific suffix of the user. For example, "M.D."
$sel:middleName:Name', name_middleName - The middle name of the user.
name_formatted :: Lens' Name (Maybe Text) Source #
A string containing a formatted version of the name for display.
name_honorificPrefix :: Lens' Name (Maybe Text) Source #
The honorific prefix of the user. For example, "Dr."
name_honorificSuffix :: Lens' Name (Maybe Text) Source #
The honorific suffix of the user. For example, "M.D."
PhoneNumber
data PhoneNumber Source #
The phone number associated with the user.
See: newPhoneNumber smart constructor.
Constructors
| PhoneNumber' | |
Fields
| |
Instances
newPhoneNumber :: PhoneNumber Source #
Create a value of PhoneNumber 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:primary:PhoneNumber', phoneNumber_primary - A Boolean value representing whether this is the primary phone number
for the associated resource.
$sel:type':PhoneNumber', phoneNumber_type - A string representing the type of a phone number. For example,
"Mobile."
$sel:value:PhoneNumber', phoneNumber_value - A string containing a phone number. For example, "8675309" or "+1
(800) 123-4567".
phoneNumber_primary :: Lens' PhoneNumber (Maybe Bool) Source #
A Boolean value representing whether this is the primary phone number for the associated resource.
phoneNumber_type :: Lens' PhoneNumber (Maybe Text) Source #
A string representing the type of a phone number. For example, "Mobile."
phoneNumber_value :: Lens' PhoneNumber (Maybe Text) Source #
A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".
UniqueAttribute
data UniqueAttribute Source #
An entity attribute that's unique to a specific entity.
See: newUniqueAttribute smart constructor.
Constructors
| UniqueAttribute' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AttributeValue | |
| -> UniqueAttribute |
Create a value of UniqueAttribute 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:UniqueAttribute', uniqueAttribute_attributePath - A string representation of the path to a given attribute or
sub-attribute. Supports JMESPath.
$sel:attributeValue:UniqueAttribute', uniqueAttribute_attributeValue - The value of the attribute. This is a Document type. This type is not
supported by Java V1, Go V1, and older versions of the AWS CLI.
uniqueAttribute_attributePath :: Lens' UniqueAttribute Text Source #
A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.
uniqueAttribute_attributeValue :: Lens' UniqueAttribute AttributeValue Source #
The value of the attribute. This is a Document type. This type is not
supported by Java V1, Go V1, and older versions of the AWS CLI.
User
A user object that contains a specified user’s metadata and attributes.
See: newUser smart constructor.
Constructors
| User' | |
Fields
| |
Instances
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:addresses:User', user_addresses - A list of Address objects containing addresses associated with the
user.
$sel:displayName:User', user_displayName - A string containing the user's name that's formatted for display when
the user is referenced. For example, "John Doe."
$sel:emails:User', user_emails - A list of Email objects containing email addresses associated with the
user.
$sel:externalIds:User', user_externalIds - A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
$sel:locale:User', user_locale - A string containing the user's geographical region or location.
$sel:name:User', user_name - An object containing the user's name.
$sel:nickName:User', user_nickName - A string containing an alternate name for the user.
$sel:phoneNumbers:User', user_phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with
the user.
$sel:preferredLanguage:User', user_preferredLanguage - A string containing the preferred language of the user. For example,
"American English" or "en-us."
$sel:profileUrl:User', user_profileUrl - A string containing a URL that may be associated with the user.
$sel:timezone:User', user_timezone - A string containing the user's time zone.
$sel:title:User', user_title - A string containing the user's title. Possible values depend on each
customer's specific needs, so they are left unspecified.
$sel:userName:User', user_userName - A unique string used to identify the user. The length limit is 128
characters. This value can consist of letters, accented characters,
symbols, numbers, and punctuation. 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:userType:User', user_userType - A string indicating the user's type. Possible values depend on each
customer's specific needs, so they are left unspecified.
$sel:userId:User', user_userId - The identifier for a user in the identity store.
$sel:identityStoreId:User', user_identityStoreId - The globally unique identifier for the identity store.
user_addresses :: Lens' User (Maybe (NonEmpty Address)) Source #
A list of Address objects containing addresses associated with the
user.
user_displayName :: Lens' User (Maybe Text) Source #
A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
user_emails :: Lens' User (Maybe (NonEmpty Email)) Source #
A list of Email objects containing email addresses associated with the
user.
user_externalIds :: Lens' User (Maybe (NonEmpty ExternalId)) Source #
A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
user_locale :: Lens' User (Maybe Text) Source #
A string containing the user's geographical region or location.
user_nickName :: Lens' User (Maybe Text) Source #
A string containing an alternate name for the user.
user_phoneNumbers :: Lens' User (Maybe (NonEmpty PhoneNumber)) Source #
A list of PhoneNumber objects containing phone numbers associated with
the user.
user_preferredLanguage :: Lens' User (Maybe Text) Source #
A string containing the preferred language of the user. For example, "American English" or "en-us."
user_profileUrl :: Lens' User (Maybe Text) Source #
A string containing a URL that may be associated with the user.
user_title :: Lens' User (Maybe Text) Source #
A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
user_userName :: Lens' User (Maybe Text) Source #
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.