@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIdentityStoreClient extends AmazonWebServiceClient implements AWSIdentityStore
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSIdentityStoreClientBuilder |
builder() |
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a group within the specified identity store.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest request)
Creates a relationship between a member and a group.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user within the specified identity store.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Delete a group within an identity store given
GroupId. |
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest request)
Delete a membership within a group given
MembershipId. |
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user within an identity store given
UserId. |
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Retrieves the group metadata and attributes from
GroupId in an identity store. |
DescribeGroupMembershipResult |
describeGroupMembership(DescribeGroupMembershipRequest request)
Retrieves membership metadata and attributes from
MembershipId in an identity store. |
DescribeUserResult |
describeUser(DescribeUserRequest request)
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 request)
Retrieves
GroupId in an identity store. |
GetGroupMembershipIdResult |
getGroupMembershipId(GetGroupMembershipIdRequest request)
Retrieves the
MembershipId in an identity store. |
GetUserIdResult |
getUserId(GetUserIdRequest request)
Retrieves the
UserId in an identity store. |
IsMemberInGroupsResult |
isMemberInGroups(IsMemberInGroupsRequest request)
Checks the user's membership in all requested groups and returns if the member exists in all queried groups.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest request)
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 request)
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 request)
Lists all groups in the identity store.
|
ListUsersResult |
listUsers(ListUsersRequest request)
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 request)
For the specified group in the specified identity store, updates the group metadata and attributes.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
For the specified user in the specified identity store, updates the user metadata and attributes.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSIdentityStoreClientBuilder builder()
public CreateGroupResult createGroup(CreateGroupRequest request)
Creates a group within the specified identity store.
createGroup in interface AWSIdentityStorecreateGroupRequest - 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.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
Creates a relationship between a member and a group. The following identifiers must be specified:
GroupId, IdentityStoreId, and MemberId.
createGroupMembership in interface AWSIdentityStorecreateGroupMembershipRequest - 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.public CreateUserResult createUser(CreateUserRequest request)
Creates a user within the specified identity store.
createUser in interface AWSIdentityStorecreateUserRequest - 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.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Delete a group within an identity store given GroupId.
deleteGroup in interface AWSIdentityStoredeleteGroupRequest - 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.public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
Delete a membership within a group given MembershipId.
deleteGroupMembership in interface AWSIdentityStoredeleteGroupMembershipRequest - 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.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes a user within an identity store given UserId.
deleteUser in interface AWSIdentityStoredeleteUserRequest - 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.public DescribeGroupResult describeGroup(DescribeGroupRequest request)
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.
describeGroup in interface AWSIdentityStoredescribeGroupRequest - 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.public DescribeGroupMembershipResult describeGroupMembership(DescribeGroupMembershipRequest request)
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.
describeGroupMembership in interface AWSIdentityStoredescribeGroupMembershipRequest - 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.public DescribeUserResult describeUser(DescribeUserRequest request)
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.
describeUser in interface AWSIdentityStoredescribeUserRequest - 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.public GetGroupIdResult getGroupId(GetGroupIdRequest request)
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.
getGroupId in interface AWSIdentityStoregetGroupIdRequest - 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.public GetGroupMembershipIdResult getGroupMembershipId(GetGroupMembershipIdRequest request)
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.
getGroupMembershipId in interface AWSIdentityStoregetGroupMembershipIdRequest - 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.public GetUserIdResult getUserId(GetUserIdRequest request)
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.
getUserId in interface AWSIdentityStoregetUserIdRequest - 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.public IsMemberInGroupsResult isMemberInGroups(IsMemberInGroupsRequest request)
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.
isMemberInGroups in interface AWSIdentityStoreisMemberInGroupsRequest - 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.public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
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.
listGroupMemberships in interface AWSIdentityStorelistGroupMembershipsRequest - 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.public ListGroupMembershipsForMemberResult listGroupMembershipsForMember(ListGroupMembershipsForMemberRequest request)
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.
listGroupMembershipsForMember in interface AWSIdentityStorelistGroupMembershipsForMemberRequest - 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.public ListGroupsResult listGroups(ListGroupsRequest request)
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.
listGroups in interface AWSIdentityStorelistGroupsRequest - 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.public ListUsersResult listUsers(ListUsersRequest request)
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.
listUsers in interface AWSIdentityStorelistUsersRequest - 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.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
For the specified group in the specified identity store, updates the group metadata and attributes.
updateGroup in interface AWSIdentityStoreupdateGroupRequest - 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.public UpdateUserResult updateUser(UpdateUserRequest request)
For the specified user in the specified identity store, updates the user metadata and attributes.
updateUser in interface AWSIdentityStoreupdateUserRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSIdentityStorerequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSIdentityStoreshutdown in class AmazonWebServiceClient