com.amazonaws.services.identitystore

Class AWSIdentityStoreAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.identitystore.AWSIdentityStoreClient

com.amazonaws.services.identitystore.AWSIdentityStoreAsyncClient

All Implemented Interfaces:

AWSIdentityStore, AWSIdentityStoreAsync

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

Client for accessing IdentityStore asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation 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 inherited from class com.amazonaws.services.identitystore.AWSIdentityStoreClient

configFactory

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 AWSIdentityStoreAsyncClientBuilder	asyncBuilder()
Future<DescribeGroupResult>	describeGroupAsync(DescribeGroupRequest request) Retrieves the group metadata and attributes from GroupId in an identity store.
Future<DescribeGroupResult>	describeGroupAsync(DescribeGroupRequest request, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler) Retrieves the group metadata and attributes from GroupId in an identity store.
Future<DescribeUserResult>	describeUserAsync(DescribeUserRequest request) Retrieves the user metadata and attributes from UserId in an identity store.
Future<DescribeUserResult>	describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler) Retrieves the user metadata and attributes from UserId in an identity store.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListGroupsResult>	listGroupsAsync(ListGroupsRequest request) Lists the attribute name and value of the group that you specified in the search.
Future<ListGroupsResult>	listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler) Lists the attribute name and value of the group that you specified in the search.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest request) Lists the attribute name and value of the user that you specified in the search.
Future<ListUsersResult>	listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler) Lists the attribute name and value of the user that you specified in the search.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.identitystore.AWSIdentityStoreClient

builder, describeGroup, describeUser, getCachedResponseMetadata, listGroups, listUsers

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

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

describeGroup, describeUser, getCachedResponseMetadata, listGroups, listUsers

Method Detail

asyncBuilder

public static AWSIdentityStoreAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

describeGroupAsync

public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request)

Description copied from interface: AWSIdentityStoreAsync

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

Specified by:

describeGroupAsync in interface AWSIdentityStoreAsync

Returns:

A Java Future containing the result of the DescribeGroup operation returned by the service.

See Also:

AWS API Documentation

describeGroupAsync

public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request,
                                                      AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)

Description copied from interface: AWSIdentityStoreAsync

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

Specified by:

describeGroupAsync in interface AWSIdentityStoreAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeGroup operation returned by the service.

See Also:

AWS API Documentation

describeUserAsync

public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)

Description copied from interface: AWSIdentityStoreAsync

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

Specified by:

describeUserAsync in interface AWSIdentityStoreAsync

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.

See Also:

AWS API Documentation

describeUserAsync

public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request,
                                                    AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)

Description copied from interface: AWSIdentityStoreAsync

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

Specified by:

describeUserAsync in interface AWSIdentityStoreAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeUser operation returned by the service.

See Also:

AWS API Documentation

listGroupsAsync

public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)

Description copied from interface: AWSIdentityStoreAsync

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:

listGroupsAsync in interface AWSIdentityStoreAsync

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

listGroupsAsync

public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request,
                                                AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)

Description copied from interface: AWSIdentityStoreAsync

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:

listGroupsAsync in interface AWSIdentityStoreAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListGroups operation returned by the service.

See Also:

AWS API Documentation

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)

Description copied from interface: AWSIdentityStoreAsync

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:

listUsersAsync in interface AWSIdentityStoreAsync

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

listUsersAsync

public Future<ListUsersResult> listUsersAsync(ListUsersRequest request,
                                              AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)

Description copied from interface: AWSIdentityStoreAsync

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:

listUsersAsync in interface AWSIdentityStoreAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListUsers operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSIdentityStore

Overrides:

shutdown in class AWSIdentityStoreClient