com.amazonaws.services.sso

Interface AWSSSOAsync

All Superinterfaces:

AWSSSO

All Known Implementing Classes:

AbstractAWSSSOAsync, AWSSSOAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSOAsync
extends AWSSSO

Interface 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.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSSOAsync instead.

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

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

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

AWS 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 AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<GetRoleCredentialsResult>	getRoleCredentialsAsync(GetRoleCredentialsRequest getRoleCredentialsRequest) Returns the STS short-term credentials for a given role name that is assigned to the user.
Future<GetRoleCredentialsResult>	getRoleCredentialsAsync(GetRoleCredentialsRequest getRoleCredentialsRequest, 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 listAccountRolesRequest) Lists all roles that are assigned to the user for a given AWS account.
Future<ListAccountRolesResult>	listAccountRolesAsync(ListAccountRolesRequest listAccountRolesRequest, AsyncHandler<ListAccountRolesRequest,ListAccountRolesResult> asyncHandler) Lists all roles that are assigned to the user for a given AWS account.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest listAccountsRequest) Lists all AWS accounts assigned to the user.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest listAccountsRequest, AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler) Lists all AWS accounts assigned to the user.
Future<LogoutResult>	logoutAsync(LogoutRequest logoutRequest) Removes the client- and server-side session that is associated with the user.
Future<LogoutResult>	logoutAsync(LogoutRequest logoutRequest, AsyncHandler<LogoutRequest,LogoutResult> asyncHandler) Removes the client- and server-side session that is associated with the user.

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

getCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logout, shutdown

Method Detail

getRoleCredentialsAsync

Future<GetRoleCredentialsResult> getRoleCredentialsAsync(GetRoleCredentialsRequest getRoleCredentialsRequest)

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

Parameters:

getRoleCredentialsRequest -

Returns:

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

See Also:

AWS API Documentation

getRoleCredentialsAsync

Future<GetRoleCredentialsResult> getRoleCredentialsAsync(GetRoleCredentialsRequest getRoleCredentialsRequest,
                                                         AsyncHandler<GetRoleCredentialsRequest,GetRoleCredentialsResult> asyncHandler)

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

Parameters:

getRoleCredentialsRequest -

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

Future<ListAccountRolesResult> listAccountRolesAsync(ListAccountRolesRequest listAccountRolesRequest)

Lists all roles that are assigned to the user for a given AWS account.

Parameters:

listAccountRolesRequest -

Returns:

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

See Also:

AWS API Documentation

listAccountRolesAsync

Future<ListAccountRolesResult> listAccountRolesAsync(ListAccountRolesRequest listAccountRolesRequest,
                                                     AsyncHandler<ListAccountRolesRequest,ListAccountRolesResult> asyncHandler)

Lists all roles that are assigned to the user for a given AWS account.

Parameters:

listAccountRolesRequest -

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

Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest listAccountsRequest)

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

Parameters:

listAccountsRequest -

Returns:

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

See Also:

AWS API Documentation

listAccountsAsync

Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest listAccountsRequest,
                                             AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler)

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

Parameters:

listAccountsRequest -

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

Future<LogoutResult> logoutAsync(LogoutRequest logoutRequest)

Removes the client- and server-side session that is associated with the user.

Parameters:

logoutRequest -

Returns:

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

See Also:

AWS API Documentation

logoutAsync

Future<LogoutResult> logoutAsync(LogoutRequest logoutRequest,
                                 AsyncHandler<LogoutRequest,LogoutResult> asyncHandler)

Removes the client- and server-side session that is associated with the user.

Parameters:

logoutRequest -

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