@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSSOOIDCAsyncClient extends AWSSSOOIDCClient implements AWSSSOOIDCAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).
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 OIDC 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, and 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSSSOOIDCAsyncClientBuilder |
asyncBuilder() |
Future<CreateTokenResult> |
createTokenAsync(CreateTokenRequest request)
Creates and returns an access token for the authorized client.
|
Future<CreateTokenResult> |
createTokenAsync(CreateTokenRequest request,
AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler)
Creates and returns an access token for the authorized client.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<RegisterClientResult> |
registerClientAsync(RegisterClientRequest request)
Registers a client with AWS SSO.
|
Future<RegisterClientResult> |
registerClientAsync(RegisterClientRequest request,
AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler)
Registers a client with AWS SSO.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartDeviceAuthorizationResult> |
startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest request)
Initiates device authorization by requesting a pair of verification codes from the authorization service.
|
Future<StartDeviceAuthorizationResult> |
startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest request,
AsyncHandler<StartDeviceAuthorizationRequest,StartDeviceAuthorizationResult> asyncHandler)
Initiates device authorization by requesting a pair of verification codes from the authorization service.
|
builder, createToken, getCachedResponseMetadata, registerClient, startDeviceAuthorizationaddRequestHandler, 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, waitcreateToken, getCachedResponseMetadata, registerClient, startDeviceAuthorizationpublic static AWSSSOOIDCAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateTokenResult> createTokenAsync(CreateTokenRequest request)
AWSSSOOIDCAsyncCreates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.
createTokenAsync in interface AWSSSOOIDCAsyncpublic Future<CreateTokenResult> createTokenAsync(CreateTokenRequest request, AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler)
AWSSSOOIDCAsyncCreates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.
createTokenAsync in interface AWSSSOOIDCAsyncasyncHandler - 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<RegisterClientResult> registerClientAsync(RegisterClientRequest request)
AWSSSOOIDCAsyncRegisters a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
registerClientAsync in interface AWSSSOOIDCAsyncpublic Future<RegisterClientResult> registerClientAsync(RegisterClientRequest request, AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler)
AWSSSOOIDCAsyncRegisters a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
registerClientAsync in interface AWSSSOOIDCAsyncasyncHandler - 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<StartDeviceAuthorizationResult> startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest request)
AWSSSOOIDCAsyncInitiates device authorization by requesting a pair of verification codes from the authorization service.
startDeviceAuthorizationAsync in interface AWSSSOOIDCAsyncpublic Future<StartDeviceAuthorizationResult> startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest request, AsyncHandler<StartDeviceAuthorizationRequest,StartDeviceAuthorizationResult> asyncHandler)
AWSSSOOIDCAsyncInitiates device authorization by requesting a pair of verification codes from the authorization service.
startDeviceAuthorizationAsync in interface AWSSSOOIDCAsyncasyncHandler - 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 AWSSSOOIDCshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.