com.amazonaws.services.sso

Class AWSSSOAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sso.AWSSSOClient

com.amazonaws.services.sso.AWSSSOAsyncClient

All Implemented Interfaces:

AWSSSO, AWSSSOAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSSOAsyncClient
extends AWSSSOClient
implements AWSSSOAsync

Client for accessing SSO 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.

Amazon Web Services Single Sign On Portal is a web service that makes it easy for you to assign user access to Amazon Web Services SSO resources such as the AWS access portal. Users can get Amazon Web Services account applications and roles assigned to them and get federated into the application.

Although Amazon Web Services Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see Amazon Web Services SSO rename.

This API reference guide describes the Amazon Web Services SSO Portal operations that you can call programatically and includes detailed information on data types and errors.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services SSO and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.sso.AWSSSO

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSSOAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetRoleCredentialsResult>	getRoleCredentialsAsync(GetRoleCredentialsRequest request) Returns the STS short-term credentials for a given role name that is assigned to the user.
Future<GetRoleCredentialsResult>	getRoleCredentialsAsync(GetRoleCredentialsRequest request, AsyncHandler<GetRoleCredentialsRequest,GetRoleCredentialsResult> asyncHandler) Returns the STS short-term credentials for a given role name that is assigned to the user.
Future<ListAccountRolesResult>	listAccountRolesAsync(ListAccountRolesRequest request) Lists all roles that are assigned to the user for a given Amazon Web Services account.
Future<ListAccountRolesResult>	listAccountRolesAsync(ListAccountRolesRequest request, AsyncHandler<ListAccountRolesRequest,ListAccountRolesResult> asyncHandler) Lists all roles that are assigned to the user for a given Amazon Web Services account.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest request) Lists all Amazon Web Services accounts assigned to the user.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest request, AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler) Lists all Amazon Web Services accounts assigned to the user.
Future<LogoutResult>	logoutAsync(LogoutRequest request) Removes the locally stored SSO tokens from the client-side cache and sends an API call to the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.
Future<LogoutResult>	logoutAsync(LogoutRequest request, AsyncHandler<LogoutRequest,LogoutResult> asyncHandler) Removes the locally stored SSO tokens from the client-side cache and sends an API call to the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.sso.AWSSSOClient

builder, getCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logout

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.sso.AWSSSO

getCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logout

Method Detail

asyncBuilder

public static AWSSSOAsyncClientBuilder 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.

getRoleCredentialsAsync

public Future<GetRoleCredentialsResult> getRoleCredentialsAsync(GetRoleCredentialsRequest request)

Description copied from interface: AWSSSOAsync

Returns the STS short-term credentials for a given role name that is assigned to the user.

Specified by:

getRoleCredentialsAsync in interface AWSSSOAsync

Returns:

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

See Also:

AWS API Documentation

getRoleCredentialsAsync

public Future<GetRoleCredentialsResult> getRoleCredentialsAsync(GetRoleCredentialsRequest request,
                                                                AsyncHandler<GetRoleCredentialsRequest,GetRoleCredentialsResult> asyncHandler)

Description copied from interface: AWSSSOAsync

Returns the STS short-term credentials for a given role name that is assigned to the user.

Specified by:

getRoleCredentialsAsync in interface AWSSSOAsync

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 GetRoleCredentials operation returned by the service.

See Also:

AWS API Documentation

listAccountRolesAsync

public Future<ListAccountRolesResult> listAccountRolesAsync(ListAccountRolesRequest request)

Description copied from interface: AWSSSOAsync

Lists all roles that are assigned to the user for a given Amazon Web Services account.

Specified by:

listAccountRolesAsync in interface AWSSSOAsync

Returns:

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

See Also:

AWS API Documentation

listAccountRolesAsync

public Future<ListAccountRolesResult> listAccountRolesAsync(ListAccountRolesRequest request,
                                                            AsyncHandler<ListAccountRolesRequest,ListAccountRolesResult> asyncHandler)

Description copied from interface: AWSSSOAsync

Lists all roles that are assigned to the user for a given Amazon Web Services account.

Specified by:

listAccountRolesAsync in interface AWSSSOAsync

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 ListAccountRoles operation returned by the service.

See Also:

AWS API Documentation

listAccountsAsync

public Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest request)

Description copied from interface: AWSSSOAsync

Lists all Amazon Web Services accounts assigned to the user. These Amazon Web Services accounts are assigned by the administrator of the account. For more information, see Assign User Access in the Amazon Web Services SSO User Guide. This operation returns a paginated response.

Specified by:

listAccountsAsync in interface AWSSSOAsync

Returns:

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

See Also:

AWS API Documentation

listAccountsAsync

public Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest request,
                                                    AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler)

Description copied from interface: AWSSSOAsync

Lists all Amazon Web Services accounts assigned to the user. These Amazon Web Services accounts are assigned by the administrator of the account. For more information, see Assign User Access in the Amazon Web Services SSO User Guide. This operation returns a paginated response.

Specified by:

listAccountsAsync in interface AWSSSOAsync

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 ListAccounts operation returned by the service.

See Also:

AWS API Documentation

logoutAsync

public Future<LogoutResult> logoutAsync(LogoutRequest request)

Description copied from interface: AWSSSOAsync

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.

If a user uses Amazon Web Services SSO to access the AWS CLI, the user’s Amazon Web Services SSO sign in session is used to obtain an IAM session, as specified in the corresponding Amazon Web Services SSO permission set. More specifically, Amazon Web Services SSO assumes an IAM role in the target account on behalf of the user, and the corresponding temporary Amazon Web Services credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using Amazon Web Services SSO permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the Amazon Web Services SSO User Guide.

Specified by:

logoutAsync in interface AWSSSOAsync

Returns:

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

See Also:

AWS API Documentation

logoutAsync

public Future<LogoutResult> logoutAsync(LogoutRequest request,
                                        AsyncHandler<LogoutRequest,LogoutResult> asyncHandler)

Description copied from interface: AWSSSOAsync

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.

If a user uses Amazon Web Services SSO to access the AWS CLI, the user’s Amazon Web Services SSO sign in session is used to obtain an IAM session, as specified in the corresponding Amazon Web Services SSO permission set. More specifically, Amazon Web Services SSO assumes an IAM role in the target account on behalf of the user, and the corresponding temporary Amazon Web Services credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using Amazon Web Services SSO permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the Amazon Web Services SSO User Guide.

Specified by:

logoutAsync in interface AWSSSOAsync

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 Logout 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 AWSSSO

Overrides:

shutdown in class AWSSSOClient