@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSSOAsyncClient extends AWSSSOClient implements AWSSSOAsync
AsyncHandler can be used to receive notification when an
asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| 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 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.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
builder, getCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logoutaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCachedResponseMetadata, getRoleCredentials, listAccountRoles, listAccounts, logoutpublic static AWSSSOAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<GetRoleCredentialsResult> getRoleCredentialsAsync(GetRoleCredentialsRequest request)
AWSSSOAsyncReturns the STS short-term credentials for a given role name that is assigned to the user.
getRoleCredentialsAsync in interface AWSSSOAsyncpublic Future<GetRoleCredentialsResult> getRoleCredentialsAsync(GetRoleCredentialsRequest request, AsyncHandler<GetRoleCredentialsRequest,GetRoleCredentialsResult> asyncHandler)
AWSSSOAsyncReturns the STS short-term credentials for a given role name that is assigned to the user.
getRoleCredentialsAsync in interface AWSSSOAsyncasyncHandler - 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.public Future<ListAccountRolesResult> listAccountRolesAsync(ListAccountRolesRequest request)
AWSSSOAsyncLists all roles that are assigned to the user for a given AWS account.
listAccountRolesAsync in interface AWSSSOAsyncpublic Future<ListAccountRolesResult> listAccountRolesAsync(ListAccountRolesRequest request, AsyncHandler<ListAccountRolesRequest,ListAccountRolesResult> asyncHandler)
AWSSSOAsyncLists all roles that are assigned to the user for a given AWS account.
listAccountRolesAsync in interface AWSSSOAsyncasyncHandler - 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.public Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest request)
AWSSSOAsyncLists 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.
listAccountsAsync in interface AWSSSOAsyncpublic Future<ListAccountsResult> listAccountsAsync(ListAccountsRequest request, AsyncHandler<ListAccountsRequest,ListAccountsResult> asyncHandler)
AWSSSOAsyncLists 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.
listAccountsAsync in interface AWSSSOAsyncasyncHandler - 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.public Future<LogoutResult> logoutAsync(LogoutRequest request)
AWSSSOAsyncRemoves 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.
logoutAsync in interface AWSSSOAsyncpublic Future<LogoutResult> logoutAsync(LogoutRequest request, AsyncHandler<LogoutRequest,LogoutResult> asyncHandler)
AWSSSOAsyncRemoves 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.
logoutAsync in interface AWSSSOAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSSSOshutdown in class AWSSSOClient