com.amazonaws.services.sso

Class AbstractAWSSSOAsync

java.lang.Object

com.amazonaws.services.sso.AbstractAWSSSO

com.amazonaws.services.sso.AbstractAWSSSOAsync

All Implemented Interfaces:

AWSSSO, AWSSSOAsync

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

Abstract implementation of AWSSSOAsync. Convenient method forms pass through to the corresponding overload that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSSSOAsync()

Method Summary

Modifier and Type	Method and Description
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 AWS account.
Future<ListAccountRolesResult>	listAccountRolesAsync(ListAccountRolesRequest request, AsyncHandler<ListAccountRolesRequest,ListAccountRolesResult> asyncHandler) Lists all roles that are assigned to the user for a given AWS account.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest request) Lists all AWS accounts assigned to the user.
Future<ListAccountsResult>	listAccountsAsync(ListAccountsRequest request, AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler) Lists all AWS 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 IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center 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 IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

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

getCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logout, shutdown

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.sso.AWSSSO

getCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logout, shutdown

Constructor Detail

AbstractAWSSSOAsync

protected AbstractAWSSSOAsync()

Method Detail

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

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

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

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

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