Interface IamToolboxClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing IAM Toolbox (Preview). This can be created using the static builder() method.

Contains APIs to work with AWS Identity and Access Management (IAM).

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 IamToolboxClientBuilder	builder()	Create a builder that can be used to configure and create a IamToolboxClient.
static IamToolboxClient	create()	Create a IamToolboxClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetRequestAuthorizationDetailsResponse	getRequestAuthorizationDetails(Consumer<GetRequestAuthorizationDetailsRequest.Builder> getRequestAuthorizationDetailsRequest)	Retrieves the authorization details for a specific access denied request.
default GetRequestAuthorizationDetailsResponse	getRequestAuthorizationDetails(GetRequestAuthorizationDetailsRequest getRequestAuthorizationDetailsRequest)	Retrieves the authorization details for a specific access denied request.
default GetRequestAuthorizationDetailsIterable	getRequestAuthorizationDetailsPaginator(Consumer<GetRequestAuthorizationDetailsRequest.Builder> getRequestAuthorizationDetailsRequest)	This is a variant of getRequestAuthorizationDetails(software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsRequest) operation.
default GetRequestAuthorizationDetailsIterable	getRequestAuthorizationDetailsPaginator(GetRequestAuthorizationDetailsRequest getRequestAuthorizationDetailsRequest)	This is a variant of getRequestAuthorizationDetails(software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsRequest) operation.
default IamToolboxServiceClientConfiguration	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

getRequestAuthorizationDetails

default GetRequestAuthorizationDetailsResponse getRequestAuthorizationDetails(GetRequestAuthorizationDetailsRequest getRequestAuthorizationDetailsRequest)
                                                                       throws AccessDeniedException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
IamToolboxException

Retrieves the authorization details for a specific access denied request. The details include the request context, the evaluations performed, and the policies that were evaluated.

Use this operation to understand why a request was denied. Supported services include an authorization ID in the access denied error message. Pass that ID to this operation to retrieve the details.

Authorization details are available for at least 24 hours after the denial.

To use this operation, you must have the iam:GetRequestAuthorizationDetails permission.

Parameters:

getRequestAuthorizationDetailsRequest -

Returns:

Result of the GetRequestAuthorizationDetails operation returned by the service.

See Also:

• AWS API Documentation

getRequestAuthorizationDetails

default GetRequestAuthorizationDetailsResponse getRequestAuthorizationDetails(Consumer<GetRequestAuthorizationDetailsRequest.Builder> getRequestAuthorizationDetailsRequest)
                                                                       throws AccessDeniedException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
IamToolboxException

Retrieves the authorization details for a specific access denied request. The details include the request context, the evaluations performed, and the policies that were evaluated.

Use this operation to understand why a request was denied. Supported services include an authorization ID in the access denied error message. Pass that ID to this operation to retrieve the details.

Authorization details are available for at least 24 hours after the denial.

To use this operation, you must have the iam:GetRequestAuthorizationDetails permission.

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

Parameters:

getRequestAuthorizationDetailsRequest - A Consumer that will call methods on GetRequestAuthorizationDetailsRequest.Builder to create a request.

Returns:

Result of the GetRequestAuthorizationDetails operation returned by the service.

See Also:

• AWS API Documentation

getRequestAuthorizationDetailsPaginator

default GetRequestAuthorizationDetailsIterable getRequestAuthorizationDetailsPaginator(GetRequestAuthorizationDetailsRequest getRequestAuthorizationDetailsRequest)
                                                                                throws AccessDeniedException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
IamToolboxException

This is a variant of getRequestAuthorizationDetails(software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsRequest) 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.iamtoolbox.paginators.GetRequestAuthorizationDetailsIterable responses = client.getRequestAuthorizationDetailsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iamtoolbox.paginators.GetRequestAuthorizationDetailsIterable responses = client
             .getRequestAuthorizationDetailsPaginator(request);
     for (software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iamtoolbox.paginators.GetRequestAuthorizationDetailsIterable responses = client.getRequestAuthorizationDetailsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null 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 getRequestAuthorizationDetails(software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsRequest) operation.

Parameters:

getRequestAuthorizationDetailsRequest -

Returns:

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

See Also:

• AWS API Documentation

getRequestAuthorizationDetailsPaginator

default GetRequestAuthorizationDetailsIterable getRequestAuthorizationDetailsPaginator(Consumer<GetRequestAuthorizationDetailsRequest.Builder> getRequestAuthorizationDetailsRequest)
                                                                                throws AccessDeniedException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
IamToolboxException

This is a variant of getRequestAuthorizationDetails(software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsRequest) 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.iamtoolbox.paginators.GetRequestAuthorizationDetailsIterable responses = client.getRequestAuthorizationDetailsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.iamtoolbox.paginators.GetRequestAuthorizationDetailsIterable responses = client
             .getRequestAuthorizationDetailsPaginator(request);
     for (software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.iamtoolbox.paginators.GetRequestAuthorizationDetailsIterable responses = client.getRequestAuthorizationDetailsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null 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 getRequestAuthorizationDetails(software.amazon.awssdk.services.iamtoolbox.model.GetRequestAuthorizationDetailsRequest) operation.

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

Parameters:

getRequestAuthorizationDetailsRequest - A Consumer that will call methods on GetRequestAuthorizationDetailsRequest.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 IamToolboxClient create()

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

builder

static IamToolboxClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default IamToolboxServiceClientConfiguration 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