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 IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

Although AWS 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 IAM Identity Center rename.

This reference guide describes the IAM Identity Center 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 IAM Identity Center 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 locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.
Future<LogoutResult>	logoutAsync(LogoutRequest logoutRequest, AsyncHandler<LogoutRequest,LogoutResult> asyncHandler) Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

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 IAM Identity Center 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 IAM Identity Center 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 locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

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

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

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 locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

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

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

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