com.amazonaws.services.sso

Class AbstractAWSSSO

java.lang.Object

com.amazonaws.services.sso.AbstractAWSSSO

All Implemented Interfaces:

AWSSSO

Direct Known Subclasses:

AbstractAWSSSOAsync

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

Abstract implementation of AWSSSO. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSSSO()

Method Summary

Modifier and Type	Method and Description
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 Amazon Web Services account.
ListAccountsResult	listAccounts(ListAccountsRequest request) Lists all Amazon Web Services 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 Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAWSSSO

protected AbstractAWSSSO()

Method Detail

getRoleCredentials

public GetRoleCredentialsResult getRoleCredentials(GetRoleCredentialsRequest request)

Description copied from interface: AWSSSO

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

Specified by:

getRoleCredentials in interface AWSSSO

Returns:

Result of the GetRoleCredentials operation returned by the service.

See Also:

AWS API Documentation

listAccountRoles

public ListAccountRolesResult listAccountRoles(ListAccountRolesRequest request)

Description copied from interface: AWSSSO

Lists all roles that are assigned to the user for a given Amazon Web Services account.

Specified by:

listAccountRoles in interface AWSSSO

Returns:

Result of the ListAccountRoles operation returned by the service.

See Also:

AWS API Documentation

listAccounts

public ListAccountsResult listAccounts(ListAccountsRequest request)

Description copied from interface: AWSSSO

Lists all Amazon Web Services accounts assigned to the user. These Amazon Web Services accounts are assigned by the administrator of the account. For more information, see Assign User Access in the Amazon Web Services SSO User Guide. This operation returns a paginated response.

Specified by:

listAccounts in interface AWSSSO

Returns:

Result of the ListAccounts operation returned by the service.

See Also:

AWS API Documentation

logout

public LogoutResult logout(LogoutRequest request)

Description copied from interface: AWSSSO

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the Amazon Web Services SSO service to invalidate the corresponding server-side Amazon Web Services SSO sign in session.

If a user uses Amazon Web Services SSO to access the AWS CLI, the user’s Amazon Web Services SSO sign in session is used to obtain an IAM session, as specified in the corresponding Amazon Web Services SSO permission set. More specifically, Amazon Web Services SSO assumes an IAM role in the target account on behalf of the user, and the corresponding temporary Amazon Web Services credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using Amazon Web Services SSO permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the Amazon Web Services SSO User Guide.

Specified by:

logout in interface AWSSSO

Returns:

Result of the Logout operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSSSO

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSSO

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSSSO

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 a 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.