AWSIdentityStore (AWS Java SDK for AWS SSO Identity Store 1.12.727 API)

All Known Subinterfaces:

AWSIdentityStoreAsync

All Known Implementing Classes:

AbstractAWSIdentityStore, AbstractAWSIdentityStoreAsync, AWSIdentityStoreAsyncClient, AWSIdentityStoreClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIdentityStore
```
Interface for accessing IdentityStore.
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createGroup
```
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
```
    Creates a group within the specified identity store.
    Parameters:
    
    createGroupRequest -
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createGroupMembership
```
CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
```
    Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.
    Parameters:
    
    createGroupMembershipRequest -
    
    Returns:
    
    Result of the CreateGroupMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates a user within the specified identity store.
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
```
    Delete a group within an identity store given GroupId.
    Parameters:
    
    deleteGroupRequest -
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteGroupMembership
```
DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
```
    Delete a membership within a group given MembershipId.
    Parameters:
    
    deleteGroupMembershipRequest -
    
    Returns:
    
    Result of the DeleteGroupMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes a user within an identity store given UserId.
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
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.
    
    Parameters:
    
    describeGroupRequest -
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeGroupMembership
```
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.
    
    Parameters:
    
    describeGroupMembershipRequest -
    
    Returns:
    
    Result of the DescribeGroupMembership operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
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.
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getGroupId
```
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.
    
    Parameters:
    
    getGroupIdRequest -
    
    Returns:
    
    Result of the GetGroupId operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getGroupMembershipId
```
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.
    
    Parameters:
    
    getGroupMembershipIdRequest -
    
    Returns:
    
    Result of the GetGroupMembershipId operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getUserId
```
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.
    
    Parameters:
    
    getUserIdRequest -
    
    Returns:
    
    Result of the GetUserId operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - isMemberInGroups
```
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.
    
    Parameters:
    
    isMemberInGroupsRequest -
    
    Returns:
    
    Result of the IsMemberInGroups operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listGroupMemberships
```
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.
    
    Parameters:
    
    listGroupMembershipsRequest -
    
    Returns:
    
    Result of the ListGroupMemberships operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listGroupMembershipsForMember
```
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.
    
    Parameters:
    
    listGroupMembershipsForMemberRequest -
    
    Returns:
    
    Result of the ListGroupMembershipsForMember operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
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.
    
    Parameters:
    
    listGroupsRequest -
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
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.
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
```
    For the specified group in the specified identity store, updates the group metadata and attributes.
    Parameters:
    
    updateGroupRequest -
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
```
    For the specified user in the specified identity store, updates the user metadata and attributes.
    Parameters:
    
    updateUserRequest -
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSIdentityStore

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createGroup

createGroupMembership

createUser

deleteGroup

deleteGroupMembership

deleteUser

describeGroup

describeGroupMembership

describeUser

getGroupId

getGroupMembershipId

getUserId

isMemberInGroups

listGroupMemberships

listGroupMembershipsForMember

listGroups

listUsers

updateGroup

updateUser

shutdown

getCachedResponseMetadata