software.amazon.awssdk.services.identitystore

Interface IdentitystoreClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface IdentitystoreClient
extends SdkClient

Service client for accessing IdentityStore. This can be created using the static builder() method. null

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static IdentitystoreClientBuilder	builder() Create a builder that can be used to configure and create a IdentitystoreClient.
static IdentitystoreClient	create() Create a IdentitystoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DescribeGroupResponse	describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Retrieves the group metadata and attributes from GroupId in an identity store.
default DescribeGroupResponse	describeGroup(DescribeGroupRequest describeGroupRequest) Retrieves the group metadata and attributes from GroupId in an identity store.
default DescribeUserResponse	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Retrieves the user metadata and attributes from UserId in an identity store.
default DescribeUserResponse	describeUser(DescribeUserRequest describeUserRequest) Retrieves the user metadata and attributes from UserId in an identity store.
default ListGroupsResponse	listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists the attribute name and value of the group that you specified in the search.
default ListGroupsResponse	listGroups(ListGroupsRequest listGroupsRequest) Lists the attribute name and value of the group that you specified in the search.
default ListGroupsIterable	listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists the attribute name and value of the group that you specified in the search.
default ListGroupsIterable	listGroupsPaginator(ListGroupsRequest listGroupsRequest) Lists the attribute name and value of the group that you specified in the search.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the attribute name and value of the user that you specified in the search.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest) Lists the attribute name and value of the user that you specified in the search.
default ListUsersIterable	listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists the attribute name and value of the user that you specified in the search.
default ListUsersIterable	listUsersPaginator(ListUsersRequest listUsersRequest) Lists the attribute name and value of the user that you specified in the search.
static ServiceMetadata	serviceMetadata()

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

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static IdentitystoreClient create()

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

builder

static IdentitystoreClientBuilder builder()

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

describeGroup

default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest)
                                     throws ResourceNotFoundException,
                                            ValidationException,
                                            AccessDeniedException,
                                            ThrottlingException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            IdentitystoreException

Retrieves the group metadata and attributes from GroupId in an identity store.

Parameters:

describeGroupRequest -

Returns:

Result of the DescribeGroup operation returned by the service.

Throws:

ResourceNotFoundException - Indicates that a requested resource is not found.

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
                                     throws ResourceNotFoundException,
                                            ValidationException,
                                            AccessDeniedException,
                                            ThrottlingException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            IdentitystoreException

Retrieves the group metadata and attributes from GroupId in an identity store.

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

Parameters:

describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.

Returns:

Result of the DescribeGroup operation returned by the service.

Throws:

ResourceNotFoundException - Indicates that a requested resource is not found.

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUser

default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest)
                                   throws ResourceNotFoundException,
                                          ValidationException,
                                          AccessDeniedException,
                                          ThrottlingException,
                                          InternalServerException,
                                          AwsServiceException,
                                          SdkClientException,
                                          IdentitystoreException

Retrieves the user metadata and attributes from UserId in an identity store.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

ResourceNotFoundException - Indicates that a requested resource is not found.

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

describeUser

default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
                                   throws ResourceNotFoundException,
                                          ValidationException,
                                          AccessDeniedException,
                                          ThrottlingException,
                                          InternalServerException,
                                          AwsServiceException,
                                          SdkClientException,
                                          IdentitystoreException

Retrieves the user metadata and attributes from UserId in an identity store.

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

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

Result of the DescribeUser operation returned by the service.

Throws:

ResourceNotFoundException - Indicates that a requested resource is not found.

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listGroups

default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest)
                               throws ValidationException,
                                      AccessDeniedException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServerException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IdentitystoreException

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

Parameters:

listGroupsRequest -

Returns:

Result of the ListGroups operation returned by the service.

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listGroups

default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                               throws ValidationException,
                                      AccessDeniedException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InternalServerException,
                                      AwsServiceException,
                                      SdkClientException,
                                      IdentitystoreException

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

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

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

Result of the ListGroups operation returned by the service.

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listGroupsPaginator

default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest)
                                        throws ValidationException,
                                               AccessDeniedException,
                                               ResourceNotFoundException,
                                               ThrottlingException,
                                               InternalServerException,
                                               AwsServiceException,
                                               SdkClientException,
                                               IdentitystoreException

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) 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.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(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 listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.

Parameters:

listGroupsRequest -

Returns:

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

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listGroupsPaginator

default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                                        throws ValidationException,
                                               AccessDeniedException,
                                               ResourceNotFoundException,
                                               ThrottlingException,
                                               InternalServerException,
                                               AwsServiceException,
                                               SdkClientException,
                                               IdentitystoreException

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) 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.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsIterable responses = client.listGroupsPaginator(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 listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation.

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

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

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

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws ValidationException,
                                    AccessDeniedException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InternalServerException,
                                    AwsServiceException,
                                    SdkClientException,
                                    IdentitystoreException

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws ValidationException,
                                    AccessDeniedException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InternalServerException,
                                    AwsServiceException,
                                    SdkClientException,
                                    IdentitystoreException

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

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

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

Result of the ListUsers operation returned by the service.

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest)
                                      throws ValidationException,
                                             AccessDeniedException,
                                             ResourceNotFoundException,
                                             ThrottlingException,
                                             InternalServerException,
                                             AwsServiceException,
                                             SdkClientException,
                                             IdentitystoreException

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) 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.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(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 listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.

Parameters:

listUsersRequest -

Returns:

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

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
                                      throws ValidationException,
                                             AccessDeniedException,
                                             ResourceNotFoundException,
                                             ThrottlingException,
                                             InternalServerException,
                                             AwsServiceException,
                                             SdkClientException,
                                             IdentitystoreException

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) 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.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.identitystore.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.identitystore.paginators.ListUsersIterable responses = client.listUsersPaginator(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 listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation.

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

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

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

Throws:

ValidationException - The request failed because it contains a syntax error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - Indicates that a requested resource is not found.

ThrottlingException - Indicates that the principal has crossed the throttling limits of the API operations.

InternalServerException - The request processing has failed because of an unknown error, exception or failure with an internal server.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

IdentitystoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()