| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateGroup
- CreateGroupMembership
- CreateUser
- DeleteGroup
- DeleteGroupMembership
- DeleteUser
- DescribeGroup
- DescribeGroupMembership
- DescribeUser
- GetGroupId
- GetGroupMembershipId
- GetUserId
- IsMemberInGroups
- ListGroupMemberships (Paginated)
- ListGroupMembershipsForMember (Paginated)
- ListGroups (Paginated)
- ListUsers (Paginated)
- UpdateGroup
- UpdateUser
- Types
Description
Derived from API version 2020-06-15 of the AWS service descriptions, licensed under Apache 2.0.
The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
<note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide describes the identity store operations that you can call programatically and includes detailed information on data types and errors.</p>
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 CreateGroup = CreateGroup' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text
- newCreateGroup :: Text -> CreateGroup
- data CreateGroupResponse = CreateGroupResponse' Int Text Text
- newCreateGroupResponse :: Int -> Text -> Text -> CreateGroupResponse
- data CreateGroupMembership = CreateGroupMembership' Text Text MemberId
- newCreateGroupMembership :: Text -> Text -> MemberId -> CreateGroupMembership
- data CreateGroupMembershipResponse = CreateGroupMembershipResponse' Int Text Text
- newCreateGroupMembershipResponse :: Int -> Text -> Text -> CreateGroupMembershipResponse
- data CreateUser = CreateUser' (Maybe (NonEmpty Address)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Email)) (Maybe (Sensitive Text)) (Maybe Name) (Maybe (Sensitive Text)) (Maybe (NonEmpty PhoneNumber)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text
- newCreateUser :: Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' Int Text Text
- newCreateUserResponse :: Int -> Text -> Text -> CreateUserResponse
- data DeleteGroup = DeleteGroup' Text Text
- newDeleteGroup :: Text -> Text -> DeleteGroup
- data DeleteGroupResponse = DeleteGroupResponse' Int
- newDeleteGroupResponse :: Int -> DeleteGroupResponse
- data DeleteGroupMembership = DeleteGroupMembership' Text Text
- newDeleteGroupMembership :: Text -> Text -> DeleteGroupMembership
- data DeleteGroupMembershipResponse = DeleteGroupMembershipResponse' Int
- newDeleteGroupMembershipResponse :: Int -> DeleteGroupMembershipResponse
- data DeleteUser = DeleteUser' Text Text
- newDeleteUser :: Text -> Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' Int
- newDeleteUserResponse :: Int -> DeleteUserResponse
- data DescribeGroup = DescribeGroup' Text Text
- newDescribeGroup :: Text -> Text -> DescribeGroup
- data DescribeGroupResponse = DescribeGroupResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (NonEmpty ExternalId)) Int Text Text
- newDescribeGroupResponse :: Int -> Text -> Text -> DescribeGroupResponse
- data DescribeGroupMembership = DescribeGroupMembership' Text Text
- newDescribeGroupMembership :: Text -> Text -> DescribeGroupMembership
- data DescribeGroupMembershipResponse = DescribeGroupMembershipResponse' Int Text Text Text MemberId
- newDescribeGroupMembershipResponse :: Int -> Text -> Text -> Text -> MemberId -> DescribeGroupMembershipResponse
- data DescribeUser = DescribeUser' Text Text
- newDescribeUser :: Text -> Text -> DescribeUser
- data DescribeUserResponse = DescribeUserResponse' (Maybe (NonEmpty Address)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Email)) (Maybe (NonEmpty ExternalId)) (Maybe (Sensitive Text)) (Maybe Name) (Maybe (Sensitive Text)) (Maybe (NonEmpty PhoneNumber)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Int Text Text
- newDescribeUserResponse :: Int -> Text -> Text -> DescribeUserResponse
- data GetGroupId = GetGroupId' Text AlternateIdentifier
- newGetGroupId :: Text -> AlternateIdentifier -> GetGroupId
- data GetGroupIdResponse = GetGroupIdResponse' Int Text Text
- newGetGroupIdResponse :: Int -> Text -> Text -> GetGroupIdResponse
- data GetGroupMembershipId = GetGroupMembershipId' Text Text MemberId
- newGetGroupMembershipId :: Text -> Text -> MemberId -> GetGroupMembershipId
- data GetGroupMembershipIdResponse = GetGroupMembershipIdResponse' Int Text Text
- newGetGroupMembershipIdResponse :: Int -> Text -> Text -> GetGroupMembershipIdResponse
- data GetUserId = GetUserId' Text AlternateIdentifier
- newGetUserId :: Text -> AlternateIdentifier -> GetUserId
- data GetUserIdResponse = GetUserIdResponse' Int Text Text
- newGetUserIdResponse :: Int -> Text -> Text -> GetUserIdResponse
- data IsMemberInGroups = IsMemberInGroups' Text MemberId (NonEmpty Text)
- newIsMemberInGroups :: Text -> MemberId -> NonEmpty Text -> IsMemberInGroups
- data IsMemberInGroupsResponse = IsMemberInGroupsResponse' Int [GroupMembershipExistenceResult]
- newIsMemberInGroupsResponse :: Int -> IsMemberInGroupsResponse
- data ListGroupMemberships = ListGroupMemberships' (Maybe Natural) (Maybe Text) Text Text
- newListGroupMemberships :: Text -> Text -> ListGroupMemberships
- data ListGroupMembershipsResponse = ListGroupMembershipsResponse' (Maybe Text) Int [GroupMembership]
- newListGroupMembershipsResponse :: Int -> ListGroupMembershipsResponse
- data ListGroupMembershipsForMember = ListGroupMembershipsForMember' (Maybe Natural) (Maybe Text) Text MemberId
- newListGroupMembershipsForMember :: Text -> MemberId -> ListGroupMembershipsForMember
- data ListGroupMembershipsForMemberResponse = ListGroupMembershipsForMemberResponse' (Maybe Text) Int [GroupMembership]
- newListGroupMembershipsForMemberResponse :: Int -> ListGroupMembershipsForMemberResponse
- data ListGroups = ListGroups' (Maybe [Filter]) (Maybe Natural) (Maybe Text) Text
- newListGroups :: Text -> ListGroups
- data ListGroupsResponse = ListGroupsResponse' (Maybe Text) Int [Group]
- newListGroupsResponse :: Int -> ListGroupsResponse
- data ListUsers = ListUsers' (Maybe [Filter]) (Maybe Natural) (Maybe Text) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) Int [User]
- newListUsersResponse :: Int -> ListUsersResponse
- data UpdateGroup = UpdateGroup' Text Text (NonEmpty AttributeOperation)
- newUpdateGroup :: Text -> Text -> NonEmpty AttributeOperation -> UpdateGroup
- data UpdateGroupResponse = UpdateGroupResponse' Int
- newUpdateGroupResponse :: Int -> UpdateGroupResponse
- data UpdateUser = UpdateUser' Text Text (NonEmpty AttributeOperation)
- newUpdateUser :: Text -> Text -> NonEmpty AttributeOperation -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- data Address = Address' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Bool)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newAddress :: Address
- data AlternateIdentifier = AlternateIdentifier' (Maybe ExternalId) (Maybe UniqueAttribute)
- newAlternateIdentifier :: AlternateIdentifier
- data AttributeOperation = AttributeOperation' (Maybe AttributeValue) Text
- newAttributeOperation :: Text -> AttributeOperation
- data AttributeValue = AttributeValue' {
- newAttributeValue :: AttributeValue
- data Email = Email' (Maybe (Sensitive Bool)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newEmail :: Email
- data ExternalId = ExternalId' (Sensitive Text) (Sensitive Text)
- newExternalId :: Text -> Text -> ExternalId
- data Filter = Filter' Text (Sensitive Text)
- newFilter :: Text -> Text -> Filter
- data Group = Group' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (NonEmpty ExternalId)) Text Text
- newGroup :: Text -> Text -> Group
- data GroupMembership = GroupMembership' (Maybe Text) (Maybe MemberId) (Maybe Text) Text
- newGroupMembership :: Text -> GroupMembership
- data GroupMembershipExistenceResult = GroupMembershipExistenceResult' (Maybe Text) (Maybe MemberId) (Maybe (Sensitive Bool))
- newGroupMembershipExistenceResult :: GroupMembershipExistenceResult
- data MemberId = MemberId' (Maybe Text)
- newMemberId :: MemberId
- data Name = Name' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newName :: Name
- data PhoneNumber = PhoneNumber' (Maybe (Sensitive Bool)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newPhoneNumber :: PhoneNumber
- data UniqueAttribute = UniqueAttribute' Text AttributeValue
- newUniqueAttribute :: Text -> AttributeValue -> UniqueAttribute
- data User = User' (Maybe (NonEmpty Address)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Email)) (Maybe (NonEmpty ExternalId)) (Maybe (Sensitive Text)) (Maybe Name) (Maybe (Sensitive Text)) (Maybe (NonEmpty PhoneNumber)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text Text
- newUser :: Text -> Text -> User
Service Configuration
defaultService :: Service Source #
API version 2020-06-15 of the Amazon SSO Identity Store SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IdentityStore.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_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
_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
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Indicates that a requested resource is not found.
ServiceQuotaExceededException
_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
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The request failed because it contains a syntax error.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateGroup
data CreateGroup Source #
See: newCreateGroup smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateGroup |
Create a value of CreateGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateGroup, createGroup_description - A string containing the description of the group.
CreateGroup, createGroup_displayName - A string containing the name of the group. This value is commonly
displayed when the group is referenced.
CreateGroup, createGroup_identityStoreId - The globally unique identifier for the identity store.
data CreateGroupResponse Source #
See: newCreateGroupResponse smart constructor.
Constructors
| CreateGroupResponse' Int Text Text |
Instances
newCreateGroupResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateGroupResponse |
Create a value of CreateGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateGroupResponse', createGroupResponse_httpStatus - The response's http status code.
CreateGroupResponse, createGroupResponse_groupId - The identifier of the newly created group in the identity store.
CreateGroup, createGroupResponse_identityStoreId - The globally unique identifier for the identity store.
CreateGroupMembership
data CreateGroupMembership Source #
See: newCreateGroupMembership smart constructor.
Constructors
| CreateGroupMembership' Text Text MemberId |
Instances
newCreateGroupMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> MemberId | |
| -> CreateGroupMembership |
Create a value of CreateGroupMembership 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:
CreateGroupMembership, createGroupMembership_identityStoreId - The globally unique identifier for the identity store.
CreateGroupMembership, createGroupMembership_groupId - The identifier for a group in the identity store.
CreateGroupMembership, createGroupMembership_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.
data CreateGroupMembershipResponse Source #
See: newCreateGroupMembershipResponse smart constructor.
Constructors
| CreateGroupMembershipResponse' Int Text Text |
Instances
newCreateGroupMembershipResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateGroupMembershipResponse |
Create a value of CreateGroupMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateGroupMembershipResponse', createGroupMembershipResponse_httpStatus - The response's http status code.
CreateGroupMembershipResponse, createGroupMembershipResponse_membershipId - The identifier for a newly created GroupMembership in an identity
store.
CreateGroupMembership, createGroupMembershipResponse_identityStoreId - The globally unique identifier for the identity store.
CreateUser
data CreateUser Source #
See: newCreateUser smart constructor.
Constructors
| CreateUser' (Maybe (NonEmpty Address)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Email)) (Maybe (Sensitive Text)) (Maybe Name) (Maybe (Sensitive Text)) (Maybe (NonEmpty PhoneNumber)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text |
Instances
Arguments
| :: Text | |
| -> CreateUser |
Create a value of CreateUser 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:
CreateUser, createUser_addresses - A list of Address objects containing addresses associated with the
user.
CreateUser, createUser_displayName - A string containing the user's name. This value is typically formatted
for display when the user is referenced. For example, "John Doe."
CreateUser, createUser_emails - A list of Email objects containing email addresses associated with the
user.
CreateUser, createUser_locale - A string containing the user's geographical region or location.
CreateUser, createUser_name - An object containing the user's name.
CreateUser, createUser_nickName - A string containing an alternate name for the user.
CreateUser, createUser_phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with
the user.
CreateUser, createUser_preferredLanguage - A string containing the preferred language of the user. For example,
"American English" or "en-us."
CreateUser, createUser_profileUrl - A string containing a URL that may be associated with the user.
CreateUser, createUser_timezone - A string containing the user's time zone.
CreateUser, createUser_title - A string containing the user's title. Possible values are left
unspecified given that they depend on each customer's specific needs.
CreateUser, createUser_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.
CreateUser, createUser_userType - A string indicating the user's type. Possible values depend on each
customer's specific needs, so they are left unspecified.
CreateUser, createUser_identityStoreId - The globally unique identifier for the identity store.
data CreateUserResponse Source #
See: newCreateUserResponse smart constructor.
Constructors
| CreateUserResponse' Int Text Text |
Instances
newCreateUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateUserResponse |
Create a value of CreateUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.
CreateUserResponse, createUserResponse_userId - The identifier of the newly created user in the identity store.
CreateUser, createUserResponse_identityStoreId - The globally unique identifier for the identity store.
DeleteGroup
data DeleteGroup Source #
See: newDeleteGroup smart constructor.
Constructors
| DeleteGroup' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteGroup |
Create a value of DeleteGroup 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:
DeleteGroup, deleteGroup_identityStoreId - The globally unique identifier for the identity store.
DeleteGroup, deleteGroup_groupId - The identifier for a group in the identity store.
data DeleteGroupResponse Source #
See: newDeleteGroupResponse smart constructor.
Constructors
| DeleteGroupResponse' Int |
Instances
newDeleteGroupResponse Source #
Arguments
| :: Int | |
| -> DeleteGroupResponse |
Create a value of DeleteGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteGroupResponse', deleteGroupResponse_httpStatus - The response's http status code.
DeleteGroupMembership
data DeleteGroupMembership Source #
See: newDeleteGroupMembership smart constructor.
Constructors
| DeleteGroupMembership' Text Text |
Instances
newDeleteGroupMembership Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteGroupMembership |
Create a value of DeleteGroupMembership 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:
DeleteGroupMembership, deleteGroupMembership_identityStoreId - The globally unique identifier for the identity store.
DeleteGroupMembership, deleteGroupMembership_membershipId - The identifier for a GroupMembership in an identity store.
data DeleteGroupMembershipResponse Source #
See: newDeleteGroupMembershipResponse smart constructor.
Constructors
| DeleteGroupMembershipResponse' Int |
Instances
newDeleteGroupMembershipResponse Source #
Create a value of DeleteGroupMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteGroupMembershipResponse', deleteGroupMembershipResponse_httpStatus - The response's http status code.
DeleteUser
data DeleteUser Source #
See: newDeleteUser smart constructor.
Constructors
| DeleteUser' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteUser |
Create a value of DeleteUser 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:
DeleteUser, deleteUser_identityStoreId - The globally unique identifier for the identity store.
DeleteUser, deleteUser_userId - The identifier for a user in the identity store.
data DeleteUserResponse Source #
See: newDeleteUserResponse smart constructor.
Constructors
| DeleteUserResponse' Int |
Instances
newDeleteUserResponse Source #
Arguments
| :: Int | |
| -> DeleteUserResponse |
Create a value of DeleteUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUserResponse', deleteUserResponse_httpStatus - The response's http status code.
DescribeGroup
data DescribeGroup Source #
See: newDescribeGroup smart constructor.
Constructors
| DescribeGroup' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeGroup |
Create a value of DescribeGroup 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:
DescribeGroup, describeGroup_identityStoreId - 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, describeGroup_groupId - The identifier for a group in the identity store.
data DescribeGroupResponse Source #
See: newDescribeGroupResponse smart constructor.
Constructors
| DescribeGroupResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (NonEmpty ExternalId)) Int Text Text |
Instances
newDescribeGroupResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> DescribeGroupResponse |
Create a value of DescribeGroupResponse 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:
DescribeGroupResponse, describeGroupResponse_description - A string containing a description of the group.
DescribeGroupResponse, describeGroupResponse_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
that the group is created and stored as an attribute of the group object
in the identity store.
DescribeGroupResponse, describeGroupResponse_externalIds - A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
$sel:httpStatus:DescribeGroupResponse', describeGroupResponse_httpStatus - The response's http status code.
DescribeGroup, describeGroupResponse_groupId - The identifier for a group in the identity store.
DescribeGroup, describeGroupResponse_identityStoreId - The globally unique identifier for the identity store.
DescribeGroupMembership
data DescribeGroupMembership Source #
See: newDescribeGroupMembership smart constructor.
Constructors
| DescribeGroupMembership' Text Text |
Instances
newDescribeGroupMembership Source #
Create a value of DescribeGroupMembership 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:
DescribeGroupMembership, describeGroupMembership_identityStoreId - The globally unique identifier for the identity store.
DescribeGroupMembership, describeGroupMembership_membershipId - The identifier for a GroupMembership in an identity store.
data DescribeGroupMembershipResponse Source #
See: newDescribeGroupMembershipResponse smart constructor.
Instances
newDescribeGroupMembershipResponse Source #
Create a value of DescribeGroupMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeGroupMembershipResponse', describeGroupMembershipResponse_httpStatus - The response's http status code.
DescribeGroupMembership, describeGroupMembershipResponse_identityStoreId - The globally unique identifier for the identity store.
DescribeGroupMembership, describeGroupMembershipResponse_membershipId - The identifier for a GroupMembership in an identity store.
DescribeGroupMembershipResponse, describeGroupMembershipResponse_groupId - The identifier for a group in the identity store.
DescribeGroupMembershipResponse, describeGroupMembershipResponse_memberId - Undocumented member.
DescribeUser
data DescribeUser Source #
See: newDescribeUser smart constructor.
Constructors
| DescribeUser' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeUser |
Create a value of DescribeUser 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:
DescribeUser, describeUser_identityStoreId - 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, describeUser_userId - The identifier for a user in the identity store.
data DescribeUserResponse Source #
See: newDescribeUserResponse smart constructor.
Constructors
| DescribeUserResponse' (Maybe (NonEmpty Address)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Email)) (Maybe (NonEmpty ExternalId)) (Maybe (Sensitive Text)) (Maybe Name) (Maybe (Sensitive Text)) (Maybe (NonEmpty PhoneNumber)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Int Text Text |
Instances
newDescribeUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> DescribeUserResponse |
Create a value of DescribeUserResponse 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:
DescribeUserResponse, describeUserResponse_addresses - The user's physical address.
DescribeUserResponse, describeUserResponse_displayName - The user's name value for display.
DescribeUserResponse, describeUserResponse_emails - The user's email value.
DescribeUserResponse, describeUserResponse_externalIds - A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
DescribeUserResponse, describeUserResponse_locale - A string containing the user's geographical region or location.
DescribeUserResponse, describeUserResponse_name - The name of the user.
DescribeUserResponse, describeUserResponse_nickName - An alternative descriptive name for the user.
DescribeUserResponse, describeUserResponse_phoneNumbers - A list of PhoneNumber objects associated with a user.
DescribeUserResponse, describeUserResponse_preferredLanguage - The preferred language of the user.
DescribeUserResponse, describeUserResponse_profileUrl - A URL link for the user's profile.
DescribeUserResponse, describeUserResponse_timezone - The time zone for a user.
DescribeUserResponse, describeUserResponse_title - A string containing the user's title.
DescribeUserResponse, describeUserResponse_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.
DescribeUserResponse, describeUserResponse_userType - A string indicating the user's type.
$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.
DescribeUser, describeUserResponse_userId - The identifier for a user in the identity store.
DescribeUser, describeUserResponse_identityStoreId - The globally unique identifier for the identity store.
GetGroupId
data GetGroupId Source #
See: newGetGroupId smart constructor.
Constructors
| GetGroupId' Text AlternateIdentifier |
Instances
Create a value of GetGroupId 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:
GetGroupId, getGroupId_identityStoreId - The globally unique identifier for the identity store.
$sel:alternateIdentifier:GetGroupId', getGroupId_alternateIdentifier - 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.
data GetGroupIdResponse Source #
See: newGetGroupIdResponse smart constructor.
Constructors
| GetGroupIdResponse' Int Text Text |
Instances
newGetGroupIdResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> GetGroupIdResponse |
Create a value of GetGroupIdResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetGroupIdResponse', getGroupIdResponse_httpStatus - The response's http status code.
GetGroupIdResponse, getGroupIdResponse_groupId - The identifier for a group in the identity store.
GetGroupId, getGroupIdResponse_identityStoreId - The globally unique identifier for the identity store.
GetGroupMembershipId
data GetGroupMembershipId Source #
See: newGetGroupMembershipId smart constructor.
Constructors
| GetGroupMembershipId' Text Text MemberId |
Instances
newGetGroupMembershipId Source #
Arguments
| :: Text | |
| -> Text | |
| -> MemberId | |
| -> GetGroupMembershipId |
Create a value of GetGroupMembershipId 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:
GetGroupMembershipId, getGroupMembershipId_identityStoreId - The globally unique identifier for the identity store.
GetGroupMembershipId, getGroupMembershipId_groupId - The identifier for a group in the identity store.
GetGroupMembershipId, getGroupMembershipId_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.
data GetGroupMembershipIdResponse Source #
See: newGetGroupMembershipIdResponse smart constructor.
Constructors
| GetGroupMembershipIdResponse' Int Text Text |
Instances
newGetGroupMembershipIdResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> GetGroupMembershipIdResponse |
Create a value of GetGroupMembershipIdResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetGroupMembershipIdResponse', getGroupMembershipIdResponse_httpStatus - The response's http status code.
GetGroupMembershipIdResponse, getGroupMembershipIdResponse_membershipId - The identifier for a GroupMembership in an identity store.
GetGroupMembershipId, getGroupMembershipIdResponse_identityStoreId - The globally unique identifier for the identity store.
GetUserId
See: newGetUserId smart constructor.
Constructors
| GetUserId' Text AlternateIdentifier |
Instances
Create a value of GetUserId 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:
GetUserId, getUserId_identityStoreId - The globally unique identifier for the identity store.
$sel:alternateIdentifier:GetUserId', getUserId_alternateIdentifier - 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.
data GetUserIdResponse Source #
See: newGetUserIdResponse smart constructor.
Constructors
| GetUserIdResponse' Int Text Text |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> GetUserIdResponse |
Create a value of GetUserIdResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetUserIdResponse', getUserIdResponse_httpStatus - The response's http status code.
GetUserIdResponse, getUserIdResponse_userId - The identifier for a user in the identity store.
GetUserId, getUserIdResponse_identityStoreId - The globally unique identifier for the identity store.
IsMemberInGroups
data IsMemberInGroups Source #
See: newIsMemberInGroups smart constructor.
Constructors
| IsMemberInGroups' Text MemberId (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> MemberId | |
| -> NonEmpty Text | |
| -> IsMemberInGroups |
Create a value of IsMemberInGroups 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:
IsMemberInGroups, isMemberInGroups_identityStoreId - The globally unique identifier for the identity store.
IsMemberInGroups, isMemberInGroups_memberId - An object containing the identifier of a group member.
$sel:groupIds:IsMemberInGroups', isMemberInGroups_groupIds - A list of identifiers for groups in the identity store.
data IsMemberInGroupsResponse Source #
See: newIsMemberInGroupsResponse smart constructor.
Constructors
| IsMemberInGroupsResponse' Int [GroupMembershipExistenceResult] |
Instances
newIsMemberInGroupsResponse Source #
Create a value of IsMemberInGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:IsMemberInGroupsResponse', isMemberInGroupsResponse_httpStatus - The response's http status code.
$sel:results:IsMemberInGroupsResponse', isMemberInGroupsResponse_results - A list containing the results of membership existence checks.
ListGroupMemberships (Paginated)
data ListGroupMemberships Source #
See: newListGroupMemberships smart constructor.
Instances
newListGroupMemberships Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListGroupMemberships |
Create a value of ListGroupMemberships 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:maxResults:ListGroupMemberships', listGroupMemberships_maxResults - 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, listGroupMemberships_nextToken - 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, listGroupMemberships_identityStoreId - The globally unique identifier for the identity store.
ListGroupMemberships, listGroupMemberships_groupId - The identifier for a group in the identity store.
data ListGroupMembershipsResponse Source #
See: newListGroupMembershipsResponse smart constructor.
Constructors
| ListGroupMembershipsResponse' (Maybe Text) Int [GroupMembership] |
Instances
newListGroupMembershipsResponse Source #
Create a value of ListGroupMembershipsResponse 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:
ListGroupMemberships, listGroupMembershipsResponse_nextToken - 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.
$sel:httpStatus:ListGroupMembershipsResponse', listGroupMembershipsResponse_httpStatus - The response's http status code.
$sel:groupMemberships:ListGroupMembershipsResponse', listGroupMembershipsResponse_groupMemberships - A list of GroupMembership objects in the group.
ListGroupMembershipsForMember (Paginated)
data ListGroupMembershipsForMember Source #
See: newListGroupMembershipsForMember smart constructor.
Instances
newListGroupMembershipsForMember Source #
Arguments
| :: Text | |
| -> MemberId | |
| -> ListGroupMembershipsForMember |
Create a value of ListGroupMembershipsForMember 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:maxResults:ListGroupMembershipsForMember', listGroupMembershipsForMember_maxResults - 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, listGroupMembershipsForMember_nextToken - 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, listGroupMembershipsForMember_identityStoreId - The globally unique identifier for the identity store.
ListGroupMembershipsForMember, listGroupMembershipsForMember_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.
data ListGroupMembershipsForMemberResponse Source #
See: newListGroupMembershipsForMemberResponse smart constructor.
Constructors
| ListGroupMembershipsForMemberResponse' (Maybe Text) Int [GroupMembership] |
Instances
newListGroupMembershipsForMemberResponse Source #
Arguments
| :: Int | |
| -> ListGroupMembershipsForMemberResponse |
Create a value of ListGroupMembershipsForMemberResponse 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:
ListGroupMembershipsForMember, listGroupMembershipsForMemberResponse_nextToken - 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.
$sel:httpStatus:ListGroupMembershipsForMemberResponse', listGroupMembershipsForMemberResponse_httpStatus - The response's http status code.
$sel:groupMemberships:ListGroupMembershipsForMemberResponse', listGroupMembershipsForMemberResponse_groupMemberships - A list of GroupMembership objects in the group for a specified member.
ListGroups (Paginated)
data ListGroups Source #
See: newListGroups smart constructor.
Instances
Arguments
| :: Text | |
| -> ListGroups |
Create a value of ListGroups 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:filters:ListGroups', listGroups_filters - A list of Filter objects, which is used in the ListUsers and
ListGroups requests.
$sel:maxResults:ListGroups', listGroups_maxResults - 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, listGroups_nextToken - 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, listGroups_identityStoreId - 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.
data ListGroupsResponse Source #
See: newListGroupsResponse smart constructor.
Constructors
| ListGroupsResponse' (Maybe Text) Int [Group] |
Instances
newListGroupsResponse Source #
Arguments
| :: Int | |
| -> ListGroupsResponse |
Create a value of ListGroupsResponse 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:
ListGroups, listGroupsResponse_nextToken - 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.
$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.
$sel:groups:ListGroupsResponse', listGroupsResponse_groups - A list of Group objects in the identity store.
ListUsers (Paginated)
See: newListUsers smart constructor.
Instances
Create a value of ListUsers 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:filters:ListUsers', listUsers_filters - A list of Filter objects, which is used in the ListUsers and
ListGroups requests.
$sel:maxResults:ListUsers', listUsers_maxResults - 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, listUsers_nextToken - 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, listUsers_identityStoreId - 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.
data ListUsersResponse Source #
See: newListUsersResponse smart constructor.
Constructors
| ListUsersResponse' (Maybe Text) Int [User] |
Instances
Arguments
| :: Int | |
| -> ListUsersResponse |
Create a value of ListUsersResponse 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:
ListUsers, listUsersResponse_nextToken - 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.
$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.
$sel:users:ListUsersResponse', listUsersResponse_users - A list of User objects in the identity store.
UpdateGroup
data UpdateGroup Source #
See: newUpdateGroup smart constructor.
Constructors
| UpdateGroup' Text Text (NonEmpty AttributeOperation) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty AttributeOperation | |
| -> UpdateGroup |
Create a value of UpdateGroup 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:
UpdateGroup, updateGroup_identityStoreId - The globally unique identifier for the identity store.
UpdateGroup, updateGroup_groupId - The identifier for a group in the identity store.
$sel:operations:UpdateGroup', updateGroup_operations - A list of AttributeOperation objects to apply to the requested group.
These operations might add, replace, or remove an attribute.
data UpdateGroupResponse Source #
See: newUpdateGroupResponse smart constructor.
Constructors
| UpdateGroupResponse' Int |
Instances
newUpdateGroupResponse Source #
Arguments
| :: Int | |
| -> UpdateGroupResponse |
Create a value of UpdateGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateGroupResponse', updateGroupResponse_httpStatus - The response's http status code.
UpdateUser
data UpdateUser Source #
See: newUpdateUser smart constructor.
Constructors
| UpdateUser' Text Text (NonEmpty AttributeOperation) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty AttributeOperation | |
| -> UpdateUser |
Create a value of UpdateUser 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:
UpdateUser, updateUser_identityStoreId - The globally unique identifier for the identity store.
UpdateUser, updateUser_userId - The identifier for a user in the identity store.
$sel:operations:UpdateUser', updateUser_operations - A list of AttributeOperation objects to apply to the requested user.
These operations might add, replace, or remove an attribute.
data UpdateUserResponse Source #
See: newUpdateUserResponse smart constructor.
Constructors
| UpdateUserResponse' Int |
Instances
newUpdateUserResponse Source #
Arguments
| :: Int | |
| -> UpdateUserResponse |
Create a value of UpdateUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.
Types
Address
The address associated with the specified user.
See: newAddress smart constructor.
Constructors
| Address' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Bool)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) |
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."
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' (Maybe ExternalId) (Maybe UniqueAttribute) |
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.
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' (Maybe AttributeValue) Text |
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.
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.
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."
ExternalId
data ExternalId Source #
The identifier issued to this resource by an external identity provider.
See: newExternalId smart constructor.
Constructors
| ExternalId' (Sensitive Text) (Sensitive Text) |
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.
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.
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.
Group
A group object that contains a specified group’s metadata and attributes.
See: newGroup smart constructor.
Constructors
| Group' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (NonEmpty ExternalId)) Text Text |
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.
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.
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.
GroupMembershipExistenceResult
data GroupMembershipExistenceResult Source #
Indicates whether a resource is a member of a group in the identity store.
See: newGroupMembershipExistenceResult smart constructor.
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.
MemberId
An object containing the identifier of a group member.
See: newMemberId smart constructor.
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.
Name
The full name of the user.
See: newName smart constructor.
Constructors
| Name' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) |
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.
PhoneNumber
data PhoneNumber Source #
The phone number associated with the user.
See: newPhoneNumber smart constructor.
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".
UniqueAttribute
data UniqueAttribute Source #
An entity attribute that's unique to a specific entity.
See: newUniqueAttribute smart constructor.
Constructors
| UniqueAttribute' Text AttributeValue |
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.
User
A user object that contains a specified user’s metadata and attributes.
See: newUser smart constructor.
Constructors
| User' (Maybe (NonEmpty Address)) (Maybe (Sensitive Text)) (Maybe (NonEmpty Email)) (Maybe (NonEmpty ExternalId)) (Maybe (Sensitive Text)) (Maybe Name) (Maybe (Sensitive Text)) (Maybe (NonEmpty PhoneNumber)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text Text |
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.