Package software.amazon.awssdk.services.amplifybackend

Interface AmplifyBackendAsyncClient

    • Method Detail

      • cloneBackend

        default CompletableFuture<CloneBackendResponse> cloneBackend​(CloneBackendRequest cloneBackendRequest)

        This operation clones an existing backend.

        Parameters:
        cloneBackendRequest - The request body for CloneBackend.
        Returns:
        A Java Future containing the result of the CloneBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • cloneBackend

        default CompletableFuture<CloneBackendResponse> cloneBackend​(Consumer<CloneBackendRequest.Builder> cloneBackendRequest)

        This operation clones an existing backend.


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

        Parameters:
        cloneBackendRequest - A Consumer that will call methods on CloneBackendRequest.Builder to create a request. The request body for CloneBackend.
        Returns:
        A Java Future containing the result of the CloneBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackend

        default CompletableFuture<CreateBackendResponse> createBackend​(CreateBackendRequest createBackendRequest)

        This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

        Parameters:
        createBackendRequest - The request body for CreateBackend.
        Returns:
        A Java Future containing the result of the CreateBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackend

        default CompletableFuture<CreateBackendResponse> createBackend​(Consumer<CreateBackendRequest.Builder> createBackendRequest)

        This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.


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

        Parameters:
        createBackendRequest - A Consumer that will call methods on CreateBackendRequest.Builder to create a request. The request body for CreateBackend.
        Returns:
        A Java Future containing the result of the CreateBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendAPI

        default CompletableFuture<CreateBackendApiResponse> createBackendAPI​(CreateBackendApiRequest createBackendApiRequest)

        Creates a new backend API resource.

        Parameters:
        createBackendApiRequest - The request body for CreateBackendAPI.
        Returns:
        A Java Future containing the result of the CreateBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendAPI

        default CompletableFuture<CreateBackendApiResponse> createBackendAPI​(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest)

        Creates a new backend API resource.


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

        Parameters:
        createBackendApiRequest - A Consumer that will call methods on CreateBackendApiRequest.Builder to create a request. The request body for CreateBackendAPI.
        Returns:
        A Java Future containing the result of the CreateBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendAuth

        default CompletableFuture<CreateBackendAuthResponse> createBackendAuth​(CreateBackendAuthRequest createBackendAuthRequest)

        Creates a new backend authentication resource.

        Parameters:
        createBackendAuthRequest - The request body for CreateBackendAuth.
        Returns:
        A Java Future containing the result of the CreateBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendAuth

        default CompletableFuture<CreateBackendAuthResponse> createBackendAuth​(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest)

        Creates a new backend authentication resource.


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

        Parameters:
        createBackendAuthRequest - A Consumer that will call methods on CreateBackendAuthRequest.Builder to create a request. The request body for CreateBackendAuth.
        Returns:
        A Java Future containing the result of the CreateBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendConfig

        default CompletableFuture<CreateBackendConfigResponse> createBackendConfig​(CreateBackendConfigRequest createBackendConfigRequest)

        Creates a config object for a backend.

        Parameters:
        createBackendConfigRequest - The request body for CreateBackendConfig.
        Returns:
        A Java Future containing the result of the CreateBackendConfig operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendConfig

        default CompletableFuture<CreateBackendConfigResponse> createBackendConfig​(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest)

        Creates a config object for a backend.


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

        Parameters:
        createBackendConfigRequest - A Consumer that will call methods on CreateBackendConfigRequest.Builder to create a request. The request body for CreateBackendConfig.
        Returns:
        A Java Future containing the result of the CreateBackendConfig operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendStorage

        default CompletableFuture<CreateBackendStorageResponse> createBackendStorage​(CreateBackendStorageRequest createBackendStorageRequest)

        Creates a backend storage resource.

        Parameters:
        createBackendStorageRequest - The request body for CreateBackendStorage.
        Returns:
        A Java Future containing the result of the CreateBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBackendStorage

        default CompletableFuture<CreateBackendStorageResponse> createBackendStorage​(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest)

        Creates a backend storage resource.


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

        Parameters:
        createBackendStorageRequest - A Consumer that will call methods on CreateBackendStorageRequest.Builder to create a request. The request body for CreateBackendStorage.
        Returns:
        A Java Future containing the result of the CreateBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createToken

        default CompletableFuture<CreateTokenResponse> createToken​(CreateTokenRequest createTokenRequest)

        Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

        Parameters:
        createTokenRequest -
        Returns:
        A Java Future containing the result of the CreateToken operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createToken

        default CompletableFuture<CreateTokenResponse> createToken​(Consumer<CreateTokenRequest.Builder> createTokenRequest)

        Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.


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

        Parameters:
        createTokenRequest - A Consumer that will call methods on CreateTokenRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateToken operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackend

        default CompletableFuture<DeleteBackendResponse> deleteBackend​(DeleteBackendRequest deleteBackendRequest)

        Removes an existing environment from your Amplify project.

        Parameters:
        deleteBackendRequest -
        Returns:
        A Java Future containing the result of the DeleteBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackend

        default CompletableFuture<DeleteBackendResponse> deleteBackend​(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest)

        Removes an existing environment from your Amplify project.


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

        Parameters:
        deleteBackendRequest - A Consumer that will call methods on DeleteBackendRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackendAPI

        default CompletableFuture<DeleteBackendApiResponse> deleteBackendAPI​(DeleteBackendApiRequest deleteBackendApiRequest)

        Deletes an existing backend API resource.

        Parameters:
        deleteBackendApiRequest - The request body for DeleteBackendAPI.
        Returns:
        A Java Future containing the result of the DeleteBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackendAPI

        default CompletableFuture<DeleteBackendApiResponse> deleteBackendAPI​(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest)

        Deletes an existing backend API resource.


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

        Parameters:
        deleteBackendApiRequest - A Consumer that will call methods on DeleteBackendApiRequest.Builder to create a request. The request body for DeleteBackendAPI.
        Returns:
        A Java Future containing the result of the DeleteBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackendAuth

        default CompletableFuture<DeleteBackendAuthResponse> deleteBackendAuth​(DeleteBackendAuthRequest deleteBackendAuthRequest)

        Deletes an existing backend authentication resource.

        Parameters:
        deleteBackendAuthRequest - The request body for DeleteBackendAuth.
        Returns:
        A Java Future containing the result of the DeleteBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackendAuth

        default CompletableFuture<DeleteBackendAuthResponse> deleteBackendAuth​(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest)

        Deletes an existing backend authentication resource.


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

        Parameters:
        deleteBackendAuthRequest - A Consumer that will call methods on DeleteBackendAuthRequest.Builder to create a request. The request body for DeleteBackendAuth.
        Returns:
        A Java Future containing the result of the DeleteBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackendStorage

        default CompletableFuture<DeleteBackendStorageResponse> deleteBackendStorage​(DeleteBackendStorageRequest deleteBackendStorageRequest)

        Removes the specified backend storage resource.

        Parameters:
        deleteBackendStorageRequest - The request body for DeleteBackendStorage.
        Returns:
        A Java Future containing the result of the DeleteBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackendStorage

        default CompletableFuture<DeleteBackendStorageResponse> deleteBackendStorage​(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest)

        Removes the specified backend storage resource.


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

        Parameters:
        deleteBackendStorageRequest - A Consumer that will call methods on DeleteBackendStorageRequest.Builder to create a request. The request body for DeleteBackendStorage.
        Returns:
        A Java Future containing the result of the DeleteBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteToken

        default CompletableFuture<DeleteTokenResponse> deleteToken​(DeleteTokenRequest deleteTokenRequest)

        Deletes the challenge token based on the given appId and sessionId.

        Parameters:
        deleteTokenRequest -
        Returns:
        A Java Future containing the result of the DeleteToken operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteToken

        default CompletableFuture<DeleteTokenResponse> deleteToken​(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest)

        Deletes the challenge token based on the given appId and sessionId.


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

        Parameters:
        deleteTokenRequest - A Consumer that will call methods on DeleteTokenRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteToken operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • generateBackendAPIModels

        default CompletableFuture<GenerateBackendApiModelsResponse> generateBackendAPIModels​(GenerateBackendApiModelsRequest generateBackendApiModelsRequest)

        Generates a model schema for an existing backend API resource.

        Parameters:
        generateBackendApiModelsRequest - The request body for GenerateBackendAPIModels.
        Returns:
        A Java Future containing the result of the GenerateBackendAPIModels operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • generateBackendAPIModels

        default CompletableFuture<GenerateBackendApiModelsResponse> generateBackendAPIModels​(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest)

        Generates a model schema for an existing backend API resource.


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

        Parameters:
        generateBackendApiModelsRequest - A Consumer that will call methods on GenerateBackendApiModelsRequest.Builder to create a request. The request body for GenerateBackendAPIModels.
        Returns:
        A Java Future containing the result of the GenerateBackendAPIModels operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackend

        default CompletableFuture<GetBackendResponse> getBackend​(GetBackendRequest getBackendRequest)

        Provides project-level details for your Amplify UI project.

        Parameters:
        getBackendRequest - The request body for GetBackend.
        Returns:
        A Java Future containing the result of the GetBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackend

        default CompletableFuture<GetBackendResponse> getBackend​(Consumer<GetBackendRequest.Builder> getBackendRequest)

        Provides project-level details for your Amplify UI project.


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

        Parameters:
        getBackendRequest - A Consumer that will call methods on GetBackendRequest.Builder to create a request. The request body for GetBackend.
        Returns:
        A Java Future containing the result of the GetBackend operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendAPI

        default CompletableFuture<GetBackendApiResponse> getBackendAPI​(GetBackendApiRequest getBackendApiRequest)

        Gets the details for a backend API.

        Parameters:
        getBackendApiRequest - The request body for GetBackendAPI.
        Returns:
        A Java Future containing the result of the GetBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendAPI

        default CompletableFuture<GetBackendApiResponse> getBackendAPI​(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest)

        Gets the details for a backend API.


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

        Parameters:
        getBackendApiRequest - A Consumer that will call methods on GetBackendApiRequest.Builder to create a request. The request body for GetBackendAPI.
        Returns:
        A Java Future containing the result of the GetBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendAPIModels

        default CompletableFuture<GetBackendApiModelsResponse> getBackendAPIModels​(GetBackendApiModelsRequest getBackendApiModelsRequest)

        Gets a model introspection schema for an existing backend API resource.

        Parameters:
        getBackendApiModelsRequest - The request body for GetBackendAPIModels.
        Returns:
        A Java Future containing the result of the GetBackendAPIModels operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendAPIModels

        default CompletableFuture<GetBackendApiModelsResponse> getBackendAPIModels​(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest)

        Gets a model introspection schema for an existing backend API resource.


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

        Parameters:
        getBackendApiModelsRequest - A Consumer that will call methods on GetBackendApiModelsRequest.Builder to create a request. The request body for GetBackendAPIModels.
        Returns:
        A Java Future containing the result of the GetBackendAPIModels operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendAuth

        default CompletableFuture<GetBackendAuthResponse> getBackendAuth​(GetBackendAuthRequest getBackendAuthRequest)

        Gets a backend auth details.

        Parameters:
        getBackendAuthRequest - The request body for GetBackendAuth.
        Returns:
        A Java Future containing the result of the GetBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendAuth

        default CompletableFuture<GetBackendAuthResponse> getBackendAuth​(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest)

        Gets a backend auth details.


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

        Parameters:
        getBackendAuthRequest - A Consumer that will call methods on GetBackendAuthRequest.Builder to create a request. The request body for GetBackendAuth.
        Returns:
        A Java Future containing the result of the GetBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendJob

        default CompletableFuture<GetBackendJobResponse> getBackendJob​(GetBackendJobRequest getBackendJobRequest)

        Returns information about a specific job.

        Parameters:
        getBackendJobRequest -
        Returns:
        A Java Future containing the result of the GetBackendJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendJob

        default CompletableFuture<GetBackendJobResponse> getBackendJob​(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest)

        Returns information about a specific job.


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

        Parameters:
        getBackendJobRequest - A Consumer that will call methods on GetBackendJobRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetBackendJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendStorage

        default CompletableFuture<GetBackendStorageResponse> getBackendStorage​(GetBackendStorageRequest getBackendStorageRequest)

        Gets details for a backend storage resource.

        Parameters:
        getBackendStorageRequest - The request body for GetBackendStorage.
        Returns:
        A Java Future containing the result of the GetBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getBackendStorage

        default CompletableFuture<GetBackendStorageResponse> getBackendStorage​(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest)

        Gets details for a backend storage resource.


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

        Parameters:
        getBackendStorageRequest - A Consumer that will call methods on GetBackendStorageRequest.Builder to create a request. The request body for GetBackendStorage.
        Returns:
        A Java Future containing the result of the GetBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getToken

        default CompletableFuture<GetTokenResponse> getToken​(GetTokenRequest getTokenRequest)

        Gets the challenge token based on the given appId and sessionId.

        Parameters:
        getTokenRequest -
        Returns:
        A Java Future containing the result of the GetToken operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getToken

        default CompletableFuture<GetTokenResponse> getToken​(Consumer<GetTokenRequest.Builder> getTokenRequest)

        Gets the challenge token based on the given appId and sessionId.


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

        Parameters:
        getTokenRequest - A Consumer that will call methods on GetTokenRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetToken operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • importBackendAuth

        default CompletableFuture<ImportBackendAuthResponse> importBackendAuth​(ImportBackendAuthRequest importBackendAuthRequest)

        Imports an existing backend authentication resource.

        Parameters:
        importBackendAuthRequest - The request body for ImportBackendAuth.
        Returns:
        A Java Future containing the result of the ImportBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • importBackendAuth

        default CompletableFuture<ImportBackendAuthResponse> importBackendAuth​(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest)

        Imports an existing backend authentication resource.


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

        Parameters:
        importBackendAuthRequest - A Consumer that will call methods on ImportBackendAuthRequest.Builder to create a request. The request body for ImportBackendAuth.
        Returns:
        A Java Future containing the result of the ImportBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • importBackendStorage

        default CompletableFuture<ImportBackendStorageResponse> importBackendStorage​(ImportBackendStorageRequest importBackendStorageRequest)

        Imports an existing backend storage resource.

        Parameters:
        importBackendStorageRequest - The request body for ImportBackendStorage.
        Returns:
        A Java Future containing the result of the ImportBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • importBackendStorage

        default CompletableFuture<ImportBackendStorageResponse> importBackendStorage​(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest)

        Imports an existing backend storage resource.


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

        Parameters:
        importBackendStorageRequest - A Consumer that will call methods on ImportBackendStorageRequest.Builder to create a request. The request body for ImportBackendStorage.
        Returns:
        A Java Future containing the result of the ImportBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBackendJobs

        default CompletableFuture<ListBackendJobsResponse> listBackendJobs​(ListBackendJobsRequest listBackendJobsRequest)

        Lists the jobs for the backend of an Amplify app.

        Parameters:
        listBackendJobsRequest - The request body for ListBackendJobs.
        Returns:
        A Java Future containing the result of the ListBackendJobs operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBackendJobs

        default CompletableFuture<ListBackendJobsResponse> listBackendJobs​(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)

        Lists the jobs for the backend of an Amplify app.


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

        Parameters:
        listBackendJobsRequest - A Consumer that will call methods on ListBackendJobsRequest.Builder to create a request. The request body for ListBackendJobs.
        Returns:
        A Java Future containing the result of the ListBackendJobs operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBackendJobsPaginator

        default ListBackendJobsPublisher listBackendJobsPaginator​(ListBackendJobsRequest listBackendJobsRequest)

        This is a variant of listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) 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.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse 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 listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.

        Parameters:
        listBackendJobsRequest - The request body for ListBackendJobs.
        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.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBackendJobsPaginator

        default ListBackendJobsPublisher listBackendJobsPaginator​(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)

        This is a variant of listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) 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.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse 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 listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.


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

        Parameters:
        listBackendJobsRequest - A Consumer that will call methods on ListBackendJobsRequest.Builder to create a request. The request body for ListBackendJobs.
        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.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listS3Buckets

        default CompletableFuture<ListS3BucketsResponse> listS3Buckets​(ListS3BucketsRequest listS3BucketsRequest)

        The list of S3 buckets in your account.

        Parameters:
        listS3BucketsRequest - The request body for S3Buckets.
        Returns:
        A Java Future containing the result of the ListS3Buckets operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listS3Buckets

        default CompletableFuture<ListS3BucketsResponse> listS3Buckets​(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest)

        The list of S3 buckets in your account.


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

        Parameters:
        listS3BucketsRequest - A Consumer that will call methods on ListS3BucketsRequest.Builder to create a request. The request body for S3Buckets.
        Returns:
        A Java Future containing the result of the ListS3Buckets operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • removeAllBackends

        default CompletableFuture<RemoveAllBackendsResponse> removeAllBackends​(RemoveAllBackendsRequest removeAllBackendsRequest)

        Removes all backend environments from your Amplify project.

        Parameters:
        removeAllBackendsRequest - The request body for RemoveAllBackends.
        Returns:
        A Java Future containing the result of the RemoveAllBackends operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • removeAllBackends

        default CompletableFuture<RemoveAllBackendsResponse> removeAllBackends​(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest)

        Removes all backend environments from your Amplify project.


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

        Parameters:
        removeAllBackendsRequest - A Consumer that will call methods on RemoveAllBackendsRequest.Builder to create a request. The request body for RemoveAllBackends.
        Returns:
        A Java Future containing the result of the RemoveAllBackends operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • removeBackendConfig

        default CompletableFuture<RemoveBackendConfigResponse> removeBackendConfig​(RemoveBackendConfigRequest removeBackendConfigRequest)

        Removes the AWS resources required to access the Amplify Admin UI.

        Parameters:
        removeBackendConfigRequest -
        Returns:
        A Java Future containing the result of the RemoveBackendConfig operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • removeBackendConfig

        default CompletableFuture<RemoveBackendConfigResponse> removeBackendConfig​(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest)

        Removes the AWS resources required to access the Amplify Admin UI.


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

        Parameters:
        removeBackendConfigRequest - A Consumer that will call methods on RemoveBackendConfigRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the RemoveBackendConfig operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendAPI

        default CompletableFuture<UpdateBackendApiResponse> updateBackendAPI​(UpdateBackendApiRequest updateBackendApiRequest)

        Updates an existing backend API resource.

        Parameters:
        updateBackendApiRequest - The request body for UpdateBackendAPI.
        Returns:
        A Java Future containing the result of the UpdateBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendAPI

        default CompletableFuture<UpdateBackendApiResponse> updateBackendAPI​(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest)

        Updates an existing backend API resource.


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

        Parameters:
        updateBackendApiRequest - A Consumer that will call methods on UpdateBackendApiRequest.Builder to create a request. The request body for UpdateBackendAPI.
        Returns:
        A Java Future containing the result of the UpdateBackendAPI operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendAuth

        default CompletableFuture<UpdateBackendAuthResponse> updateBackendAuth​(UpdateBackendAuthRequest updateBackendAuthRequest)

        Updates an existing backend authentication resource.

        Parameters:
        updateBackendAuthRequest - The request body for UpdateBackendAuth.
        Returns:
        A Java Future containing the result of the UpdateBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendAuth

        default CompletableFuture<UpdateBackendAuthResponse> updateBackendAuth​(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest)

        Updates an existing backend authentication resource.


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

        Parameters:
        updateBackendAuthRequest - A Consumer that will call methods on UpdateBackendAuthRequest.Builder to create a request. The request body for UpdateBackendAuth.
        Returns:
        A Java Future containing the result of the UpdateBackendAuth operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendConfig

        default CompletableFuture<UpdateBackendConfigResponse> updateBackendConfig​(UpdateBackendConfigRequest updateBackendConfigRequest)

        Updates the AWS resources required to access the Amplify Admin UI.

        Parameters:
        updateBackendConfigRequest - The request body for UpdateBackendConfig.
        Returns:
        A Java Future containing the result of the UpdateBackendConfig operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendConfig

        default CompletableFuture<UpdateBackendConfigResponse> updateBackendConfig​(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest)

        Updates the AWS resources required to access the Amplify Admin UI.


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

        Parameters:
        updateBackendConfigRequest - A Consumer that will call methods on UpdateBackendConfigRequest.Builder to create a request. The request body for UpdateBackendConfig.
        Returns:
        A Java Future containing the result of the UpdateBackendConfig operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendJob

        default CompletableFuture<UpdateBackendJobResponse> updateBackendJob​(UpdateBackendJobRequest updateBackendJobRequest)

        Updates a specific job.

        Parameters:
        updateBackendJobRequest - The request body for GetBackendJob.
        Returns:
        A Java Future containing the result of the UpdateBackendJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendJob

        default CompletableFuture<UpdateBackendJobResponse> updateBackendJob​(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest)

        Updates a specific job.


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

        Parameters:
        updateBackendJobRequest - A Consumer that will call methods on UpdateBackendJobRequest.Builder to create a request. The request body for GetBackendJob.
        Returns:
        A Java Future containing the result of the UpdateBackendJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendStorage

        default CompletableFuture<UpdateBackendStorageResponse> updateBackendStorage​(UpdateBackendStorageRequest updateBackendStorageRequest)

        Updates an existing backend storage resource.

        Parameters:
        updateBackendStorageRequest - The request body for UpdateBackendStorage.
        Returns:
        A Java Future containing the result of the UpdateBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBackendStorage

        default CompletableFuture<UpdateBackendStorageResponse> updateBackendStorage​(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest)

        Updates an existing backend storage resource.


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

        Parameters:
        updateBackendStorageRequest - A Consumer that will call methods on UpdateBackendStorageRequest.Builder to create a request. The request body for UpdateBackendStorage.
        Returns:
        A Java Future containing the result of the UpdateBackendStorage operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • NotFoundException 404 response
        • GatewayTimeoutException 504 response
        • TooManyRequestsException 429 response
        • BadRequestException 400 response
        • 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.
        • AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation