| 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.Lens
Contents
Description
Synopsis
- createGroup_description :: Lens' CreateGroup (Maybe Text)
- createGroup_displayName :: Lens' CreateGroup (Maybe Text)
- createGroup_identityStoreId :: Lens' CreateGroup Text
- createGroupResponse_httpStatus :: Lens' CreateGroupResponse Int
- createGroupResponse_groupId :: Lens' CreateGroupResponse Text
- createGroupResponse_identityStoreId :: Lens' CreateGroupResponse Text
- createGroupMembership_identityStoreId :: Lens' CreateGroupMembership Text
- createGroupMembership_groupId :: Lens' CreateGroupMembership Text
- createGroupMembership_memberId :: Lens' CreateGroupMembership MemberId
- createGroupMembershipResponse_httpStatus :: Lens' CreateGroupMembershipResponse Int
- createGroupMembershipResponse_membershipId :: Lens' CreateGroupMembershipResponse Text
- createGroupMembershipResponse_identityStoreId :: Lens' CreateGroupMembershipResponse Text
- createUser_addresses :: Lens' CreateUser (Maybe (NonEmpty Address))
- createUser_displayName :: Lens' CreateUser (Maybe Text)
- createUser_emails :: Lens' CreateUser (Maybe (NonEmpty Email))
- createUser_locale :: Lens' CreateUser (Maybe Text)
- createUser_name :: Lens' CreateUser (Maybe Name)
- createUser_nickName :: Lens' CreateUser (Maybe Text)
- createUser_phoneNumbers :: Lens' CreateUser (Maybe (NonEmpty PhoneNumber))
- createUser_preferredLanguage :: Lens' CreateUser (Maybe Text)
- createUser_profileUrl :: Lens' CreateUser (Maybe Text)
- createUser_timezone :: Lens' CreateUser (Maybe Text)
- createUser_title :: Lens' CreateUser (Maybe Text)
- createUser_userName :: Lens' CreateUser (Maybe Text)
- createUser_userType :: Lens' CreateUser (Maybe Text)
- createUser_identityStoreId :: Lens' CreateUser Text
- createUserResponse_httpStatus :: Lens' CreateUserResponse Int
- createUserResponse_userId :: Lens' CreateUserResponse Text
- createUserResponse_identityStoreId :: Lens' CreateUserResponse Text
- deleteGroup_identityStoreId :: Lens' DeleteGroup Text
- deleteGroup_groupId :: Lens' DeleteGroup Text
- deleteGroupResponse_httpStatus :: Lens' DeleteGroupResponse Int
- deleteGroupMembership_identityStoreId :: Lens' DeleteGroupMembership Text
- deleteGroupMembership_membershipId :: Lens' DeleteGroupMembership Text
- deleteGroupMembershipResponse_httpStatus :: Lens' DeleteGroupMembershipResponse Int
- deleteUser_identityStoreId :: Lens' DeleteUser Text
- deleteUser_userId :: Lens' DeleteUser Text
- deleteUserResponse_httpStatus :: Lens' DeleteUserResponse Int
- describeGroup_identityStoreId :: Lens' DescribeGroup Text
- describeGroup_groupId :: Lens' DescribeGroup Text
- describeGroupResponse_description :: Lens' DescribeGroupResponse (Maybe Text)
- describeGroupResponse_displayName :: Lens' DescribeGroupResponse (Maybe Text)
- describeGroupResponse_externalIds :: Lens' DescribeGroupResponse (Maybe (NonEmpty ExternalId))
- describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int
- describeGroupResponse_groupId :: Lens' DescribeGroupResponse Text
- describeGroupResponse_identityStoreId :: Lens' DescribeGroupResponse Text
- describeGroupMembership_identityStoreId :: Lens' DescribeGroupMembership Text
- describeGroupMembership_membershipId :: Lens' DescribeGroupMembership Text
- describeGroupMembershipResponse_httpStatus :: Lens' DescribeGroupMembershipResponse Int
- describeGroupMembershipResponse_identityStoreId :: Lens' DescribeGroupMembershipResponse Text
- describeGroupMembershipResponse_membershipId :: Lens' DescribeGroupMembershipResponse Text
- describeGroupMembershipResponse_groupId :: Lens' DescribeGroupMembershipResponse Text
- describeGroupMembershipResponse_memberId :: Lens' DescribeGroupMembershipResponse MemberId
- describeUser_identityStoreId :: Lens' DescribeUser Text
- describeUser_userId :: Lens' DescribeUser Text
- describeUserResponse_addresses :: Lens' DescribeUserResponse (Maybe (NonEmpty Address))
- describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_emails :: Lens' DescribeUserResponse (Maybe (NonEmpty Email))
- describeUserResponse_externalIds :: Lens' DescribeUserResponse (Maybe (NonEmpty ExternalId))
- describeUserResponse_locale :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Name)
- describeUserResponse_nickName :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_phoneNumbers :: Lens' DescribeUserResponse (Maybe (NonEmpty PhoneNumber))
- describeUserResponse_preferredLanguage :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_profileUrl :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_timezone :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_title :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_userName :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_userType :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int
- describeUserResponse_userId :: Lens' DescribeUserResponse Text
- describeUserResponse_identityStoreId :: Lens' DescribeUserResponse Text
- getGroupId_identityStoreId :: Lens' GetGroupId Text
- getGroupId_alternateIdentifier :: Lens' GetGroupId AlternateIdentifier
- getGroupIdResponse_httpStatus :: Lens' GetGroupIdResponse Int
- getGroupIdResponse_groupId :: Lens' GetGroupIdResponse Text
- getGroupIdResponse_identityStoreId :: Lens' GetGroupIdResponse Text
- getGroupMembershipId_identityStoreId :: Lens' GetGroupMembershipId Text
- getGroupMembershipId_groupId :: Lens' GetGroupMembershipId Text
- getGroupMembershipId_memberId :: Lens' GetGroupMembershipId MemberId
- getGroupMembershipIdResponse_httpStatus :: Lens' GetGroupMembershipIdResponse Int
- getGroupMembershipIdResponse_membershipId :: Lens' GetGroupMembershipIdResponse Text
- getGroupMembershipIdResponse_identityStoreId :: Lens' GetGroupMembershipIdResponse Text
- getUserId_identityStoreId :: Lens' GetUserId Text
- getUserId_alternateIdentifier :: Lens' GetUserId AlternateIdentifier
- getUserIdResponse_httpStatus :: Lens' GetUserIdResponse Int
- getUserIdResponse_userId :: Lens' GetUserIdResponse Text
- getUserIdResponse_identityStoreId :: Lens' GetUserIdResponse Text
- isMemberInGroups_identityStoreId :: Lens' IsMemberInGroups Text
- isMemberInGroups_memberId :: Lens' IsMemberInGroups MemberId
- isMemberInGroups_groupIds :: Lens' IsMemberInGroups (NonEmpty Text)
- isMemberInGroupsResponse_httpStatus :: Lens' IsMemberInGroupsResponse Int
- isMemberInGroupsResponse_results :: Lens' IsMemberInGroupsResponse [GroupMembershipExistenceResult]
- listGroupMemberships_maxResults :: Lens' ListGroupMemberships (Maybe Natural)
- listGroupMemberships_nextToken :: Lens' ListGroupMemberships (Maybe Text)
- listGroupMemberships_identityStoreId :: Lens' ListGroupMemberships Text
- listGroupMemberships_groupId :: Lens' ListGroupMemberships Text
- listGroupMembershipsResponse_nextToken :: Lens' ListGroupMembershipsResponse (Maybe Text)
- listGroupMembershipsResponse_httpStatus :: Lens' ListGroupMembershipsResponse Int
- listGroupMembershipsResponse_groupMemberships :: Lens' ListGroupMembershipsResponse [GroupMembership]
- listGroupMembershipsForMember_maxResults :: Lens' ListGroupMembershipsForMember (Maybe Natural)
- listGroupMembershipsForMember_nextToken :: Lens' ListGroupMembershipsForMember (Maybe Text)
- listGroupMembershipsForMember_identityStoreId :: Lens' ListGroupMembershipsForMember Text
- listGroupMembershipsForMember_memberId :: Lens' ListGroupMembershipsForMember MemberId
- listGroupMembershipsForMemberResponse_nextToken :: Lens' ListGroupMembershipsForMemberResponse (Maybe Text)
- listGroupMembershipsForMemberResponse_httpStatus :: Lens' ListGroupMembershipsForMemberResponse Int
- listGroupMembershipsForMemberResponse_groupMemberships :: Lens' ListGroupMembershipsForMemberResponse [GroupMembership]
- listGroups_filters :: Lens' ListGroups (Maybe [Filter])
- listGroups_maxResults :: Lens' ListGroups (Maybe Natural)
- listGroups_nextToken :: Lens' ListGroups (Maybe Text)
- listGroups_identityStoreId :: Lens' ListGroups Text
- listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
- listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
- listGroupsResponse_groups :: Lens' ListGroupsResponse [Group]
- listUsers_filters :: Lens' ListUsers (Maybe [Filter])
- listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
- listUsers_nextToken :: Lens' ListUsers (Maybe Text)
- listUsers_identityStoreId :: Lens' ListUsers Text
- listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
- listUsersResponse_httpStatus :: Lens' ListUsersResponse Int
- listUsersResponse_users :: Lens' ListUsersResponse [User]
- updateGroup_identityStoreId :: Lens' UpdateGroup Text
- updateGroup_groupId :: Lens' UpdateGroup Text
- updateGroup_operations :: Lens' UpdateGroup (NonEmpty AttributeOperation)
- updateGroupResponse_httpStatus :: Lens' UpdateGroupResponse Int
- updateUser_identityStoreId :: Lens' UpdateUser Text
- updateUser_userId :: Lens' UpdateUser Text
- updateUser_operations :: Lens' UpdateUser (NonEmpty AttributeOperation)
- updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
- 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)
- alternateIdentifier_externalId :: Lens' AlternateIdentifier (Maybe ExternalId)
- alternateIdentifier_uniqueAttribute :: Lens' AlternateIdentifier (Maybe UniqueAttribute)
- attributeOperation_attributeValue :: Lens' AttributeOperation (Maybe AttributeValue)
- attributeOperation_attributePath :: Lens' AttributeOperation Text
- email_primary :: Lens' Email (Maybe Bool)
- email_type :: Lens' Email (Maybe Text)
- email_value :: Lens' Email (Maybe Text)
- externalId_issuer :: Lens' ExternalId Text
- externalId_id :: Lens' ExternalId Text
- filter_attributePath :: Lens' Filter Text
- filter_attributeValue :: Lens' Filter Text
- 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
- groupMembership_groupId :: Lens' GroupMembership (Maybe Text)
- groupMembership_memberId :: Lens' GroupMembership (Maybe MemberId)
- groupMembership_membershipId :: Lens' GroupMembership (Maybe Text)
- groupMembership_identityStoreId :: Lens' GroupMembership Text
- groupMembershipExistenceResult_groupId :: Lens' GroupMembershipExistenceResult (Maybe Text)
- groupMembershipExistenceResult_memberId :: Lens' GroupMembershipExistenceResult (Maybe MemberId)
- groupMembershipExistenceResult_membershipExists :: Lens' GroupMembershipExistenceResult (Maybe Bool)
- memberId_userId :: Lens' MemberId (Maybe Text)
- 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)
- phoneNumber_primary :: Lens' PhoneNumber (Maybe Bool)
- phoneNumber_type :: Lens' PhoneNumber (Maybe Text)
- phoneNumber_value :: Lens' PhoneNumber (Maybe Text)
- uniqueAttribute_attributePath :: Lens' UniqueAttribute Text
- uniqueAttribute_attributeValue :: Lens' UniqueAttribute AttributeValue
- 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
Operations
CreateGroup
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.
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.
CreateGroupMembership
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.
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.
CreateUser
createUser_addresses :: Lens' CreateUser (Maybe (NonEmpty Address)) Source #
A list of Address objects containing addresses associated with the
user.
createUser_displayName :: Lens' CreateUser (Maybe Text) Source #
A string containing the user's name. This value is typically formatted for display when the user is referenced. For example, "John Doe."
createUser_emails :: Lens' CreateUser (Maybe (NonEmpty Email)) Source #
A list of Email objects containing email addresses associated with the
user.
createUser_locale :: Lens' CreateUser (Maybe Text) Source #
A string containing the user's geographical region or location.
createUser_name :: Lens' CreateUser (Maybe Name) Source #
An object containing the user's name.
createUser_nickName :: Lens' CreateUser (Maybe Text) Source #
A string containing an alternate name for the user.
createUser_phoneNumbers :: Lens' CreateUser (Maybe (NonEmpty PhoneNumber)) Source #
A list of PhoneNumber objects containing phone numbers associated with
the user.
createUser_preferredLanguage :: Lens' CreateUser (Maybe Text) Source #
A string containing the preferred language of the user. For example, "American English" or "en-us."
createUser_profileUrl :: Lens' CreateUser (Maybe Text) Source #
A string containing a URL that may be associated with the user.
createUser_timezone :: Lens' CreateUser (Maybe Text) Source #
A string containing the user's time zone.
createUser_title :: Lens' CreateUser (Maybe Text) Source #
A string containing the user's title. Possible values are left unspecified given that they depend on each customer's specific needs.
createUser_userName :: Lens' CreateUser (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.
createUser_userType :: Lens' CreateUser (Maybe Text) Source #
A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
createUser_identityStoreId :: Lens' CreateUser Text Source #
The globally unique identifier for the identity store.
createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #
The response's http status code.
createUserResponse_userId :: Lens' CreateUserResponse Text Source #
The identifier of the newly created user in the identity store.
createUserResponse_identityStoreId :: Lens' CreateUserResponse Text Source #
The globally unique identifier for the identity store.
DeleteGroup
deleteGroup_identityStoreId :: Lens' DeleteGroup Text Source #
The globally unique identifier for the identity store.
deleteGroup_groupId :: Lens' DeleteGroup Text Source #
The identifier for a group in the identity store.
deleteGroupResponse_httpStatus :: Lens' DeleteGroupResponse Int Source #
The response's http status code.
DeleteGroupMembership
deleteGroupMembership_identityStoreId :: Lens' DeleteGroupMembership Text Source #
The globally unique identifier for the identity store.
deleteGroupMembership_membershipId :: Lens' DeleteGroupMembership Text Source #
The identifier for a GroupMembership in an identity store.
deleteGroupMembershipResponse_httpStatus :: Lens' DeleteGroupMembershipResponse Int Source #
The response's http status code.
DeleteUser
deleteUser_identityStoreId :: Lens' DeleteUser Text Source #
The globally unique identifier for the identity store.
deleteUser_userId :: Lens' DeleteUser Text Source #
The identifier for a user in the identity store.
deleteUserResponse_httpStatus :: Lens' DeleteUserResponse Int Source #
The response's http status code.
DescribeGroup
describeGroup_identityStoreId :: Lens' DescribeGroup Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains numbers and
lower case letters. This value is generated at the time that a new
identity store is created.
describeGroup_groupId :: Lens' DescribeGroup Text Source #
The identifier for a group in the identity store.
describeGroupResponse_description :: Lens' DescribeGroupResponse (Maybe Text) Source #
A string containing a description of the group.
describeGroupResponse_displayName :: Lens' DescribeGroupResponse (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 that the group is created and stored as an attribute of the group object in the identity store.
describeGroupResponse_externalIds :: Lens' DescribeGroupResponse (Maybe (NonEmpty ExternalId)) Source #
A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int Source #
The response's http status code.
describeGroupResponse_groupId :: Lens' DescribeGroupResponse Text Source #
The identifier for a group in the identity store.
describeGroupResponse_identityStoreId :: Lens' DescribeGroupResponse Text Source #
The globally unique identifier for the identity store.
DescribeGroupMembership
describeGroupMembership_identityStoreId :: Lens' DescribeGroupMembership Text Source #
The globally unique identifier for the identity store.
describeGroupMembership_membershipId :: Lens' DescribeGroupMembership Text Source #
The identifier for a GroupMembership in an identity store.
describeGroupMembershipResponse_httpStatus :: Lens' DescribeGroupMembershipResponse Int Source #
The response's http status code.
describeGroupMembershipResponse_identityStoreId :: Lens' DescribeGroupMembershipResponse Text Source #
The globally unique identifier for the identity store.
describeGroupMembershipResponse_membershipId :: Lens' DescribeGroupMembershipResponse Text Source #
The identifier for a GroupMembership in an identity store.
describeGroupMembershipResponse_groupId :: Lens' DescribeGroupMembershipResponse Text Source #
The identifier for a group in the identity store.
describeGroupMembershipResponse_memberId :: Lens' DescribeGroupMembershipResponse MemberId Source #
Undocumented member.
DescribeUser
describeUser_identityStoreId :: Lens' DescribeUser Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains numbers and
lower case letters. This value is generated at the time that a new
identity store is created.
describeUser_userId :: Lens' DescribeUser Text Source #
The identifier for a user in the identity store.
describeUserResponse_addresses :: Lens' DescribeUserResponse (Maybe (NonEmpty Address)) Source #
The user's physical address.
describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text) Source #
The user's name value for display.
describeUserResponse_emails :: Lens' DescribeUserResponse (Maybe (NonEmpty Email)) Source #
The user's email value.
describeUserResponse_externalIds :: Lens' DescribeUserResponse (Maybe (NonEmpty ExternalId)) Source #
A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
describeUserResponse_locale :: Lens' DescribeUserResponse (Maybe Text) Source #
A string containing the user's geographical region or location.
describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Name) Source #
The name of the user.
describeUserResponse_nickName :: Lens' DescribeUserResponse (Maybe Text) Source #
An alternative descriptive name for the user.
describeUserResponse_phoneNumbers :: Lens' DescribeUserResponse (Maybe (NonEmpty PhoneNumber)) Source #
A list of PhoneNumber objects associated with a user.
describeUserResponse_preferredLanguage :: Lens' DescribeUserResponse (Maybe Text) Source #
The preferred language of the user.
describeUserResponse_profileUrl :: Lens' DescribeUserResponse (Maybe Text) Source #
A URL link for the user's profile.
describeUserResponse_timezone :: Lens' DescribeUserResponse (Maybe Text) Source #
The time zone for a user.
describeUserResponse_title :: Lens' DescribeUserResponse (Maybe Text) Source #
A string containing the user's title.
describeUserResponse_userName :: Lens' DescribeUserResponse (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.
describeUserResponse_userType :: Lens' DescribeUserResponse (Maybe Text) Source #
A string indicating the user's type.
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #
The response's http status code.
describeUserResponse_userId :: Lens' DescribeUserResponse Text Source #
The identifier for a user in the identity store.
describeUserResponse_identityStoreId :: Lens' DescribeUserResponse Text Source #
The globally unique identifier for the identity store.
GetGroupId
getGroupId_identityStoreId :: Lens' GetGroupId Text Source #
The globally unique identifier for the identity store.
getGroupId_alternateIdentifier :: Lens' GetGroupId 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.
getGroupIdResponse_httpStatus :: Lens' GetGroupIdResponse Int Source #
The response's http status code.
getGroupIdResponse_groupId :: Lens' GetGroupIdResponse Text Source #
The identifier for a group in the identity store.
getGroupIdResponse_identityStoreId :: Lens' GetGroupIdResponse Text Source #
The globally unique identifier for the identity store.
GetGroupMembershipId
getGroupMembershipId_identityStoreId :: Lens' GetGroupMembershipId Text Source #
The globally unique identifier for the identity store.
getGroupMembershipId_groupId :: Lens' GetGroupMembershipId Text Source #
The identifier for a group in the identity store.
getGroupMembershipId_memberId :: Lens' GetGroupMembershipId 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.
getGroupMembershipIdResponse_httpStatus :: Lens' GetGroupMembershipIdResponse Int Source #
The response's http status code.
getGroupMembershipIdResponse_membershipId :: Lens' GetGroupMembershipIdResponse Text Source #
The identifier for a GroupMembership in an identity store.
getGroupMembershipIdResponse_identityStoreId :: Lens' GetGroupMembershipIdResponse Text Source #
The globally unique identifier for the identity store.
GetUserId
getUserId_identityStoreId :: Lens' GetUserId Text Source #
The globally unique identifier for the identity store.
getUserId_alternateIdentifier :: Lens' GetUserId 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 UserDisplayName.
getUserIdResponse_httpStatus :: Lens' GetUserIdResponse Int Source #
The response's http status code.
getUserIdResponse_userId :: Lens' GetUserIdResponse Text Source #
The identifier for a user in the identity store.
getUserIdResponse_identityStoreId :: Lens' GetUserIdResponse Text Source #
The globally unique identifier for the identity store.
IsMemberInGroups
isMemberInGroups_identityStoreId :: Lens' IsMemberInGroups Text Source #
The globally unique identifier for the identity store.
isMemberInGroups_memberId :: Lens' IsMemberInGroups MemberId Source #
An object containing the identifier of a group member.
isMemberInGroups_groupIds :: Lens' IsMemberInGroups (NonEmpty Text) Source #
A list of identifiers for groups in the identity store.
isMemberInGroupsResponse_httpStatus :: Lens' IsMemberInGroupsResponse Int Source #
The response's http status code.
isMemberInGroupsResponse_results :: Lens' IsMemberInGroupsResponse [GroupMembershipExistenceResult] Source #
A list containing the results of membership existence checks.
ListGroupMemberships
listGroupMemberships_maxResults :: Lens' ListGroupMemberships (Maybe Natural) Source #
The maximum number of results to be returned per request. This parameter
is used in all List requests to specify how many results to return in
one page.
listGroupMemberships_nextToken :: Lens' ListGroupMemberships (Maybe Text) Source #
The pagination token used for the ListUsers, ListGroups and
ListGroupMemberships API operations. This value is generated by the
identity store service. It is returned in the API response if the total
results are more than the size of one page. This token is also returned
when it is used in the API request to search for the next page.
listGroupMemberships_identityStoreId :: Lens' ListGroupMemberships Text Source #
The globally unique identifier for the identity store.
listGroupMemberships_groupId :: Lens' ListGroupMemberships Text Source #
The identifier for a group in the identity store.
listGroupMembershipsResponse_nextToken :: Lens' ListGroupMembershipsResponse (Maybe Text) Source #
The pagination token used for the ListUsers, ListGroups, and
ListGroupMemberships API operations. This value is generated by the
identity store service. It is returned in the API response if the total
results are more than the size of one page. This token is also returned
when it is used in the API request to search for the next page.
listGroupMembershipsResponse_httpStatus :: Lens' ListGroupMembershipsResponse Int Source #
The response's http status code.
listGroupMembershipsResponse_groupMemberships :: Lens' ListGroupMembershipsResponse [GroupMembership] Source #
A list of GroupMembership objects in the group.
ListGroupMembershipsForMember
listGroupMembershipsForMember_maxResults :: Lens' ListGroupMembershipsForMember (Maybe Natural) Source #
The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many
results to return in one page. The length limit is 50 characters.
listGroupMembershipsForMember_nextToken :: Lens' ListGroupMembershipsForMember (Maybe Text) Source #
The pagination token used for the ListUsers, ListGroups, and
ListGroupMemberships API operations. This value is generated by the
identity store service. It is returned in the API response if the total
results are more than the size of one page. This token is also returned
when it is used in the API request to search for the next page.
listGroupMembershipsForMember_identityStoreId :: Lens' ListGroupMembershipsForMember Text Source #
The globally unique identifier for the identity store.
listGroupMembershipsForMember_memberId :: Lens' ListGroupMembershipsForMember 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.
listGroupMembershipsForMemberResponse_nextToken :: Lens' ListGroupMembershipsForMemberResponse (Maybe Text) Source #
The pagination token used for the ListUsers, ListGroups, and
ListGroupMemberships API operations. This value is generated by the
identity store service. It is returned in the API response if the total
results are more than the size of one page. This token is also returned
when it is used in the API request to search for the next page.
listGroupMembershipsForMemberResponse_httpStatus :: Lens' ListGroupMembershipsForMemberResponse Int Source #
The response's http status code.
listGroupMembershipsForMemberResponse_groupMemberships :: Lens' ListGroupMembershipsForMemberResponse [GroupMembership] Source #
A list of GroupMembership objects in the group for a specified member.
ListGroups
listGroups_filters :: Lens' ListGroups (Maybe [Filter]) Source #
A list of Filter objects, which is used in the ListUsers and
ListGroups requests.
listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #
The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many
results to return in one page. The length limit is 50 characters.
listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #
The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it is used in the API
request to search for the next page.
listGroups_identityStoreId :: Lens' ListGroups Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains numbers and
lower case letters. This value is generated at the time that a new
identity store is created.
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #
The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it1 is used in the API
request to search for the next page.
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #
The response's http status code.
listGroupsResponse_groups :: Lens' ListGroupsResponse [Group] Source #
A list of Group objects in the identity store.
ListUsers
listUsers_filters :: Lens' ListUsers (Maybe [Filter]) Source #
A list of Filter objects, which is used in the ListUsers and
ListGroups requests.
listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #
The maximum number of results to be returned per request. This parameter
is used in the ListUsers and ListGroups requests to specify how many
results to return in one page. The length limit is 50 characters.
listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #
The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it is used in the API
request to search for the next page.
listUsers_identityStoreId :: Lens' ListUsers Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains numbers and
lower case letters. This value is generated at the time that a new
identity store is created.
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #
The pagination token used for the ListUsers and ListGroups API
operations. This value is generated by the identity store service. It is
returned in the API response if the total results are more than the size
of one page. This token is also returned when it is used in the API
request to search for the next page.
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #
The response's http status code.
listUsersResponse_users :: Lens' ListUsersResponse [User] Source #
A list of User objects in the identity store.
UpdateGroup
updateGroup_identityStoreId :: Lens' UpdateGroup Text Source #
The globally unique identifier for the identity store.
updateGroup_groupId :: Lens' UpdateGroup Text Source #
The identifier for a group in the identity store.
updateGroup_operations :: Lens' UpdateGroup (NonEmpty AttributeOperation) Source #
A list of AttributeOperation objects to apply to the requested group.
These operations might add, replace, or remove an attribute.
updateGroupResponse_httpStatus :: Lens' UpdateGroupResponse Int Source #
The response's http status code.
UpdateUser
updateUser_identityStoreId :: Lens' UpdateUser Text Source #
The globally unique identifier for the identity store.
updateUser_userId :: Lens' UpdateUser Text Source #
The identifier for a user in the identity store.
updateUser_operations :: Lens' UpdateUser (NonEmpty AttributeOperation) Source #
A list of AttributeOperation objects to apply to the requested user.
These operations might add, replace, or remove an attribute.
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #
The response's http status code.
Types
Address
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
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
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
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
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
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
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
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
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
memberId_userId :: Lens' MemberId (Maybe Text) Source #
An object containing the identifiers of resources that can be members.
Name
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
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
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
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.