com.amazonaws.services.amplify.AWSAmplifyAsync Maven / Gradle / Ivy
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.amplify;
import javax.annotation.Generated;
import com.amazonaws.services.amplify.model.*;
/**
* Interface for accessing Amplify asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.amplify.AbstractAWSAmplifyAsync} instead.
*
*
*
* Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a
* continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify
* Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more
* information, see the Amplify Framework.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplifyAsync extends AWSAmplify {
/**
*
* Creates a new Amplify app.
*
*
* @param createAppRequest
* The request structure used to create apps in Amplify.
* @return A Java Future containing the result of the CreateApp operation returned by the service.
* @sample AWSAmplifyAsync.CreateApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createAppAsync(CreateAppRequest createAppRequest);
/**
*
* Creates a new Amplify app.
*
*
* @param createAppRequest
* The request structure used to create apps in Amplify.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateApp operation returned by the service.
* @sample AWSAmplifyAsyncHandler.CreateApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createAppAsync(CreateAppRequest createAppRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new backend environment for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param createBackendEnvironmentRequest
* The request structure for the backend environment create request.
* @return A Java Future containing the result of the CreateBackendEnvironment operation returned by the service.
* @sample AWSAmplifyAsync.CreateBackendEnvironment
* @see AWS API Documentation
*/
java.util.concurrent.Future createBackendEnvironmentAsync(CreateBackendEnvironmentRequest createBackendEnvironmentRequest);
/**
*
* Creates a new backend environment for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param createBackendEnvironmentRequest
* The request structure for the backend environment create request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateBackendEnvironment operation returned by the service.
* @sample AWSAmplifyAsyncHandler.CreateBackendEnvironment
* @see AWS API Documentation
*/
java.util.concurrent.Future createBackendEnvironmentAsync(CreateBackendEnvironmentRequest createBackendEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new branch for an Amplify app.
*
*
* @param createBranchRequest
* The request structure for the create branch request.
* @return A Java Future containing the result of the CreateBranch operation returned by the service.
* @sample AWSAmplifyAsync.CreateBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createBranchAsync(CreateBranchRequest createBranchRequest);
/**
*
* Creates a new branch for an Amplify app.
*
*
* @param createBranchRequest
* The request structure for the create branch request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateBranch operation returned by the service.
* @sample AWSAmplifyAsyncHandler.CreateBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createBranchAsync(CreateBranchRequest createBranchRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a
* repository.
*
*
* The maximum duration between the CreateDeployment call and the StartDeployment call
* cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated
* Job will fail.
*
*
* @param createDeploymentRequest
* The request structure for the create a new deployment request.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* @sample AWSAmplifyAsync.CreateDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest);
/**
*
* Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a
* repository.
*
*
* The maximum duration between the CreateDeployment call and the StartDeployment call
* cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated
* Job will fail.
*
*
* @param createDeploymentRequest
* The request structure for the create a new deployment request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateDeployment operation returned by the service.
* @sample AWSAmplifyAsyncHandler.CreateDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
*
*
* @param createDomainAssociationRequest
* The request structure for the create domain association request.
* @return A Java Future containing the result of the CreateDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsync.CreateDomainAssociation
* @see AWS API Documentation
*/
java.util.concurrent.Future createDomainAssociationAsync(CreateDomainAssociationRequest createDomainAssociationRequest);
/**
*
* Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
*
*
* @param createDomainAssociationRequest
* The request structure for the create domain association request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsyncHandler.CreateDomainAssociation
* @see AWS API Documentation
*/
java.util.concurrent.Future createDomainAssociationAsync(CreateDomainAssociationRequest createDomainAssociationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new webhook on an Amplify app.
*
*
* @param createWebhookRequest
* The request structure for the create webhook request.
* @return A Java Future containing the result of the CreateWebhook operation returned by the service.
* @sample AWSAmplifyAsync.CreateWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createWebhookAsync(CreateWebhookRequest createWebhookRequest);
/**
*
* Creates a new webhook on an Amplify app.
*
*
* @param createWebhookRequest
* The request structure for the create webhook request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateWebhook operation returned by the service.
* @sample AWSAmplifyAsyncHandler.CreateWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createWebhookAsync(CreateWebhookRequest createWebhookRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an existing Amplify app specified by an app ID.
*
*
* @param deleteAppRequest
* Describes the request structure for the delete app request.
* @return A Java Future containing the result of the DeleteApp operation returned by the service.
* @sample AWSAmplifyAsync.DeleteApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteAppAsync(DeleteAppRequest deleteAppRequest);
/**
*
* Deletes an existing Amplify app specified by an app ID.
*
*
* @param deleteAppRequest
* Describes the request structure for the delete app request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteApp operation returned by the service.
* @sample AWSAmplifyAsyncHandler.DeleteApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteAppAsync(DeleteAppRequest deleteAppRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a backend environment for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param deleteBackendEnvironmentRequest
* The request structure for the delete backend environment request.
* @return A Java Future containing the result of the DeleteBackendEnvironment operation returned by the service.
* @sample AWSAmplifyAsync.DeleteBackendEnvironment
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteBackendEnvironmentAsync(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest);
/**
*
* Deletes a backend environment for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param deleteBackendEnvironmentRequest
* The request structure for the delete backend environment request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteBackendEnvironment operation returned by the service.
* @sample AWSAmplifyAsyncHandler.DeleteBackendEnvironment
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteBackendEnvironmentAsync(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a branch for an Amplify app.
*
*
* @param deleteBranchRequest
* The request structure for the delete branch request.
* @return A Java Future containing the result of the DeleteBranch operation returned by the service.
* @sample AWSAmplifyAsync.DeleteBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteBranchAsync(DeleteBranchRequest deleteBranchRequest);
/**
*
* Deletes a branch for an Amplify app.
*
*
* @param deleteBranchRequest
* The request structure for the delete branch request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteBranch operation returned by the service.
* @sample AWSAmplifyAsyncHandler.DeleteBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteBranchAsync(DeleteBranchRequest deleteBranchRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a domain association for an Amplify app.
*
*
* @param deleteDomainAssociationRequest
* The request structure for the delete domain association request.
* @return A Java Future containing the result of the DeleteDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsync.DeleteDomainAssociation
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteDomainAssociationAsync(DeleteDomainAssociationRequest deleteDomainAssociationRequest);
/**
*
* Deletes a domain association for an Amplify app.
*
*
* @param deleteDomainAssociationRequest
* The request structure for the delete domain association request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsyncHandler.DeleteDomainAssociation
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteDomainAssociationAsync(DeleteDomainAssociationRequest deleteDomainAssociationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a job for a branch of an Amplify app.
*
*
* @param deleteJobRequest
* The request structure for the delete job request.
* @return A Java Future containing the result of the DeleteJob operation returned by the service.
* @sample AWSAmplifyAsync.DeleteJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteJobAsync(DeleteJobRequest deleteJobRequest);
/**
*
* Deletes a job for a branch of an Amplify app.
*
*
* @param deleteJobRequest
* The request structure for the delete job request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteJob operation returned by the service.
* @sample AWSAmplifyAsyncHandler.DeleteJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteJobAsync(DeleteJobRequest deleteJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a webhook.
*
*
* @param deleteWebhookRequest
* The request structure for the delete webhook request.
* @return A Java Future containing the result of the DeleteWebhook operation returned by the service.
* @sample AWSAmplifyAsync.DeleteWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest);
/**
*
* Deletes a webhook.
*
*
* @param deleteWebhookRequest
* The request structure for the delete webhook request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteWebhook operation returned by the service.
* @sample AWSAmplifyAsyncHandler.DeleteWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteWebhookAsync(DeleteWebhookRequest deleteWebhookRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the website access logs for a specific time range using a presigned URL.
*
*
* @param generateAccessLogsRequest
* The request structure for the generate access logs request.
* @return A Java Future containing the result of the GenerateAccessLogs operation returned by the service.
* @sample AWSAmplifyAsync.GenerateAccessLogs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future generateAccessLogsAsync(GenerateAccessLogsRequest generateAccessLogsRequest);
/**
*
* Returns the website access logs for a specific time range using a presigned URL.
*
*
* @param generateAccessLogsRequest
* The request structure for the generate access logs request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GenerateAccessLogs operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GenerateAccessLogs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future generateAccessLogsAsync(GenerateAccessLogsRequest generateAccessLogsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns an existing Amplify app specified by an app ID.
*
*
* @param getAppRequest
* The request structure for the get app request.
* @return A Java Future containing the result of the GetApp operation returned by the service.
* @sample AWSAmplifyAsync.GetApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getAppAsync(GetAppRequest getAppRequest);
/**
*
* Returns an existing Amplify app specified by an app ID.
*
*
* @param getAppRequest
* The request structure for the get app request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetApp operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getAppAsync(GetAppRequest getAppRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the artifact info that corresponds to an artifact id.
*
*
* @param getArtifactUrlRequest
* Returns the request structure for the get artifact request.
* @return A Java Future containing the result of the GetArtifactUrl operation returned by the service.
* @sample AWSAmplifyAsync.GetArtifactUrl
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getArtifactUrlAsync(GetArtifactUrlRequest getArtifactUrlRequest);
/**
*
* Returns the artifact info that corresponds to an artifact id.
*
*
* @param getArtifactUrlRequest
* Returns the request structure for the get artifact request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetArtifactUrl operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetArtifactUrl
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getArtifactUrlAsync(GetArtifactUrlRequest getArtifactUrlRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a backend environment for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param getBackendEnvironmentRequest
* The request structure for the get backend environment request.
* @return A Java Future containing the result of the GetBackendEnvironment operation returned by the service.
* @sample AWSAmplifyAsync.GetBackendEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getBackendEnvironmentAsync(GetBackendEnvironmentRequest getBackendEnvironmentRequest);
/**
*
* Returns a backend environment for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param getBackendEnvironmentRequest
* The request structure for the get backend environment request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetBackendEnvironment operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetBackendEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getBackendEnvironmentAsync(GetBackendEnvironmentRequest getBackendEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a branch for an Amplify app.
*
*
* @param getBranchRequest
* The request structure for the get branch request.
* @return A Java Future containing the result of the GetBranch operation returned by the service.
* @sample AWSAmplifyAsync.GetBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getBranchAsync(GetBranchRequest getBranchRequest);
/**
*
* Returns a branch for an Amplify app.
*
*
* @param getBranchRequest
* The request structure for the get branch request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetBranch operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getBranchAsync(GetBranchRequest getBranchRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the domain information for an Amplify app.
*
*
* @param getDomainAssociationRequest
* The request structure for the get domain association request.
* @return A Java Future containing the result of the GetDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsync.GetDomainAssociation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getDomainAssociationAsync(GetDomainAssociationRequest getDomainAssociationRequest);
/**
*
* Returns the domain information for an Amplify app.
*
*
* @param getDomainAssociationRequest
* The request structure for the get domain association request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetDomainAssociation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getDomainAssociationAsync(GetDomainAssociationRequest getDomainAssociationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a job for a branch of an Amplify app.
*
*
* @param getJobRequest
* The request structure for the get job request.
* @return A Java Future containing the result of the GetJob operation returned by the service.
* @sample AWSAmplifyAsync.GetJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getJobAsync(GetJobRequest getJobRequest);
/**
*
* Returns a job for a branch of an Amplify app.
*
*
* @param getJobRequest
* The request structure for the get job request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetJob operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getJobAsync(GetJobRequest getJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the webhook information that corresponds to a specified webhook ID.
*
*
* @param getWebhookRequest
* The request structure for the get webhook request.
* @return A Java Future containing the result of the GetWebhook operation returned by the service.
* @sample AWSAmplifyAsync.GetWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getWebhookAsync(GetWebhookRequest getWebhookRequest);
/**
*
* Returns the webhook information that corresponds to a specified webhook ID.
*
*
* @param getWebhookRequest
* The request structure for the get webhook request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetWebhook operation returned by the service.
* @sample AWSAmplifyAsyncHandler.GetWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getWebhookAsync(GetWebhookRequest getWebhookRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of the existing Amplify apps.
*
*
* @param listAppsRequest
* The request structure for the list apps request.
* @return A Java Future containing the result of the ListApps operation returned by the service.
* @sample AWSAmplifyAsync.ListApps
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listAppsAsync(ListAppsRequest listAppsRequest);
/**
*
* Returns a list of the existing Amplify apps.
*
*
* @param listAppsRequest
* The request structure for the list apps request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListApps operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListApps
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listAppsAsync(ListAppsRequest listAppsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of artifacts for a specified app, branch, and job.
*
*
* @param listArtifactsRequest
* Describes the request structure for the list artifacts request.
* @return A Java Future containing the result of the ListArtifacts operation returned by the service.
* @sample AWSAmplifyAsync.ListArtifacts
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listArtifactsAsync(ListArtifactsRequest listArtifactsRequest);
/**
*
* Returns a list of artifacts for a specified app, branch, and job.
*
*
* @param listArtifactsRequest
* Describes the request structure for the list artifacts request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListArtifacts operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListArtifacts
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listArtifactsAsync(ListArtifactsRequest listArtifactsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the backend environments for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param listBackendEnvironmentsRequest
* The request structure for the list backend environments request.
* @return A Java Future containing the result of the ListBackendEnvironments operation returned by the service.
* @sample AWSAmplifyAsync.ListBackendEnvironments
* @see AWS API Documentation
*/
java.util.concurrent.Future listBackendEnvironmentsAsync(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest);
/**
*
* Lists the backend environments for an Amplify app.
*
*
* This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the
* Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an
* application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
*
*
* @param listBackendEnvironmentsRequest
* The request structure for the list backend environments request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListBackendEnvironments operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListBackendEnvironments
* @see AWS API Documentation
*/
java.util.concurrent.Future listBackendEnvironmentsAsync(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the branches of an Amplify app.
*
*
* @param listBranchesRequest
* The request structure for the list branches request.
* @return A Java Future containing the result of the ListBranches operation returned by the service.
* @sample AWSAmplifyAsync.ListBranches
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listBranchesAsync(ListBranchesRequest listBranchesRequest);
/**
*
* Lists the branches of an Amplify app.
*
*
* @param listBranchesRequest
* The request structure for the list branches request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListBranches operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListBranches
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listBranchesAsync(ListBranchesRequest listBranchesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the domain associations for an Amplify app.
*
*
* @param listDomainAssociationsRequest
* The request structure for the list domain associations request.
* @return A Java Future containing the result of the ListDomainAssociations operation returned by the service.
* @sample AWSAmplifyAsync.ListDomainAssociations
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listDomainAssociationsAsync(ListDomainAssociationsRequest listDomainAssociationsRequest);
/**
*
* Returns the domain associations for an Amplify app.
*
*
* @param listDomainAssociationsRequest
* The request structure for the list domain associations request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListDomainAssociations operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListDomainAssociations
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listDomainAssociationsAsync(ListDomainAssociationsRequest listDomainAssociationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the jobs for a branch of an Amplify app.
*
*
* @param listJobsRequest
* The request structure for the list jobs request.
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* @sample AWSAmplifyAsync.ListJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listJobsAsync(ListJobsRequest listJobsRequest);
/**
*
* Lists the jobs for a branch of an Amplify app.
*
*
* @param listJobsRequest
* The request structure for the list jobs request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listJobsAsync(ListJobsRequest listJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of tags for a specified Amazon Resource Name (ARN).
*
*
* @param listTagsForResourceRequest
* The request structure to use to list tags for a resource.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSAmplifyAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of tags for a specified Amazon Resource Name (ARN).
*
*
* @param listTagsForResourceRequest
* The request structure to use to list tags for a resource.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of webhooks for an Amplify app.
*
*
* @param listWebhooksRequest
* The request structure for the list webhooks request.
* @return A Java Future containing the result of the ListWebhooks operation returned by the service.
* @sample AWSAmplifyAsync.ListWebhooks
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listWebhooksAsync(ListWebhooksRequest listWebhooksRequest);
/**
*
* Returns a list of webhooks for an Amplify app.
*
*
* @param listWebhooksRequest
* The request structure for the list webhooks request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListWebhooks operation returned by the service.
* @sample AWSAmplifyAsyncHandler.ListWebhooks
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listWebhooksAsync(ListWebhooksRequest listWebhooksRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
*
*
* The maximum duration between the CreateDeployment call and the StartDeployment call
* cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated
* Job will fail.
*
*
* @param startDeploymentRequest
* The request structure for the start a deployment request.
* @return A Java Future containing the result of the StartDeployment operation returned by the service.
* @sample AWSAmplifyAsync.StartDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startDeploymentAsync(StartDeploymentRequest startDeploymentRequest);
/**
*
* Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
*
*
* The maximum duration between the CreateDeployment call and the StartDeployment call
* cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated
* Job will fail.
*
*
* @param startDeploymentRequest
* The request structure for the start a deployment request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartDeployment operation returned by the service.
* @sample AWSAmplifyAsyncHandler.StartDeployment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startDeploymentAsync(StartDeploymentRequest startDeploymentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts a new job for a branch of an Amplify app.
*
*
* @param startJobRequest
* The request structure for the start job request.
* @return A Java Future containing the result of the StartJob operation returned by the service.
* @sample AWSAmplifyAsync.StartJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startJobAsync(StartJobRequest startJobRequest);
/**
*
* Starts a new job for a branch of an Amplify app.
*
*
* @param startJobRequest
* The request structure for the start job request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartJob operation returned by the service.
* @sample AWSAmplifyAsyncHandler.StartJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startJobAsync(StartJobRequest startJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops a job that is in progress for a branch of an Amplify app.
*
*
* @param stopJobRequest
* The request structure for the stop job request.
* @return A Java Future containing the result of the StopJob operation returned by the service.
* @sample AWSAmplifyAsync.StopJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopJobAsync(StopJobRequest stopJobRequest);
/**
*
* Stops a job that is in progress for a branch of an Amplify app.
*
*
* @param stopJobRequest
* The request structure for the stop job request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopJob operation returned by the service.
* @sample AWSAmplifyAsyncHandler.StopJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopJobAsync(StopJobRequest stopJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Tags the resource with a tag key and value.
*
*
* @param tagResourceRequest
* The request structure to tag a resource with a tag key and value.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSAmplifyAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Tags the resource with a tag key and value.
*
*
* @param tagResourceRequest
* The request structure to tag a resource with a tag key and value.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSAmplifyAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Untags a resource with a specified Amazon Resource Name (ARN).
*
*
* @param untagResourceRequest
* The request structure for the untag resource request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSAmplifyAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Untags a resource with a specified Amazon Resource Name (ARN).
*
*
* @param untagResourceRequest
* The request structure for the untag resource request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSAmplifyAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an existing Amplify app.
*
*
* @param updateAppRequest
* The request structure for the update app request.
* @return A Java Future containing the result of the UpdateApp operation returned by the service.
* @sample AWSAmplifyAsync.UpdateApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateAppAsync(UpdateAppRequest updateAppRequest);
/**
*
* Updates an existing Amplify app.
*
*
* @param updateAppRequest
* The request structure for the update app request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateApp operation returned by the service.
* @sample AWSAmplifyAsyncHandler.UpdateApp
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateAppAsync(UpdateAppRequest updateAppRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a branch for an Amplify app.
*
*
* @param updateBranchRequest
* The request structure for the update branch request.
* @return A Java Future containing the result of the UpdateBranch operation returned by the service.
* @sample AWSAmplifyAsync.UpdateBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateBranchAsync(UpdateBranchRequest updateBranchRequest);
/**
*
* Updates a branch for an Amplify app.
*
*
* @param updateBranchRequest
* The request structure for the update branch request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateBranch operation returned by the service.
* @sample AWSAmplifyAsyncHandler.UpdateBranch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateBranchAsync(UpdateBranchRequest updateBranchRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new domain association for an Amplify app.
*
*
* @param updateDomainAssociationRequest
* The request structure for the update domain association request.
* @return A Java Future containing the result of the UpdateDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsync.UpdateDomainAssociation
* @see AWS API Documentation
*/
java.util.concurrent.Future updateDomainAssociationAsync(UpdateDomainAssociationRequest updateDomainAssociationRequest);
/**
*
* Creates a new domain association for an Amplify app.
*
*
* @param updateDomainAssociationRequest
* The request structure for the update domain association request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateDomainAssociation operation returned by the service.
* @sample AWSAmplifyAsyncHandler.UpdateDomainAssociation
* @see AWS API Documentation
*/
java.util.concurrent.Future updateDomainAssociationAsync(UpdateDomainAssociationRequest updateDomainAssociationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a webhook.
*
*
* @param updateWebhookRequest
* The request structure for the update webhook request.
* @return A Java Future containing the result of the UpdateWebhook operation returned by the service.
* @sample AWSAmplifyAsync.UpdateWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateWebhookAsync(UpdateWebhookRequest updateWebhookRequest);
/**
*
* Updates a webhook.
*
*
* @param updateWebhookRequest
* The request structure for the update webhook request.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateWebhook operation returned by the service.
* @sample AWSAmplifyAsyncHandler.UpdateWebhook
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateWebhookAsync(UpdateWebhookRequest updateWebhookRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}