@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIdentityStore
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIdentityStore instead.
The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.
This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.
IAM Identity Center uses the sso and identitystore API namespaces.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group within the specified identity store.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Creates a relationship between a member and a group.
|
CreateUserResult |
createUser(CreateUserRequest createUserRequest)
Creates a user within the specified identity store.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Delete a group within an identity store given
GroupId. |
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Delete a membership within a group given
MembershipId. |
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user within an identity store given
UserId. |
DescribeGroupResult |
describeGroup(DescribeGroupRequest describeGroupRequest)
Retrieves the group metadata and attributes from
GroupId in an identity store. |
DescribeGroupMembershipResult |
describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Retrieves membership metadata and attributes from
MembershipId in an identity store. |
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Retrieves the user metadata and attributes from the
UserId in an identity store. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetGroupIdResult |
getGroupId(GetGroupIdRequest getGroupIdRequest)
Retrieves
GroupId in an identity store. |
GetGroupMembershipIdResult |
getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)
Retrieves the
MembershipId in an identity store. |
GetUserIdResult |
getUserId(GetUserIdRequest getUserIdRequest)
Retrieves the
UserId in an identity store. |
IsMemberInGroupsResult |
isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
ListGroupMembershipsForMemberResult |
listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form. |
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists all groups in the identity store.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Lists all users in the identity store.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest updateGroupRequest)
For the specified group in the specified identity store, updates the group metadata and attributes.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
For the specified user in the specified identity store, updates the user metadata and attributes.
|
static final String ENDPOINT_PREFIX
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
Creates a group within the specified identity store.
createGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId, IdentityStoreId, and MemberId.
createGroupMembershipRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a user within the specified identity store.
createUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
Delete a group within an identity store given GroupId.
deleteGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Delete a membership within a group given MembershipId.
deleteGroupMembershipRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes a user within an identity store given UserId.
deleteUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)
Retrieves the group metadata and attributes from GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
describeGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.DescribeGroupMembershipResult describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Retrieves membership metadata and attributes from MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
describeGroupMembershipRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Retrieves the user metadata and attributes from the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
describeUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.GetGroupIdResult getGroupId(GetGroupIdRequest getGroupIdRequest)
Retrieves GroupId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
getGroupIdRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.GetGroupMembershipIdResult getGroupMembershipId(GetGroupMembershipIdRequest getGroupMembershipIdRequest)
Retrieves the MembershipId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
getGroupMembershipIdRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.GetUserIdResult getUserId(GetUserIdRequest getUserIdRequest)
Retrieves the UserId in an identity store.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
getUserIdRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.IsMemberInGroupsResult isMemberInGroups(IsMemberInGroupsRequest isMemberInGroupsRequest)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
isMemberInGroupsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
For the specified group in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listGroupMembershipsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ListGroupMembershipsForMemberResult listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)
For the specified member in the specified identity store, returns the list of all GroupMembership
objects and returns results in paginated form.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listGroupMembershipsForMemberRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Lists all groups in the identity store. Returns a paginated list of complete Group objects.
Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the
GetGroupId API action.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listGroupsRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering
for a User by the UserName attribute is deprecated. Instead, use the
GetUserId API action.
If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
listUsersRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
For the specified group in the specified identity store, updates the group metadata and attributes.
updateGroupRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
For the specified user in the specified identity store, updates the user metadata and attributes.
updateUserRequest - ResourceNotFoundException - Indicates that a requested resource is not found.ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - 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 - The request processing has failed because of an unknown error, exception or failure with an internal
server.ValidationException - The request failed because it contains a syntax error.ServiceQuotaExceededException - The request would cause the number of users or groups in the identity store to exceed the maximum
allowed.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.