com.amazonaws.services.identitystore

Class AWSIdentityStoreClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.identitystore.AWSIdentityStoreClient

All Implemented Interfaces:

AWSIdentityStore

Direct Known Subclasses:

AWSIdentityStoreAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIdentityStoreClient
extends AmazonWebServiceClient
implements AWSIdentityStore

Client for accessing IdentityStore. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.identitystore.AWSIdentityStore

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSIdentityStoreClientBuilder	builder()
DescribeGroupResult	describeGroup(DescribeGroupRequest request) Retrieves the group metadata and attributes from GroupId in an identity store.
DescribeUserResult	describeUser(DescribeUserRequest request) 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 request) Lists the attribute name and value of the group that you specified in the search.
ListUsersResult	listUsers(ListUsersRequest request) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSIdentityStoreClientBuilder builder()

describeGroup

public DescribeGroupResult describeGroup(DescribeGroupRequest request)

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

Specified by:

describeGroup in interface AWSIdentityStore

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

public DescribeUserResult describeUser(DescribeUserRequest request)

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

Specified by:

describeUser in interface AWSIdentityStore

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

public ListGroupsResult listGroups(ListGroupsRequest request)

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.

Specified by:

listGroups in interface AWSIdentityStore

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

public ListUsersResult listUsers(ListUsersRequest request)

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.

Specified by:

listUsers in interface AWSIdentityStore

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSIdentityStore

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSIdentityStore

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.

Specified by:

shutdown in interface AWSIdentityStore

Overrides:

shutdown in class AmazonWebServiceClient