com.amazonaws.services.identitystore

Interface AWSIdentityStore

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 AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your identities (users and groups). For more information about AWS, see the AWS Single Sign-On User Guide.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
DescribeGroupResult	describeGroup(DescribeGroupRequest describeGroupRequest) Retrieves the group metadata and attributes from GroupId in an identity store.
DescribeUserResult	describeUser(DescribeUserRequest describeUserRequest) Retrieves the user metadata and attributes from 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.
ListGroupsResult	listGroups(ListGroupsRequest listGroupsRequest) Lists the attribute name and value of the group that you specified in the search.
ListUsersResult	listUsers(ListUsersRequest listUsersRequest) Lists the attribute name and value of the user that you specified in the search.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

describeGroup

DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)

Retrieves the group metadata and attributes from GroupId in an identity store.

Parameters:

describeGroupRequest -

Returns:

Result of the DescribeGroup operation returned by the service.

Throws:

ResourceNotFoundException - Indicates that a requested resource is not found.

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

describeUser

DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)

Retrieves the user metadata and attributes from UserId in an identity store.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

ResourceNotFoundException - Indicates that a requested resource is not found.

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

listGroups

ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

Parameters:

listGroupsRequest -

Returns:

Result of the ListGroups operation returned by the service.

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

See Also:

AWS API Documentation

listUsers

ListUsersResult listUsers(ListUsersRequest listUsersRequest)

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

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.