com.amazonaws.services.ssooidc.AWSSSOOIDCAsync Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ssooidc;
import javax.annotation.Generated;
import com.amazonaws.services.ssooidc.model.*;
/**
* Interface for accessing SSO OIDC asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.ssooidc.AbstractAWSSSOOIDCAsync} instead.
*
*
*
* 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.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSOOIDCAsync extends AWSSSOOIDC {
/**
*
* Creates 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.
*
*
* @param createTokenRequest
* @return A Java Future containing the result of the CreateToken operation returned by the service.
* @sample AWSSSOOIDCAsync.CreateToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTokenAsync(CreateTokenRequest createTokenRequest);
/**
*
* Creates 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.
*
*
* @param createTokenRequest
* @param 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.
* @return A Java Future containing the result of the CreateToken operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.CreateToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTokenAsync(CreateTokenRequest createTokenRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be
* persisted for reuse through many authentication requests.
*
*
* @param registerClientRequest
* @return A Java Future containing the result of the RegisterClient operation returned by the service.
* @sample AWSSSOOIDCAsync.RegisterClient
* @see AWS API
* Documentation
*/
java.util.concurrent.Future registerClientAsync(RegisterClientRequest registerClientRequest);
/**
*
* Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be
* persisted for reuse through many authentication requests.
*
*
* @param registerClientRequest
* @param 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.
* @return A Java Future containing the result of the RegisterClient operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.RegisterClient
* @see AWS API
* Documentation
*/
java.util.concurrent.Future registerClientAsync(RegisterClientRequest registerClientRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Initiates device authorization by requesting a pair of verification codes from the authorization service.
*
*
* @param startDeviceAuthorizationRequest
* @return A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.
* @sample AWSSSOOIDCAsync.StartDeviceAuthorization
* @see AWS API Documentation
*/
java.util.concurrent.Future startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest);
/**
*
* Initiates device authorization by requesting a pair of verification codes from the authorization service.
*
*
* @param startDeviceAuthorizationRequest
* @param 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.
* @return A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.StartDeviceAuthorization
* @see AWS API Documentation
*/
java.util.concurrent.Future startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}