software.amazon.awssdk.services.amplify.AmplifyClient Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.amplify;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.amplify.model.AmplifyException;
import software.amazon.awssdk.services.amplify.model.BadRequestException;
import software.amazon.awssdk.services.amplify.model.CreateAppRequest;
import software.amazon.awssdk.services.amplify.model.CreateAppResponse;
import software.amazon.awssdk.services.amplify.model.CreateBackendEnvironmentRequest;
import software.amazon.awssdk.services.amplify.model.CreateBackendEnvironmentResponse;
import software.amazon.awssdk.services.amplify.model.CreateBranchRequest;
import software.amazon.awssdk.services.amplify.model.CreateBranchResponse;
import software.amazon.awssdk.services.amplify.model.CreateDeploymentRequest;
import software.amazon.awssdk.services.amplify.model.CreateDeploymentResponse;
import software.amazon.awssdk.services.amplify.model.CreateDomainAssociationRequest;
import software.amazon.awssdk.services.amplify.model.CreateDomainAssociationResponse;
import software.amazon.awssdk.services.amplify.model.CreateWebhookRequest;
import software.amazon.awssdk.services.amplify.model.CreateWebhookResponse;
import software.amazon.awssdk.services.amplify.model.DeleteAppRequest;
import software.amazon.awssdk.services.amplify.model.DeleteAppResponse;
import software.amazon.awssdk.services.amplify.model.DeleteBackendEnvironmentRequest;
import software.amazon.awssdk.services.amplify.model.DeleteBackendEnvironmentResponse;
import software.amazon.awssdk.services.amplify.model.DeleteBranchRequest;
import software.amazon.awssdk.services.amplify.model.DeleteBranchResponse;
import software.amazon.awssdk.services.amplify.model.DeleteDomainAssociationRequest;
import software.amazon.awssdk.services.amplify.model.DeleteDomainAssociationResponse;
import software.amazon.awssdk.services.amplify.model.DeleteJobRequest;
import software.amazon.awssdk.services.amplify.model.DeleteJobResponse;
import software.amazon.awssdk.services.amplify.model.DeleteWebhookRequest;
import software.amazon.awssdk.services.amplify.model.DeleteWebhookResponse;
import software.amazon.awssdk.services.amplify.model.DependentServiceFailureException;
import software.amazon.awssdk.services.amplify.model.GenerateAccessLogsRequest;
import software.amazon.awssdk.services.amplify.model.GenerateAccessLogsResponse;
import software.amazon.awssdk.services.amplify.model.GetAppRequest;
import software.amazon.awssdk.services.amplify.model.GetAppResponse;
import software.amazon.awssdk.services.amplify.model.GetArtifactUrlRequest;
import software.amazon.awssdk.services.amplify.model.GetArtifactUrlResponse;
import software.amazon.awssdk.services.amplify.model.GetBackendEnvironmentRequest;
import software.amazon.awssdk.services.amplify.model.GetBackendEnvironmentResponse;
import software.amazon.awssdk.services.amplify.model.GetBranchRequest;
import software.amazon.awssdk.services.amplify.model.GetBranchResponse;
import software.amazon.awssdk.services.amplify.model.GetDomainAssociationRequest;
import software.amazon.awssdk.services.amplify.model.GetDomainAssociationResponse;
import software.amazon.awssdk.services.amplify.model.GetJobRequest;
import software.amazon.awssdk.services.amplify.model.GetJobResponse;
import software.amazon.awssdk.services.amplify.model.GetWebhookRequest;
import software.amazon.awssdk.services.amplify.model.GetWebhookResponse;
import software.amazon.awssdk.services.amplify.model.InternalFailureException;
import software.amazon.awssdk.services.amplify.model.LimitExceededException;
import software.amazon.awssdk.services.amplify.model.ListAppsRequest;
import software.amazon.awssdk.services.amplify.model.ListAppsResponse;
import software.amazon.awssdk.services.amplify.model.ListArtifactsRequest;
import software.amazon.awssdk.services.amplify.model.ListArtifactsResponse;
import software.amazon.awssdk.services.amplify.model.ListBackendEnvironmentsRequest;
import software.amazon.awssdk.services.amplify.model.ListBackendEnvironmentsResponse;
import software.amazon.awssdk.services.amplify.model.ListBranchesRequest;
import software.amazon.awssdk.services.amplify.model.ListBranchesResponse;
import software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest;
import software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse;
import software.amazon.awssdk.services.amplify.model.ListJobsRequest;
import software.amazon.awssdk.services.amplify.model.ListJobsResponse;
import software.amazon.awssdk.services.amplify.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.amplify.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.amplify.model.ListWebhooksRequest;
import software.amazon.awssdk.services.amplify.model.ListWebhooksResponse;
import software.amazon.awssdk.services.amplify.model.NotFoundException;
import software.amazon.awssdk.services.amplify.model.ResourceNotFoundException;
import software.amazon.awssdk.services.amplify.model.StartDeploymentRequest;
import software.amazon.awssdk.services.amplify.model.StartDeploymentResponse;
import software.amazon.awssdk.services.amplify.model.StartJobRequest;
import software.amazon.awssdk.services.amplify.model.StartJobResponse;
import software.amazon.awssdk.services.amplify.model.StopJobRequest;
import software.amazon.awssdk.services.amplify.model.StopJobResponse;
import software.amazon.awssdk.services.amplify.model.TagResourceRequest;
import software.amazon.awssdk.services.amplify.model.TagResourceResponse;
import software.amazon.awssdk.services.amplify.model.UnauthorizedException;
import software.amazon.awssdk.services.amplify.model.UntagResourceRequest;
import software.amazon.awssdk.services.amplify.model.UntagResourceResponse;
import software.amazon.awssdk.services.amplify.model.UpdateAppRequest;
import software.amazon.awssdk.services.amplify.model.UpdateAppResponse;
import software.amazon.awssdk.services.amplify.model.UpdateBranchRequest;
import software.amazon.awssdk.services.amplify.model.UpdateBranchResponse;
import software.amazon.awssdk.services.amplify.model.UpdateDomainAssociationRequest;
import software.amazon.awssdk.services.amplify.model.UpdateDomainAssociationResponse;
import software.amazon.awssdk.services.amplify.model.UpdateWebhookRequest;
import software.amazon.awssdk.services.amplify.model.UpdateWebhookResponse;
import software.amazon.awssdk.services.amplify.paginators.ListAppsIterable;
import software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable;
import software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable;
import software.amazon.awssdk.services.amplify.paginators.ListJobsIterable;
/**
* Service client for accessing Amplify. This can be created using the static {@link #builder()} method.
*
*
* 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("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface AmplifyClient extends AwsClient {
String SERVICE_NAME = "amplify";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "amplify";
/**
*
* Creates a new Amplify app.
*
*
* @param createAppRequest
* The request structure used to create apps in Amplify.
* @return Result of the CreateApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateApp
* @see AWS API
* Documentation
*/
default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAppRequest.Builder} avoiding the need to
* create one manually via {@link CreateAppRequest#builder()}
*
*
* @param createAppRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.CreateAppRequest.Builder} to create a request. The
* request structure used to create apps in Amplify.
* @return Result of the CreateApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateApp
* @see AWS API
* Documentation
*/
default CreateAppResponse createApp(Consumer createAppRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, LimitExceededException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return createApp(CreateAppRequest.builder().applyMutation(createAppRequest).build());
}
/**
*
* 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 Result of the CreateBackendEnvironment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateBackendEnvironment
* @see AWS API Documentation
*/
default CreateBackendEnvironmentResponse createBackendEnvironment(
CreateBackendEnvironmentRequest createBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBackendEnvironmentRequest.Builder} avoiding
* the need to create one manually via {@link CreateBackendEnvironmentRequest#builder()}
*
*
* @param createBackendEnvironmentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.CreateBackendEnvironmentRequest.Builder} to create a
* request. The request structure for the backend environment create request.
* @return Result of the CreateBackendEnvironment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateBackendEnvironment
* @see AWS API Documentation
*/
default CreateBackendEnvironmentResponse createBackendEnvironment(
Consumer createBackendEnvironmentRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
return createBackendEnvironment(CreateBackendEnvironmentRequest.builder().applyMutation(createBackendEnvironmentRequest)
.build());
}
/**
*
* Creates a new branch for an Amplify app.
*
*
* @param createBranchRequest
* The request structure for the create branch request.
* @return Result of the CreateBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateBranch
* @see AWS API
* Documentation
*/
default CreateBranchResponse createBranch(CreateBranchRequest createBranchRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new branch for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBranchRequest.Builder} avoiding the need to
* create one manually via {@link CreateBranchRequest#builder()}
*
*
* @param createBranchRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.CreateBranchRequest.Builder} to create a request. The
* request structure for the create branch request.
* @return Result of the CreateBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateBranch
* @see AWS API
* Documentation
*/
default CreateBranchResponse createBranch(Consumer createBranchRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
return createBranch(CreateBranchRequest.builder().applyMutation(createBranchRequest).build());
}
/**
*
* Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git
* 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 Result of the CreateDeployment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateDeployment
* @see AWS API
* Documentation
*/
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException,
AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link CreateDeploymentRequest#builder()}
*
*
* @param createDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.CreateDeploymentRequest.Builder} to create a request.
* The request structure for the create a new deployment request.
* @return Result of the CreateDeployment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateDeployment
* @see AWS API
* Documentation
*/
default CreateDeploymentResponse createDeployment(Consumer createDeploymentRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException,
AwsServiceException, SdkClientException, AmplifyException {
return createDeployment(CreateDeploymentRequest.builder().applyMutation(createDeploymentRequest).build());
}
/**
*
* 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 Result of the CreateDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateDomainAssociation
* @see AWS API Documentation
*/
default CreateDomainAssociationResponse createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
*
*
*
* This is a convenience which creates an instance of the {@link CreateDomainAssociationRequest.Builder} avoiding
* the need to create one manually via {@link CreateDomainAssociationRequest#builder()}
*
*
* @param createDomainAssociationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.CreateDomainAssociationRequest.Builder} to create a
* request. The request structure for the create domain association request.
* @return Result of the CreateDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateDomainAssociation
* @see AWS API Documentation
*/
default CreateDomainAssociationResponse createDomainAssociation(
Consumer createDomainAssociationRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
return createDomainAssociation(CreateDomainAssociationRequest.builder().applyMutation(createDomainAssociationRequest)
.build());
}
/**
*
* Creates a new webhook on an Amplify app.
*
*
* @param createWebhookRequest
* The request structure for the create webhook request.
* @return Result of the CreateWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateWebhook
* @see AWS API
* Documentation
*/
default CreateWebhookResponse createWebhook(CreateWebhookRequest createWebhookRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new webhook on an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link CreateWebhookRequest.Builder} avoiding the need to
* create one manually via {@link CreateWebhookRequest#builder()}
*
*
* @param createWebhookRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.CreateWebhookRequest.Builder} to create a request.
* The request structure for the create webhook request.
* @return Result of the CreateWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.CreateWebhook
* @see AWS API
* Documentation
*/
default CreateWebhookResponse createWebhook(Consumer createWebhookRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
return createWebhook(CreateWebhookRequest.builder().applyMutation(createWebhookRequest).build());
}
/**
*
* Deletes an existing Amplify app specified by an app ID.
*
*
* @param deleteAppRequest
* Describes the request structure for the delete app request.
* @return Result of the DeleteApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteApp
* @see AWS API
* Documentation
*/
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, InternalFailureException, DependentServiceFailureException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an existing Amplify app specified by an app ID.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteAppRequest.Builder} avoiding the need to
* create one manually via {@link DeleteAppRequest#builder()}
*
*
* @param deleteAppRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.DeleteAppRequest.Builder} to create a request.
* Describes the request structure for the delete app request.
* @return Result of the DeleteApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteApp
* @see AWS API
* Documentation
*/
default DeleteAppResponse deleteApp(Consumer deleteAppRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return deleteApp(DeleteAppRequest.builder().applyMutation(deleteAppRequest).build());
}
/**
*
* 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 Result of the DeleteBackendEnvironment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteBackendEnvironment
* @see AWS API Documentation
*/
default DeleteBackendEnvironmentResponse deleteBackendEnvironment(
DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackendEnvironmentRequest.Builder} avoiding
* the need to create one manually via {@link DeleteBackendEnvironmentRequest#builder()}
*
*
* @param deleteBackendEnvironmentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.DeleteBackendEnvironmentRequest.Builder} to create a
* request. The request structure for the delete backend environment request.
* @return Result of the DeleteBackendEnvironment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteBackendEnvironment
* @see AWS API Documentation
*/
default DeleteBackendEnvironmentResponse deleteBackendEnvironment(
Consumer deleteBackendEnvironmentRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return deleteBackendEnvironment(DeleteBackendEnvironmentRequest.builder().applyMutation(deleteBackendEnvironmentRequest)
.build());
}
/**
*
* Deletes a branch for an Amplify app.
*
*
* @param deleteBranchRequest
* The request structure for the delete branch request.
* @return Result of the DeleteBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteBranch
* @see AWS API
* Documentation
*/
default DeleteBranchResponse deleteBranch(DeleteBranchRequest deleteBranchRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a branch for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBranchRequest.Builder} avoiding the need to
* create one manually via {@link DeleteBranchRequest#builder()}
*
*
* @param deleteBranchRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.DeleteBranchRequest.Builder} to create a request. The
* request structure for the delete branch request.
* @return Result of the DeleteBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteBranch
* @see AWS API
* Documentation
*/
default DeleteBranchResponse deleteBranch(Consumer deleteBranchRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
return deleteBranch(DeleteBranchRequest.builder().applyMutation(deleteBranchRequest).build());
}
/**
*
* Deletes a domain association for an Amplify app.
*
*
* @param deleteDomainAssociationRequest
* The request structure for the delete domain association request.
* @return Result of the DeleteDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteDomainAssociation
* @see AWS API Documentation
*/
default DeleteDomainAssociationResponse deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a domain association for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDomainAssociationRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDomainAssociationRequest#builder()}
*
*
* @param deleteDomainAssociationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.DeleteDomainAssociationRequest.Builder} to create a
* request. The request structure for the delete domain association request.
* @return Result of the DeleteDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteDomainAssociation
* @see AWS API Documentation
*/
default DeleteDomainAssociationResponse deleteDomainAssociation(
Consumer deleteDomainAssociationRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return deleteDomainAssociation(DeleteDomainAssociationRequest.builder().applyMutation(deleteDomainAssociationRequest)
.build());
}
/**
*
* Deletes a job for a branch of an Amplify app.
*
*
* @param deleteJobRequest
* The request structure for the delete job request.
* @return Result of the DeleteJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteJob
* @see AWS API
* Documentation
*/
default DeleteJobResponse deleteJob(DeleteJobRequest deleteJobRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a job for a branch of an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteJobRequest.Builder} avoiding the need to
* create one manually via {@link DeleteJobRequest#builder()}
*
*
* @param deleteJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.DeleteJobRequest.Builder} to create a request. The
* request structure for the delete job request.
* @return Result of the DeleteJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteJob
* @see AWS API
* Documentation
*/
default DeleteJobResponse deleteJob(Consumer deleteJobRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
return deleteJob(DeleteJobRequest.builder().applyMutation(deleteJobRequest).build());
}
/**
*
* Deletes a webhook.
*
*
* @param deleteWebhookRequest
* The request structure for the delete webhook request.
* @return Result of the DeleteWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteWebhook
* @see AWS API
* Documentation
*/
default DeleteWebhookResponse deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a webhook.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteWebhookRequest.Builder} avoiding the need to
* create one manually via {@link DeleteWebhookRequest#builder()}
*
*
* @param deleteWebhookRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.DeleteWebhookRequest.Builder} to create a request.
* The request structure for the delete webhook request.
* @return Result of the DeleteWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.DeleteWebhook
* @see AWS API
* Documentation
*/
default DeleteWebhookResponse deleteWebhook(Consumer deleteWebhookRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException,
LimitExceededException, AwsServiceException, SdkClientException, AmplifyException {
return deleteWebhook(DeleteWebhookRequest.builder().applyMutation(deleteWebhookRequest).build());
}
/**
*
* 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 Result of the GenerateAccessLogs operation returned by the service.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GenerateAccessLogs
* @see AWS
* API Documentation
*/
default GenerateAccessLogsResponse generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
throws NotFoundException, BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the website access logs for a specific time range using a presigned URL.
*
*
*
* This is a convenience which creates an instance of the {@link GenerateAccessLogsRequest.Builder} avoiding the
* need to create one manually via {@link GenerateAccessLogsRequest#builder()}
*
*
* @param generateAccessLogsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GenerateAccessLogsRequest.Builder} to create a
* request. The request structure for the generate access logs request.
* @return Result of the GenerateAccessLogs operation returned by the service.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GenerateAccessLogs
* @see AWS
* API Documentation
*/
default GenerateAccessLogsResponse generateAccessLogs(Consumer generateAccessLogsRequest)
throws NotFoundException, BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException,
SdkClientException, AmplifyException {
return generateAccessLogs(GenerateAccessLogsRequest.builder().applyMutation(generateAccessLogsRequest).build());
}
/**
*
* Returns an existing Amplify app specified by an app ID.
*
*
* @param getAppRequest
* The request structure for the get app request.
* @return Result of the GetApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetApp
* @see AWS API
* Documentation
*/
default GetAppResponse getApp(GetAppRequest getAppRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns an existing Amplify app specified by an app ID.
*
*
*
* This is a convenience which creates an instance of the {@link GetAppRequest.Builder} avoiding the need to create
* one manually via {@link GetAppRequest#builder()}
*
*
* @param getAppRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetAppRequest.Builder} to create a request. The
* request structure for the get app request.
* @return Result of the GetApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetApp
* @see AWS API
* Documentation
*/
default GetAppResponse getApp(Consumer getAppRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return getApp(GetAppRequest.builder().applyMutation(getAppRequest).build());
}
/**
*
* Returns the artifact info that corresponds to an artifact id.
*
*
* @param getArtifactUrlRequest
* Returns the request structure for the get artifact request.
* @return Result of the GetArtifactUrl operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetArtifactUrl
* @see AWS API
* Documentation
*/
default GetArtifactUrlResponse getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the artifact info that corresponds to an artifact id.
*
*
*
* This is a convenience which creates an instance of the {@link GetArtifactUrlRequest.Builder} avoiding the need to
* create one manually via {@link GetArtifactUrlRequest#builder()}
*
*
* @param getArtifactUrlRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetArtifactUrlRequest.Builder} to create a request.
* Returns the request structure for the get artifact request.
* @return Result of the GetArtifactUrl operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetArtifactUrl
* @see AWS API
* Documentation
*/
default GetArtifactUrlResponse getArtifactUrl(Consumer getArtifactUrlRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException,
LimitExceededException, AwsServiceException, SdkClientException, AmplifyException {
return getArtifactUrl(GetArtifactUrlRequest.builder().applyMutation(getArtifactUrlRequest).build());
}
/**
*
* 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 Result of the GetBackendEnvironment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetBackendEnvironment
* @see AWS
* API Documentation
*/
default GetBackendEnvironmentResponse getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackendEnvironmentRequest.Builder} avoiding the
* need to create one manually via {@link GetBackendEnvironmentRequest#builder()}
*
*
* @param getBackendEnvironmentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetBackendEnvironmentRequest.Builder} to create a
* request. The request structure for the get backend environment request.
* @return Result of the GetBackendEnvironment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetBackendEnvironment
* @see AWS
* API Documentation
*/
default GetBackendEnvironmentResponse getBackendEnvironment(
Consumer getBackendEnvironmentRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
return getBackendEnvironment(GetBackendEnvironmentRequest.builder().applyMutation(getBackendEnvironmentRequest).build());
}
/**
*
* Returns a branch for an Amplify app.
*
*
* @param getBranchRequest
* The request structure for the get branch request.
* @return Result of the GetBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetBranch
* @see AWS API
* Documentation
*/
default GetBranchResponse getBranch(GetBranchRequest getBranchRequest) throws BadRequestException, UnauthorizedException,
NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a branch for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link GetBranchRequest.Builder} avoiding the need to
* create one manually via {@link GetBranchRequest#builder()}
*
*
* @param getBranchRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetBranchRequest.Builder} to create a request. The
* request structure for the get branch request.
* @return Result of the GetBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetBranch
* @see AWS API
* Documentation
*/
default GetBranchResponse getBranch(Consumer getBranchRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
return getBranch(GetBranchRequest.builder().applyMutation(getBranchRequest).build());
}
/**
*
* Returns the domain information for an Amplify app.
*
*
* @param getDomainAssociationRequest
* The request structure for the get domain association request.
* @return Result of the GetDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetDomainAssociation
* @see AWS
* API Documentation
*/
default GetDomainAssociationResponse getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the domain information for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainAssociationRequest.Builder} avoiding the
* need to create one manually via {@link GetDomainAssociationRequest#builder()}
*
*
* @param getDomainAssociationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetDomainAssociationRequest.Builder} to create a
* request. The request structure for the get domain association request.
* @return Result of the GetDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetDomainAssociation
* @see AWS
* API Documentation
*/
default GetDomainAssociationResponse getDomainAssociation(
Consumer getDomainAssociationRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
return getDomainAssociation(GetDomainAssociationRequest.builder().applyMutation(getDomainAssociationRequest).build());
}
/**
*
* Returns a job for a branch of an Amplify app.
*
*
* @param getJobRequest
* The request structure for the get job request.
* @return Result of the GetJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetJob
* @see AWS API
* Documentation
*/
default GetJobResponse getJob(GetJobRequest getJobRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a job for a branch of an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link GetJobRequest.Builder} avoiding the need to create
* one manually via {@link GetJobRequest#builder()}
*
*
* @param getJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetJobRequest.Builder} to create a request. The
* request structure for the get job request.
* @return Result of the GetJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetJob
* @see AWS API
* Documentation
*/
default GetJobResponse getJob(Consumer getJobRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
return getJob(GetJobRequest.builder().applyMutation(getJobRequest).build());
}
/**
*
* Returns the webhook information that corresponds to a specified webhook ID.
*
*
* @param getWebhookRequest
* The request structure for the get webhook request.
* @return Result of the GetWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetWebhook
* @see AWS API
* Documentation
*/
default GetWebhookResponse getWebhook(GetWebhookRequest getWebhookRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the webhook information that corresponds to a specified webhook ID.
*
*
*
* This is a convenience which creates an instance of the {@link GetWebhookRequest.Builder} avoiding the need to
* create one manually via {@link GetWebhookRequest#builder()}
*
*
* @param getWebhookRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.GetWebhookRequest.Builder} to create a request. The
* request structure for the get webhook request.
* @return Result of the GetWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.GetWebhook
* @see AWS API
* Documentation
*/
default GetWebhookResponse getWebhook(Consumer getWebhookRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
return getWebhook(GetWebhookRequest.builder().applyMutation(getWebhookRequest).build());
}
/**
*
* Returns a list of the existing Amplify apps.
*
*
* @param listAppsRequest
* The request structure for the list apps request.
* @return Result of the ListApps operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListApps
* @see AWS API
* Documentation
*/
default ListAppsResponse listApps(ListAppsRequest listAppsRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the existing Amplify apps.
*
*
*
* This is a convenience which creates an instance of the {@link ListAppsRequest.Builder} avoiding the need to
* create one manually via {@link ListAppsRequest#builder()}
*
*
* @param listAppsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListAppsRequest.Builder} to create a request. The
* request structure for the list apps request.
* @return Result of the ListApps operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListApps
* @see AWS API
* Documentation
*/
default ListAppsResponse listApps(Consumer listAppsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return listApps(ListAppsRequest.builder().applyMutation(listAppsRequest).build());
}
/**
*
* Returns a list of the existing Amplify apps.
*
*
* @return Result of the ListApps operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListApps
* @see #listApps(ListAppsRequest)
* @see AWS API
* Documentation
*/
default ListAppsResponse listApps() throws BadRequestException, UnauthorizedException, InternalFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return listApps(ListAppsRequest.builder().build());
}
/**
*
* This is a variant of {@link #listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListAppsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListApps
* @see #listAppsPaginator(ListAppsRequest)
* @see AWS API
* Documentation
*/
default ListAppsIterable listAppsPaginator() throws BadRequestException, UnauthorizedException, InternalFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return listAppsPaginator(ListAppsRequest.builder().build());
}
/**
*
* This is a variant of {@link #listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListAppsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)} operation.
*
*
* @param listAppsRequest
* The request structure for the list apps request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListApps
* @see AWS API
* Documentation
*/
default ListAppsIterable listAppsPaginator(ListAppsRequest listAppsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return new ListAppsIterable(this, listAppsRequest);
}
/**
*
* This is a variant of {@link #listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListAppsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListAppsRequest.Builder} avoiding the need to
* create one manually via {@link ListAppsRequest#builder()}
*
*
* @param listAppsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListAppsRequest.Builder} to create a request. The
* request structure for the list apps request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListApps
* @see AWS API
* Documentation
*/
default ListAppsIterable listAppsPaginator(Consumer listAppsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return listAppsPaginator(ListAppsRequest.builder().applyMutation(listAppsRequest).build());
}
/**
*
* Returns a list of artifacts for a specified app, branch, and job.
*
*
* @param listArtifactsRequest
* Describes the request structure for the list artifacts request.
* @return Result of the ListArtifacts operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListArtifacts
* @see AWS API
* Documentation
*/
default ListArtifactsResponse listArtifacts(ListArtifactsRequest listArtifactsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of artifacts for a specified app, branch, and job.
*
*
*
* This is a convenience which creates an instance of the {@link ListArtifactsRequest.Builder} avoiding the need to
* create one manually via {@link ListArtifactsRequest#builder()}
*
*
* @param listArtifactsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListArtifactsRequest.Builder} to create a request.
* Describes the request structure for the list artifacts request.
* @return Result of the ListArtifacts operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListArtifacts
* @see AWS API
* Documentation
*/
default ListArtifactsResponse listArtifacts(Consumer listArtifactsRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException,
AwsServiceException, SdkClientException, AmplifyException {
return listArtifacts(ListArtifactsRequest.builder().applyMutation(listArtifactsRequest).build());
}
/**
*
* 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 Result of the ListBackendEnvironments operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListBackendEnvironments
* @see AWS API Documentation
*/
default ListBackendEnvironmentsResponse listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackendEnvironmentsRequest.Builder} avoiding
* the need to create one manually via {@link ListBackendEnvironmentsRequest#builder()}
*
*
* @param listBackendEnvironmentsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListBackendEnvironmentsRequest.Builder} to create a
* request. The request structure for the list backend environments request.
* @return Result of the ListBackendEnvironments operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListBackendEnvironments
* @see AWS API Documentation
*/
default ListBackendEnvironmentsResponse listBackendEnvironments(
Consumer listBackendEnvironmentsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return listBackendEnvironments(ListBackendEnvironmentsRequest.builder().applyMutation(listBackendEnvironmentsRequest)
.build());
}
/**
*
* Lists the branches of an Amplify app.
*
*
* @param listBranchesRequest
* The request structure for the list branches request.
* @return Result of the ListBranches operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListBranches
* @see AWS API
* Documentation
*/
default ListBranchesResponse listBranches(ListBranchesRequest listBranchesRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the branches of an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link ListBranchesRequest.Builder} avoiding the need to
* create one manually via {@link ListBranchesRequest#builder()}
*
*
* @param listBranchesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListBranchesRequest.Builder} to create a request. The
* request structure for the list branches request.
* @return Result of the ListBranches operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListBranches
* @see AWS API
* Documentation
*/
default ListBranchesResponse listBranches(Consumer listBranchesRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
return listBranches(ListBranchesRequest.builder().applyMutation(listBranchesRequest).build());
}
/**
*
* This is a variant of {@link #listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListBranchesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)} operation.
*
*
* @param listBranchesRequest
* The request structure for the list branches request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListBranches
* @see AWS API
* Documentation
*/
default ListBranchesIterable listBranchesPaginator(ListBranchesRequest listBranchesRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return new ListBranchesIterable(this, listBranchesRequest);
}
/**
*
* This is a variant of {@link #listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListBranchesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBranchesRequest.Builder} avoiding the need to
* create one manually via {@link ListBranchesRequest#builder()}
*
*
* @param listBranchesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListBranchesRequest.Builder} to create a request. The
* request structure for the list branches request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListBranches
* @see AWS API
* Documentation
*/
default ListBranchesIterable listBranchesPaginator(Consumer listBranchesRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
return listBranchesPaginator(ListBranchesRequest.builder().applyMutation(listBranchesRequest).build());
}
/**
*
* Returns the domain associations for an Amplify app.
*
*
* @param listDomainAssociationsRequest
* The request structure for the list domain associations request.
* @return Result of the ListDomainAssociations operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListDomainAssociations
* @see AWS API Documentation
*/
default ListDomainAssociationsResponse listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the domain associations for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainAssociationsRequest.Builder} avoiding the
* need to create one manually via {@link ListDomainAssociationsRequest#builder()}
*
*
* @param listDomainAssociationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest.Builder} to create a
* request. The request structure for the list domain associations request.
* @return Result of the ListDomainAssociations operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListDomainAssociations
* @see AWS API Documentation
*/
default ListDomainAssociationsResponse listDomainAssociations(
Consumer listDomainAssociationsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return listDomainAssociations(ListDomainAssociationsRequest.builder().applyMutation(listDomainAssociationsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client.listDomainAssociationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client
* .listDomainAssociationsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client.listDomainAssociationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)}
* operation.
*
*
* @param listDomainAssociationsRequest
* The request structure for the list domain associations request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListDomainAssociations
* @see AWS API Documentation
*/
default ListDomainAssociationsIterable listDomainAssociationsPaginator(
ListDomainAssociationsRequest listDomainAssociationsRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return new ListDomainAssociationsIterable(this, listDomainAssociationsRequest);
}
/**
*
* This is a variant of
* {@link #listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)}
* operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
* internally handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client.listDomainAssociationsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client
* .listDomainAssociationsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client.listDomainAssociationsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainAssociationsRequest.Builder} avoiding the
* need to create one manually via {@link ListDomainAssociationsRequest#builder()}
*
*
* @param listDomainAssociationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest.Builder} to create a
* request. The request structure for the list domain associations request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListDomainAssociations
* @see AWS API Documentation
*/
default ListDomainAssociationsIterable listDomainAssociationsPaginator(
Consumer listDomainAssociationsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
return listDomainAssociationsPaginator(ListDomainAssociationsRequest.builder()
.applyMutation(listDomainAssociationsRequest).build());
}
/**
*
* Lists the jobs for a branch of an Amplify app.
*
*
* @param listJobsRequest
* The request structure for the list jobs request.
* @return Result of the ListJobs operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the jobs for a branch of an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link ListJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListJobsRequest#builder()}
*
*
* @param listJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListJobsRequest.Builder} to create a request. The
* request structure for the list jobs request.
* @return Result of the ListJobs operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsResponse listJobs(Consumer listJobsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
return listJobs(ListJobsRequest.builder().applyMutation(listJobsRequest).build());
}
/**
*
* This is a variant of {@link #listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)} operation.
*
*
* @param listJobsRequest
* The request structure for the list jobs request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
return new ListJobsIterable(this, listJobsRequest);
}
/**
*
* This is a variant of {@link #listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)} operation.
* The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
* handle making service calls for you.
*
*
* When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no
* guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response
* pages by making service calls until there are no pages left or your iteration stops. If there are errors in your
* request, you will see the failures only after you start iterating through the iterable.
*
*
*
* The following are few ways to iterate through the response pages:
*
* 1) Using a Stream
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
* for (software.amazon.awssdk.services.amplify.model.ListJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListJobsRequest#builder()}
*
*
* @param listJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListJobsRequest.Builder} to create a request. The
* request structure for the list jobs request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListJobs
* @see AWS API
* Documentation
*/
default ListJobsIterable listJobsPaginator(Consumer listJobsRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
return listJobsPaginator(ListJobsRequest.builder().applyMutation(listJobsRequest).build());
}
/**
*
* 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 Result of the ListTagsForResource operation returned by the service.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws BadRequestException
* A request contains unexpected data.
* @throws ResourceNotFoundException
* An operation failed due to a non-existent resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of tags for a specified Amazon Resource Name (ARN).
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListTagsForResourceRequest.Builder} to create a
* request. The request structure to use to list tags for a resource.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws BadRequestException
* A request contains unexpected data.
* @throws ResourceNotFoundException
* An operation failed due to a non-existent resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws InternalFailureException,
BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Returns a list of webhooks for an Amplify app.
*
*
* @param listWebhooksRequest
* The request structure for the list webhooks request.
* @return Result of the ListWebhooks operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListWebhooks
* @see AWS API
* Documentation
*/
default ListWebhooksResponse listWebhooks(ListWebhooksRequest listWebhooksRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of webhooks for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link ListWebhooksRequest.Builder} avoiding the need to
* create one manually via {@link ListWebhooksRequest#builder()}
*
*
* @param listWebhooksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.ListWebhooksRequest.Builder} to create a request. The
* request structure for the list webhooks request.
* @return Result of the ListWebhooks operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.ListWebhooks
* @see AWS API
* Documentation
*/
default ListWebhooksResponse listWebhooks(Consumer listWebhooksRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException,
AwsServiceException, SdkClientException, AmplifyException {
return listWebhooks(ListWebhooksRequest.builder().applyMutation(listWebhooksRequest).build());
}
/**
*
* Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git 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 Result of the StartDeployment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.StartDeployment
* @see AWS API
* Documentation
*/
default StartDeploymentResponse startDeployment(StartDeploymentRequest startDeploymentRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git 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.
*
*
*
* This is a convenience which creates an instance of the {@link StartDeploymentRequest.Builder} avoiding the need
* to create one manually via {@link StartDeploymentRequest#builder()}
*
*
* @param startDeploymentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.StartDeploymentRequest.Builder} to create a request.
* The request structure for the start a deployment request.
* @return Result of the StartDeployment operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.StartDeployment
* @see AWS API
* Documentation
*/
default StartDeploymentResponse startDeployment(Consumer startDeploymentRequest)
throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException,
LimitExceededException, AwsServiceException, SdkClientException, AmplifyException {
return startDeployment(StartDeploymentRequest.builder().applyMutation(startDeploymentRequest).build());
}
/**
*
* Starts a new job for a branch of an Amplify app.
*
*
* @param startJobRequest
* The request structure for the start job request.
* @return Result of the StartJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.StartJob
* @see AWS API
* Documentation
*/
default StartJobResponse startJob(StartJobRequest startJobRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Starts a new job for a branch of an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link StartJobRequest.Builder} avoiding the need to
* create one manually via {@link StartJobRequest#builder()}
*
*
* @param startJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.StartJobRequest.Builder} to create a request. The
* request structure for the start job request.
* @return Result of the StartJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.StartJob
* @see AWS API
* Documentation
*/
default StartJobResponse startJob(Consumer startJobRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
return startJob(StartJobRequest.builder().applyMutation(startJobRequest).build());
}
/**
*
* 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 Result of the StopJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.StopJob
* @see AWS API
* Documentation
*/
default StopJobResponse stopJob(StopJobRequest stopJobRequest) throws BadRequestException, UnauthorizedException,
InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException,
AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Stops a job that is in progress for a branch of an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link StopJobRequest.Builder} avoiding the need to create
* one manually via {@link StopJobRequest#builder()}
*
*
* @param stopJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.StopJobRequest.Builder} to create a request. The
* request structure for the stop job request.
* @return Result of the StopJob operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws LimitExceededException
* A resource could not be created because service quotas were exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.StopJob
* @see AWS API
* Documentation
*/
default StopJobResponse stopJob(Consumer stopJobRequest) throws BadRequestException,
UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException,
SdkClientException, AmplifyException {
return stopJob(StopJobRequest.builder().applyMutation(stopJobRequest).build());
}
/**
*
* 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 Result of the TagResource operation returned by the service.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws BadRequestException
* A request contains unexpected data.
* @throws ResourceNotFoundException
* An operation failed due to a non-existent resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalFailureException,
BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Tags the resource with a tag key and value.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.TagResourceRequest.Builder} to create a request. The
* request structure to tag a resource with a tag key and value.
* @return Result of the TagResource operation returned by the service.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws BadRequestException
* A request contains unexpected data.
* @throws ResourceNotFoundException
* An operation failed due to a non-existent resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, AmplifyException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Untags a resource with a specified Amazon Resource Name (ARN).
*
*
* @param untagResourceRequest
* The request structure for the untag resource request.
* @return Result of the UntagResource operation returned by the service.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws BadRequestException
* A request contains unexpected data.
* @throws ResourceNotFoundException
* An operation failed due to a non-existent resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalFailureException,
BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Untags a resource with a specified Amazon Resource Name (ARN).
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.UntagResourceRequest.Builder} to create a request.
* The request structure for the untag resource request.
* @return Result of the UntagResource operation returned by the service.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws BadRequestException
* A request contains unexpected data.
* @throws ResourceNotFoundException
* An operation failed due to a non-existent resource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException,
SdkClientException, AmplifyException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an existing Amplify app.
*
*
* @param updateAppRequest
* The request structure for the update app request.
* @return Result of the UpdateApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateApp
* @see AWS API
* Documentation
*/
default UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws BadRequestException, NotFoundException,
UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAppRequest.Builder} avoiding the need to
* create one manually via {@link UpdateAppRequest#builder()}
*
*
* @param updateAppRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.UpdateAppRequest.Builder} to create a request. The
* request structure for the update app request.
* @return Result of the UpdateApp operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateApp
* @see AWS API
* Documentation
*/
default UpdateAppResponse updateApp(Consumer updateAppRequest) throws BadRequestException,
NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException,
AmplifyException {
return updateApp(UpdateAppRequest.builder().applyMutation(updateAppRequest).build());
}
/**
*
* Updates a branch for an Amplify app.
*
*
* @param updateBranchRequest
* The request structure for the update branch request.
* @return Result of the UpdateBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateBranch
* @see AWS API
* Documentation
*/
default UpdateBranchResponse updateBranch(UpdateBranchRequest updateBranchRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a branch for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateBranchRequest.Builder} avoiding the need to
* create one manually via {@link UpdateBranchRequest#builder()}
*
*
* @param updateBranchRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.UpdateBranchRequest.Builder} to create a request. The
* request structure for the update branch request.
* @return Result of the UpdateBranch operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateBranch
* @see AWS API
* Documentation
*/
default UpdateBranchResponse updateBranch(Consumer updateBranchRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
return updateBranch(UpdateBranchRequest.builder().applyMutation(updateBranchRequest).build());
}
/**
*
* Creates a new domain association for an Amplify app.
*
*
* @param updateDomainAssociationRequest
* The request structure for the update domain association request.
* @return Result of the UpdateDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateDomainAssociation
* @see AWS API Documentation
*/
default UpdateDomainAssociationResponse updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new domain association for an Amplify app.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDomainAssociationRequest.Builder} avoiding
* the need to create one manually via {@link UpdateDomainAssociationRequest#builder()}
*
*
* @param updateDomainAssociationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.UpdateDomainAssociationRequest.Builder} to create a
* request. The request structure for the update domain association request.
* @return Result of the UpdateDomainAssociation operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateDomainAssociation
* @see AWS API Documentation
*/
default UpdateDomainAssociationResponse updateDomainAssociation(
Consumer updateDomainAssociationRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
return updateDomainAssociation(UpdateDomainAssociationRequest.builder().applyMutation(updateDomainAssociationRequest)
.build());
}
/**
*
* Updates a webhook.
*
*
* @param updateWebhookRequest
* The request structure for the update webhook request.
* @return Result of the UpdateWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateWebhook
* @see AWS API
* Documentation
*/
default UpdateWebhookResponse updateWebhook(UpdateWebhookRequest updateWebhookRequest) throws BadRequestException,
UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException,
AwsServiceException, SdkClientException, AmplifyException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a webhook.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateWebhookRequest.Builder} avoiding the need to
* create one manually via {@link UpdateWebhookRequest#builder()}
*
*
* @param updateWebhookRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.amplify.model.UpdateWebhookRequest.Builder} to create a request.
* The request structure for the update webhook request.
* @return Result of the UpdateWebhook operation returned by the service.
* @throws BadRequestException
* A request contains unexpected data.
* @throws UnauthorizedException
* An operation failed due to a lack of access.
* @throws NotFoundException
* An entity was not found during an operation.
* @throws InternalFailureException
* The service failed to perform an operation due to an internal issue.
* @throws DependentServiceFailureException
* An operation failed because a dependent service threw an exception.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws AmplifyException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample AmplifyClient.UpdateWebhook
* @see AWS API
* Documentation
*/
default UpdateWebhookResponse updateWebhook(Consumer updateWebhookRequest)
throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException,
DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException {
return updateWebhook(UpdateWebhookRequest.builder().applyMutation(updateWebhookRequest).build());
}
/**
* Create a {@link AmplifyClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static AmplifyClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link AmplifyClient}.
*/
static AmplifyClientBuilder builder() {
return new DefaultAmplifyClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default AmplifyServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy