com.amazonaws.services.sso

Class AWSSSOClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sso.AWSSSOClient

All Implemented Interfaces:

AWSSSO

Direct Known Subclasses:

AWSSSOAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSSOClient
extends AmazonWebServiceClient
implements AWSSSO

Client for accessing SSO. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSSOClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetRoleCredentialsResult	getRoleCredentials(GetRoleCredentialsRequest request) Returns the STS short-term credentials for a given role name that is assigned to the user.
ListAccountRolesResult	listAccountRoles(ListAccountRolesRequest request) Lists all roles that are assigned to the user for a given AWS account.
ListAccountsResult	listAccounts(ListAccountsRequest request) Lists all AWS accounts assigned to the user.
LogoutResult	logout(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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSSSOClientBuilder builder()

getRoleCredentials

public GetRoleCredentialsResult getRoleCredentials(GetRoleCredentialsRequest request)

Returns the STS short-term credentials for a given role name that is assigned to the user.

Specified by:

getRoleCredentials in interface AWSSSO

Parameters:

getRoleCredentialsRequest -

Returns:

Result of the GetRoleCredentials operation returned by the service.

Throws:

InvalidRequestException - Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.

UnauthorizedException - Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

TooManyRequestsException - Indicates that the request is being made too frequently and is more than what the server can handle.

ResourceNotFoundException - The specified resource doesn't exist.

See Also:

AWS API Documentation

listAccountRoles

public ListAccountRolesResult listAccountRoles(ListAccountRolesRequest request)

Lists all roles that are assigned to the user for a given AWS account.

Specified by:

listAccountRoles in interface AWSSSO

Parameters:

listAccountRolesRequest -

Returns:

Result of the ListAccountRoles operation returned by the service.

Throws:

InvalidRequestException - Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.

UnauthorizedException - Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

TooManyRequestsException - Indicates that the request is being made too frequently and is more than what the server can handle.

ResourceNotFoundException - The specified resource doesn't exist.

See Also:

AWS API Documentation

listAccounts

public ListAccountsResult listAccounts(ListAccountsRequest request)

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:

listAccounts in interface AWSSSO

Parameters:

listAccountsRequest -

Returns:

Result of the ListAccounts operation returned by the service.

Throws:

InvalidRequestException - Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.

UnauthorizedException - Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

TooManyRequestsException - Indicates that the request is being made too frequently and is more than what the server can handle.

ResourceNotFoundException - The specified resource doesn't exist.

See Also:

AWS API Documentation

logout

public LogoutResult logout(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.

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:

logout in interface AWSSSO

Parameters:

logoutRequest -

Returns:

Result of the Logout operation returned by the service.

Throws:

InvalidRequestException - Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.

UnauthorizedException - Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

TooManyRequestsException - Indicates that the request is being made too frequently and is more than what the server can handle.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSSSO

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSSO

Overrides:

shutdown in class AmazonWebServiceClient