Interface AccountAccessRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface AccountAccessRuntimeClient
extends AwsClient

Service client for accessing Account Access Runtime. This can be created using the static builder() method.

Use the Account Access Runtime API to list the roles that you can access and retrieve temporary Amazon Web Services credentials for those roles. You authenticate with a bearer token from IAM Identity Center. Each request is scoped to a tenant.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static AccountAccessRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a AccountAccessRuntimeClient.
static AccountAccessRuntimeClient	create()	Create a AccountAccessRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetRoleCredentialsResponse	getRoleCredentials(Consumer<GetRoleCredentialsRequest.Builder> getRoleCredentialsRequest)	Returns temporary Amazon Web Services credentials for a role that you are entitled to assume within a tenant.
default GetRoleCredentialsResponse	getRoleCredentials(GetRoleCredentialsRequest getRoleCredentialsRequest)	Returns temporary Amazon Web Services credentials for a role that you are entitled to assume within a tenant.
default ListRolesResponse	listRoles(Consumer<ListRolesRequest.Builder> listRolesRequest)	Returns the roles that you are entitled to access within a tenant.
default ListRolesResponse	listRoles(ListRolesRequest listRolesRequest)	Returns the roles that you are entitled to access within a tenant.
default ListRolesIterable	listRolesPaginator(Consumer<ListRolesRequest.Builder> listRolesRequest)	This is a variant of listRoles(software.amazon.awssdk.services.accountaccessruntime.model.ListRolesRequest) operation.
default ListRolesIterable	listRolesPaginator(ListRolesRequest listRolesRequest)	This is a variant of listRoles(software.amazon.awssdk.services.accountaccessruntime.model.ListRolesRequest) operation.
default AccountAccessRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

getRoleCredentials

default GetRoleCredentialsResponse getRoleCredentials(GetRoleCredentialsRequest getRoleCredentialsRequest)
                                               throws AccessDeniedException,
ThrottlingException,
UnauthorizedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
AccountAccessRuntimeException

Returns temporary Amazon Web Services credentials for a role that you are entitled to assume within a tenant. You can use these credentials for programmatic access with the CLI or an Amazon Web Services SDK. If you aren't entitled to the role, the request fails with an AccessDeniedException error.

Parameters:

getRoleCredentialsRequest -

Returns:

Result of the GetRoleCredentials operation returned by the service.

See Also:

• AWS API Documentation

getRoleCredentials

default GetRoleCredentialsResponse getRoleCredentials(Consumer<GetRoleCredentialsRequest.Builder> getRoleCredentialsRequest)
                                               throws AccessDeniedException,
ThrottlingException,
UnauthorizedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
AccountAccessRuntimeException

Returns temporary Amazon Web Services credentials for a role that you are entitled to assume within a tenant. You can use these credentials for programmatic access with the CLI or an Amazon Web Services SDK. If you aren't entitled to the role, the request fails with an AccessDeniedException error.

This is a convenience which creates an instance of the GetRoleCredentialsRequest.Builder avoiding the need to create one manually via GetRoleCredentialsRequest.builder()

Parameters:

getRoleCredentialsRequest - A Consumer that will call methods on GetRoleCredentialsRequest.Builder to create a request.

Returns:

Result of the GetRoleCredentials operation returned by the service.

See Also:

• AWS API Documentation

listRoles

default ListRolesResponse listRoles(ListRolesRequest listRolesRequest)
                             throws ThrottlingException,
UnauthorizedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
AccountAccessRuntimeException

Returns the roles that you are entitled to access within a tenant. The results are paginated. Use a returned role with GetRoleCredentials to obtain temporary credentials.

Parameters:

listRolesRequest -

Returns:

Result of the ListRoles operation returned by the service.

See Also:

• AWS API Documentation

listRoles

default ListRolesResponse listRoles(Consumer<ListRolesRequest.Builder> listRolesRequest)
                             throws ThrottlingException,
UnauthorizedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
AccountAccessRuntimeException

Returns the roles that you are entitled to access within a tenant. The results are paginated. Use a returned role with GetRoleCredentials to obtain temporary credentials.

This is a convenience which creates an instance of the ListRolesRequest.Builder avoiding the need to create one manually via ListRolesRequest.builder()

Parameters:

listRolesRequest - A Consumer that will call methods on ListRolesRequest.Builder to create a request.

Returns:

Result of the ListRoles operation returned by the service.

See Also:

• AWS API Documentation

listRolesPaginator

default ListRolesIterable listRolesPaginator(ListRolesRequest listRolesRequest)
                                      throws ThrottlingException,
UnauthorizedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
AccountAccessRuntimeException

This is a variant of listRoles(software.amazon.awssdk.services.accountaccessruntime.model.ListRolesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.accountaccessruntime.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.accountaccessruntime.paginators.ListRolesIterable responses = client
             .listRolesPaginator(request);
     for (software.amazon.awssdk.services.accountaccessruntime.model.ListRolesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.accountaccessruntime.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoles(software.amazon.awssdk.services.accountaccessruntime.model.ListRolesRequest) operation.

Parameters:

listRolesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRolesPaginator

default ListRolesIterable listRolesPaginator(Consumer<ListRolesRequest.Builder> listRolesRequest)
                                      throws ThrottlingException,
UnauthorizedException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
AccountAccessRuntimeException

This is a variant of listRoles(software.amazon.awssdk.services.accountaccessruntime.model.ListRolesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.accountaccessruntime.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.accountaccessruntime.paginators.ListRolesIterable responses = client
             .listRolesPaginator(request);
     for (software.amazon.awssdk.services.accountaccessruntime.model.ListRolesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.accountaccessruntime.paginators.ListRolesIterable responses = client.listRolesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoles(software.amazon.awssdk.services.accountaccessruntime.model.ListRolesRequest) operation.

This is a convenience which creates an instance of the ListRolesRequest.Builder avoiding the need to create one manually via ListRolesRequest.builder()

Parameters:

listRolesRequest - A Consumer that will call methods on ListRolesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

create

static AccountAccessRuntimeClient create()

Create a AccountAccessRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AccountAccessRuntimeClientBuilder builder()

Create a builder that can be used to configure and create a AccountAccessRuntimeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default AccountAccessRuntimeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration