Package software.amazon.awssdk.services.identitystore

Interface IdentitystoreAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IdentitystoreAsyncClient
extends AwsClient
    Service client for accessing IdentityStore asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

    The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.

    This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.

    IAM Identity Center uses the sso and identitystore API namespaces.

    • Method Detail

      • createGroup

        default CompletableFuture<CreateGroupResponse> createGroup​(CreateGroupRequest createGroupRequest)

        Creates a group within the specified identity store.

        Parameters:
        createGroupRequest -
        Returns:
        A Java Future containing the result of the CreateGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • createGroup

        default CompletableFuture<CreateGroupResponse> createGroup​(Consumer<CreateGroupRequest.Builder> createGroupRequest)

        Creates a group within the specified identity store.


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

        Parameters:
        createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • createGroupMembership

        default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership​(CreateGroupMembershipRequest createGroupMembershipRequest)

        Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

        Parameters:
        createGroupMembershipRequest -
        Returns:
        A Java Future containing the result of the CreateGroupMembership operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • createGroupMembership

        default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership​(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)

        Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.


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

        Parameters:
        createGroupMembershipRequest - A Consumer that will call methods on CreateGroupMembershipRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateGroupMembership operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • createUser

        default CompletableFuture<CreateUserResponse> createUser​(CreateUserRequest createUserRequest)

        Creates a user within the specified identity store.

        Parameters:
        createUserRequest -
        Returns:
        A Java Future containing the result of the CreateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • createUser

        default CompletableFuture<CreateUserResponse> createUser​(Consumer<CreateUserRequest.Builder> createUserRequest)

        Creates a user within the specified identity store.


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

        Parameters:
        createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • deleteGroup

        default CompletableFuture<DeleteGroupResponse> deleteGroup​(DeleteGroupRequest deleteGroupRequest)

        Delete a group within an identity store given GroupId.

        Parameters:
        deleteGroupRequest -
        Returns:
        A Java Future containing the result of the DeleteGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • 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.
        See Also:
        AWS API Documentation

      • deleteGroup

        default CompletableFuture<DeleteGroupResponse> deleteGroup​(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)

        Delete a group within an identity store given GroupId.


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

        Parameters:
        deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • 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.
        See Also:
        AWS API Documentation

      • deleteGroupMembership

        default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership​(DeleteGroupMembershipRequest deleteGroupMembershipRequest)

        Delete a membership within a group given MembershipId.

        Parameters:
        deleteGroupMembershipRequest -
        Returns:
        A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • 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.
        See Also:
        AWS API Documentation

      • deleteGroupMembership

        default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership​(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)

        Delete a membership within a group given MembershipId.


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

        Parameters:
        deleteGroupMembershipRequest - A Consumer that will call methods on DeleteGroupMembershipRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • 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.
        See Also:
        AWS API Documentation

      • deleteUser

        default CompletableFuture<DeleteUserResponse> deleteUser​(DeleteUserRequest deleteUserRequest)

        Deletes a user within an identity store given UserId.

        Parameters:
        deleteUserRequest -
        Returns:
        A Java Future containing the result of the DeleteUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • 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.
        See Also:
        AWS API Documentation

      • deleteUser

        default CompletableFuture<DeleteUserResponse> deleteUser​(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

        Deletes a user within an identity store given UserId.


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

        Parameters:
        deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • 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.
        See Also:
        AWS API Documentation

      • describeGroup

        default CompletableFuture<DescribeGroupResponse> describeGroup​(DescribeGroupRequest describeGroupRequest)

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

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        describeGroupRequest -
        Returns:
        A Java Future containing the result of the DescribeGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • describeGroup

        default CompletableFuture<DescribeGroupResponse> describeGroup​(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)

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

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


        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:
        A Java Future containing the result of the DescribeGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • describeGroupMembership

        default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership​(DescribeGroupMembershipRequest describeGroupMembershipRequest)

        Retrieves membership metadata and attributes from MembershipId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        describeGroupMembershipRequest -
        Returns:
        A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • describeGroupMembership

        default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership​(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)

        Retrieves membership metadata and attributes from MembershipId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        describeGroupMembershipRequest - A Consumer that will call methods on DescribeGroupMembershipRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • describeUser

        default CompletableFuture<DescribeUserResponse> describeUser​(DescribeUserRequest describeUserRequest)

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

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        describeUserRequest -
        Returns:
        A Java Future containing the result of the DescribeUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • describeUser

        default CompletableFuture<DescribeUserResponse> describeUser​(Consumer<DescribeUserRequest.Builder> describeUserRequest)

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

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


        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:
        A Java Future containing the result of the DescribeUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • getGroupId

        default CompletableFuture<GetGroupIdResponse> getGroupId​(GetGroupIdRequest getGroupIdRequest)

        Retrieves GroupId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        getGroupIdRequest -
        Returns:
        A Java Future containing the result of the GetGroupId operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • getGroupId

        default CompletableFuture<GetGroupIdResponse> getGroupId​(Consumer<GetGroupIdRequest.Builder> getGroupIdRequest)

        Retrieves GroupId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        getGroupIdRequest - A Consumer that will call methods on GetGroupIdRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetGroupId operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • getGroupMembershipId

        default CompletableFuture<GetGroupMembershipIdResponse> getGroupMembershipId​(GetGroupMembershipIdRequest getGroupMembershipIdRequest)

        Retrieves the MembershipId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        getGroupMembershipIdRequest -
        Returns:
        A Java Future containing the result of the GetGroupMembershipId operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • getGroupMembershipId

        default CompletableFuture<GetGroupMembershipIdResponse> getGroupMembershipId​(Consumer<GetGroupMembershipIdRequest.Builder> getGroupMembershipIdRequest)

        Retrieves the MembershipId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        getGroupMembershipIdRequest - A Consumer that will call methods on GetGroupMembershipIdRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetGroupMembershipId operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • getUserId

        default CompletableFuture<GetUserIdResponse> getUserId​(GetUserIdRequest getUserIdRequest)

        Retrieves the UserId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        getUserIdRequest -
        Returns:
        A Java Future containing the result of the GetUserId operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • getUserId

        default CompletableFuture<GetUserIdResponse> getUserId​(Consumer<GetUserIdRequest.Builder> getUserIdRequest)

        Retrieves the UserId in an identity store.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        getUserIdRequest - A Consumer that will call methods on GetUserIdRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetUserId operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • isMemberInGroups

        default CompletableFuture<IsMemberInGroupsResponse> isMemberInGroups​(IsMemberInGroupsRequest isMemberInGroupsRequest)

        Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        isMemberInGroupsRequest -
        Returns:
        A Java Future containing the result of the IsMemberInGroups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • isMemberInGroups

        default CompletableFuture<IsMemberInGroupsResponse> isMemberInGroups​(Consumer<IsMemberInGroupsRequest.Builder> isMemberInGroupsRequest)

        Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        isMemberInGroupsRequest - A Consumer that will call methods on IsMemberInGroupsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the IsMemberInGroups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMemberships

        default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships​(ListGroupMembershipsRequest listGroupMembershipsRequest)

        For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        listGroupMembershipsRequest -
        Returns:
        A Java Future containing the result of the ListGroupMemberships operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMemberships

        default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships​(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)

        For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListGroupMemberships operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMembershipsForMember

        default CompletableFuture<ListGroupMembershipsForMemberResponse> listGroupMembershipsForMember​(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)

        For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        listGroupMembershipsForMemberRequest -
        Returns:
        A Java Future containing the result of the ListGroupMembershipsForMember operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMembershipsForMember

        default CompletableFuture<ListGroupMembershipsForMemberResponse> listGroupMembershipsForMember​(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)

        For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


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

        Parameters:
        listGroupMembershipsForMemberRequest - A Consumer that will call methods on ListGroupMembershipsForMemberRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListGroupMembershipsForMember operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMembershipsForMemberPaginator

        default ListGroupMembershipsForMemberPublisher listGroupMembershipsForMemberPaginator​(ListGroupMembershipsForMemberRequest listGroupMembershipsForMemberRequest)

        This is a variant of listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation.

        Parameters:
        listGroupMembershipsForMemberRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMembershipsForMemberPaginator

        default ListGroupMembershipsForMemberPublisher listGroupMembershipsForMemberPaginator​(Consumer<ListGroupMembershipsForMemberRequest.Builder> listGroupMembershipsForMemberRequest)

        This is a variant of listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsForMemberPublisher publisher = client.listGroupMembershipsForMemberPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 listGroupMembershipsForMember(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsForMemberRequest) operation.


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

        Parameters:
        listGroupMembershipsForMemberRequest - A Consumer that will call methods on ListGroupMembershipsForMemberRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMembershipsPaginator

        default ListGroupMembershipsPublisher listGroupMembershipsPaginator​(ListGroupMembershipsRequest listGroupMembershipsRequest)

        This is a variant of listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation.

        Parameters:
        listGroupMembershipsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupMembershipsPaginator

        default ListGroupMembershipsPublisher listGroupMembershipsPaginator​(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)

        This is a variant of listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 listGroupMemberships(software.amazon.awssdk.services.identitystore.model.ListGroupMembershipsRequest) operation.


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

        Parameters:
        listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroups

        default CompletableFuture<ListGroupsResponse> listGroups​(ListGroupsRequest listGroupsRequest)

        Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        listGroupsRequest -
        Returns:
        A Java Future containing the result of the ListGroups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroups

        default CompletableFuture<ListGroupsResponse> listGroups​(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

        Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


        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 Java Future containing the result of the ListGroups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupsPaginator

        default ListGroupsPublisher listGroupsPaginator​(ListGroupsRequest listGroupsRequest)

        This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listGroupsPaginator

        default ListGroupsPublisher listGroupsPaginator​(Consumer<ListGroupsRequest.Builder> listGroupsRequest)

        This is a variant of listGroups(software.amazon.awssdk.services.identitystore.model.ListGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListGroupsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listUsers

        default CompletableFuture<ListUsersResponse> listUsers​(ListUsersRequest listUsersRequest)

        Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

        Parameters:
        listUsersRequest -
        Returns:
        A Java Future containing the result of the ListUsers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listUsers

        default CompletableFuture<ListUsersResponse> listUsers​(Consumer<ListUsersRequest.Builder> listUsersRequest)

        Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

        If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.


        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 Java Future containing the result of the ListUsers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listUsersPaginator

        default ListUsersPublisher listUsersPaginator​(ListUsersRequest listUsersRequest)

        This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListUsersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • listUsersPaginator

        default ListUsersPublisher listUsersPaginator​(Consumer<ListUsersRequest.Builder> listUsersRequest)

        This is a variant of listUsers(software.amazon.awssdk.services.identitystore.model.ListUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.identitystore.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.identitystore.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.identitystore.model.ListUsersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
        • ValidationException The request failed because it contains a syntax error.
        • 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.
        See Also:
        AWS API Documentation

      • updateGroup

        default CompletableFuture<UpdateGroupResponse> updateGroup​(UpdateGroupRequest updateGroupRequest)

        For the specified group in the specified identity store, updates the group metadata and attributes.

        Parameters:
        updateGroupRequest -
        Returns:
        A Java Future containing the result of the UpdateGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • updateGroup

        default CompletableFuture<UpdateGroupResponse> updateGroup​(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)

        For the specified group in the specified identity store, updates the group metadata and attributes.


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

        Parameters:
        updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the UpdateGroup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • updateUser

        default CompletableFuture<UpdateUserResponse> updateUser​(UpdateUserRequest updateUserRequest)

        For the specified user in the specified identity store, updates the user metadata and attributes.

        Parameters:
        updateUserRequest -
        Returns:
        A Java Future containing the result of the UpdateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation

      • updateUser

        default CompletableFuture<UpdateUserResponse> updateUser​(Consumer<UpdateUserRequest.Builder> updateUserRequest)

        For the specified user in the specified identity store, updates the user metadata and attributes.


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

        Parameters:
        updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the UpdateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException Indicates that a requested resource is not found.
        • ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ConflictException This request cannot be completed for one of the following reasons:

          • Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.

          • The requested resource was being concurrently modified by another request.

          • InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
          • ValidationException The request failed because it contains a syntax error.
          • ServiceQuotaExceededException The request would cause the number of users or groups in the identity store to exceed the maximum allowed.
          • 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.
        See Also:
        AWS API Documentation