com.amazonaws.services.sso.AWSSSOAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sso Show documentation
/*
* Copyright 2019-2024 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.sso;
import javax.annotation.Generated;
import com.amazonaws.services.sso.model.*;
/**
* Interface for accessing SSO 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.sso.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.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSOAsync extends AWSSSO {
/**
*
* Returns the STS short-term credentials for a given role name that is assigned to the user.
*
*
* @param getRoleCredentialsRequest
* @return A Java Future containing the result of the GetRoleCredentials operation returned by the service.
* @sample AWSSSOAsync.GetRoleCredentials
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getRoleCredentialsAsync(GetRoleCredentialsRequest getRoleCredentialsRequest);
/**
*
* Returns the STS short-term credentials for a given role name that is assigned to the user.
*
*
* @param getRoleCredentialsRequest
* @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 GetRoleCredentials operation returned by the service.
* @sample AWSSSOAsyncHandler.GetRoleCredentials
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getRoleCredentialsAsync(GetRoleCredentialsRequest getRoleCredentialsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all roles that are assigned to the user for a given AWS account.
*
*
* @param listAccountRolesRequest
* @return A Java Future containing the result of the ListAccountRoles operation returned by the service.
* @sample AWSSSOAsync.ListAccountRoles
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listAccountRolesAsync(ListAccountRolesRequest listAccountRolesRequest);
/**
*
* Lists all roles that are assigned to the user for a given AWS account.
*
*
* @param listAccountRolesRequest
* @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 ListAccountRoles operation returned by the service.
* @sample AWSSSOAsyncHandler.ListAccountRoles
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listAccountRolesAsync(ListAccountRolesRequest listAccountRolesRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listAccountsRequest
* @return A Java Future containing the result of the ListAccounts operation returned by the service.
* @sample AWSSSOAsync.ListAccounts
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listAccountsRequest
* @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 ListAccounts operation returned by the service.
* @sample AWSSSOAsyncHandler.ListAccounts
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listAccountsAsync(ListAccountsRequest listAccountsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
*
* @param logoutRequest
* @return A Java Future containing the result of the Logout operation returned by the service.
* @sample AWSSSOAsync.Logout
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
*
* @param logoutRequest
* @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 Logout operation returned by the service.
* @sample AWSSSOAsyncHandler.Logout
* @see AWS API
* Documentation
*/
java.util.concurrent.Future logoutAsync(LogoutRequest logoutRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}