Interface AmplifyClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AmplifyClient extends AwsClient
Service client for accessing Amplify. This can be created using the staticbuilder()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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static AmplifyClientBuilderbuilder()Create a builder that can be used to configure and create aAmplifyClient.static AmplifyClientcreate()Create aAmplifyClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAppResponsecreateApp(Consumer<CreateAppRequest.Builder> createAppRequest)Creates a new Amplify app.default CreateAppResponsecreateApp(CreateAppRequest createAppRequest)Creates a new Amplify app.default CreateBackendEnvironmentResponsecreateBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest)Creates a new backend environment for an Amplify app.default CreateBackendEnvironmentResponsecreateBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)Creates a new backend environment for an Amplify app.default CreateBranchResponsecreateBranch(Consumer<CreateBranchRequest.Builder> createBranchRequest)Creates a new branch for an Amplify app.default CreateBranchResponsecreateBranch(CreateBranchRequest createBranchRequest)Creates a new branch for an Amplify app.default CreateDeploymentResponsecreateDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)Creates a deployment for a manually deployed Amplify app.default CreateDeploymentResponsecreateDeployment(CreateDeploymentRequest createDeploymentRequest)Creates a deployment for a manually deployed Amplify app.default CreateDomainAssociationResponsecreateDomainAssociation(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest)Creates a new domain association for an Amplify app.default CreateDomainAssociationResponsecreateDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)Creates a new domain association for an Amplify app.default CreateWebhookResponsecreateWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)Creates a new webhook on an Amplify app.default CreateWebhookResponsecreateWebhook(CreateWebhookRequest createWebhookRequest)Creates a new webhook on an Amplify app.default DeleteAppResponsedeleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)Deletes an existing Amplify app specified by an app ID.default DeleteAppResponsedeleteApp(DeleteAppRequest deleteAppRequest)Deletes an existing Amplify app specified by an app ID.default DeleteBackendEnvironmentResponsedeleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest)Deletes a backend environment for an Amplify app.default DeleteBackendEnvironmentResponsedeleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)Deletes a backend environment for an Amplify app.default DeleteBranchResponsedeleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest)Deletes a branch for an Amplify app.default DeleteBranchResponsedeleteBranch(DeleteBranchRequest deleteBranchRequest)Deletes a branch for an Amplify app.default DeleteDomainAssociationResponsedeleteDomainAssociation(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest)Deletes a domain association for an Amplify app.default DeleteDomainAssociationResponsedeleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)Deletes a domain association for an Amplify app.default DeleteJobResponsedeleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)Deletes a job for a branch of an Amplify app.default DeleteJobResponsedeleteJob(DeleteJobRequest deleteJobRequest)Deletes a job for a branch of an Amplify app.default DeleteWebhookResponsedeleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)Deletes a webhook.default DeleteWebhookResponsedeleteWebhook(DeleteWebhookRequest deleteWebhookRequest)Deletes a webhook.default GenerateAccessLogsResponsegenerateAccessLogs(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest)Returns the website access logs for a specific time range using a presigned URL.default GenerateAccessLogsResponsegenerateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)Returns the website access logs for a specific time range using a presigned URL.default GetAppResponsegetApp(Consumer<GetAppRequest.Builder> getAppRequest)Returns an existing Amplify app specified by an app ID.default GetAppResponsegetApp(GetAppRequest getAppRequest)Returns an existing Amplify app specified by an app ID.default GetArtifactUrlResponsegetArtifactUrl(Consumer<GetArtifactUrlRequest.Builder> getArtifactUrlRequest)Returns the artifact info that corresponds to an artifact id.default GetArtifactUrlResponsegetArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)Returns the artifact info that corresponds to an artifact id.default GetBackendEnvironmentResponsegetBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest)Returns a backend environment for an Amplify app.default GetBackendEnvironmentResponsegetBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)Returns a backend environment for an Amplify app.default GetBranchResponsegetBranch(Consumer<GetBranchRequest.Builder> getBranchRequest)Returns a branch for an Amplify app.default GetBranchResponsegetBranch(GetBranchRequest getBranchRequest)Returns a branch for an Amplify app.default GetDomainAssociationResponsegetDomainAssociation(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest)Returns the domain information for an Amplify app.default GetDomainAssociationResponsegetDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)Returns the domain information for an Amplify app.default GetJobResponsegetJob(Consumer<GetJobRequest.Builder> getJobRequest)Returns a job for a branch of an Amplify app.default GetJobResponsegetJob(GetJobRequest getJobRequest)Returns a job for a branch of an Amplify app.default GetWebhookResponsegetWebhook(Consumer<GetWebhookRequest.Builder> getWebhookRequest)Returns the webhook information that corresponds to a specified webhook ID.default GetWebhookResponsegetWebhook(GetWebhookRequest getWebhookRequest)Returns the webhook information that corresponds to a specified webhook ID.default ListAppsResponselistApps()Returns a list of the existing Amplify apps.default ListAppsResponselistApps(Consumer<ListAppsRequest.Builder> listAppsRequest)Returns a list of the existing Amplify apps.default ListAppsResponselistApps(ListAppsRequest listAppsRequest)Returns a list of the existing Amplify apps.default ListAppsIterablelistAppsPaginator()This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)operation.default ListAppsIterablelistAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)operation.default ListAppsIterablelistAppsPaginator(ListAppsRequest listAppsRequest)This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)operation.default ListArtifactsResponselistArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)Returns a list of artifacts for a specified app, branch, and job.default ListArtifactsResponselistArtifacts(ListArtifactsRequest listArtifactsRequest)Returns a list of artifacts for a specified app, branch, and job.default ListBackendEnvironmentsResponselistBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest)Lists the backend environments for an Amplify app.default ListBackendEnvironmentsResponselistBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)Lists the backend environments for an Amplify app.default ListBranchesResponselistBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)Lists the branches of an Amplify app.default ListBranchesResponselistBranches(ListBranchesRequest listBranchesRequest)Lists the branches of an Amplify app.default ListBranchesIterablelistBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest)This is a variant oflistBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)operation.default ListBranchesIterablelistBranchesPaginator(ListBranchesRequest listBranchesRequest)This is a variant oflistBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)operation.default ListDomainAssociationsResponselistDomainAssociations(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)Returns the domain associations for an Amplify app.default ListDomainAssociationsResponselistDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)Returns the domain associations for an Amplify app.default ListDomainAssociationsIterablelistDomainAssociationsPaginator(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)This is a variant oflistDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)operation.default ListDomainAssociationsIterablelistDomainAssociationsPaginator(ListDomainAssociationsRequest listDomainAssociationsRequest)This is a variant oflistDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)operation.default ListJobsResponselistJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)Lists the jobs for a branch of an Amplify app.default ListJobsResponselistJobs(ListJobsRequest listJobsRequest)Lists the jobs for a branch of an Amplify app.default ListJobsIterablelistJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)This is a variant oflistJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)operation.default ListJobsIterablelistJobsPaginator(ListJobsRequest listJobsRequest)This is a variant oflistJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags for a specified Amazon Resource Name (ARN).default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags for a specified Amazon Resource Name (ARN).default ListWebhooksResponselistWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)Returns a list of webhooks for an Amplify app.default ListWebhooksResponselistWebhooks(ListWebhooksRequest listWebhooksRequest)Returns a list of webhooks for an Amplify app.default AmplifyServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartDeploymentResponsestartDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest)Starts a deployment for a manually deployed app.default StartDeploymentResponsestartDeployment(StartDeploymentRequest startDeploymentRequest)Starts a deployment for a manually deployed app.default StartJobResponsestartJob(Consumer<StartJobRequest.Builder> startJobRequest)Starts a new job for a branch of an Amplify app.default StartJobResponsestartJob(StartJobRequest startJobRequest)Starts a new job for a branch of an Amplify app.default StopJobResponsestopJob(Consumer<StopJobRequest.Builder> stopJobRequest)Stops a job that is in progress for a branch of an Amplify app.default StopJobResponsestopJob(StopJobRequest stopJobRequest)Stops a job that is in progress for a branch of an Amplify app.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Tags the resource with a tag key and value.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Tags the resource with a tag key and value.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Untags a resource with a specified Amazon Resource Name (ARN).default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Untags a resource with a specified Amazon Resource Name (ARN).default UpdateAppResponseupdateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)Updates an existing Amplify app.default UpdateAppResponseupdateApp(UpdateAppRequest updateAppRequest)Updates an existing Amplify app.default UpdateBranchResponseupdateBranch(Consumer<UpdateBranchRequest.Builder> updateBranchRequest)Updates a branch for an Amplify app.default UpdateBranchResponseupdateBranch(UpdateBranchRequest updateBranchRequest)Updates a branch for an Amplify app.default UpdateDomainAssociationResponseupdateDomainAssociation(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest)Creates a new domain association for an Amplify app.default UpdateDomainAssociationResponseupdateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)Creates a new domain association for an Amplify app.default UpdateWebhookResponseupdateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)Updates a webhook.default UpdateWebhookResponseupdateWebhook(UpdateWebhookRequest updateWebhookRequest)Updates a webhook.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createApp
default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new Amplify app.
- Parameters:
createAppRequest- The request structure used to create apps in Amplify.- Returns:
- Result of the CreateApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createApp
default CreateAppResponse createApp(Consumer<CreateAppRequest.Builder> createAppRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new Amplify app.
This is a convenience which creates an instance of the
CreateAppRequest.Builderavoiding the need to create one manually viaCreateAppRequest.builder()- Parameters:
createAppRequest- AConsumerthat will call methods onCreateAppRequest.Builderto create a request. The request structure used to create apps in Amplify.- Returns:
- Result of the CreateApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBackendEnvironment
default CreateBackendEnvironmentResponse createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Creates a new backend environment for an Amplify app.
- Parameters:
createBackendEnvironmentRequest- The request structure for the backend environment create request.- Returns:
- Result of the CreateBackendEnvironment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBackendEnvironment
default CreateBackendEnvironmentResponse createBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Creates a new backend environment for an Amplify app.
This is a convenience which creates an instance of the
CreateBackendEnvironmentRequest.Builderavoiding the need to create one manually viaCreateBackendEnvironmentRequest.builder()- Parameters:
createBackendEnvironmentRequest- AConsumerthat will call methods onCreateBackendEnvironmentRequest.Builderto create a request. The request structure for the backend environment create request.- Returns:
- Result of the CreateBackendEnvironment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBranch
default CreateBranchResponse createBranch(CreateBranchRequest createBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new branch for an Amplify app.
- Parameters:
createBranchRequest- The request structure for the create branch request.- Returns:
- Result of the CreateBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBranch
default CreateBranchResponse createBranch(Consumer<CreateBranchRequest.Builder> createBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new branch for an Amplify app.
This is a convenience which creates an instance of the
CreateBranchRequest.Builderavoiding the need to create one manually viaCreateBranchRequest.builder()- Parameters:
createBranchRequest- AConsumerthat will call methods onCreateBranchRequest.Builderto create a request. The request structure for the create branch request.- Returns:
- Result of the CreateBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDeployment
default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
The maximum duration between the
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill fail.- Parameters:
createDeploymentRequest- The request structure for the create a new deployment request.- Returns:
- Result of the CreateDeployment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDeployment
default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
The maximum duration between the
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill fail.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builderavoiding the need to create one manually viaCreateDeploymentRequest.builder()- Parameters:
createDeploymentRequest- AConsumerthat will call methods onCreateDeploymentRequest.Builderto create a request. The request structure for the create a new deployment request.- Returns:
- Result of the CreateDeployment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDomainAssociation
default CreateDomainAssociationResponse createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
- Parameters:
createDomainAssociationRequest- The request structure for the create domain association request.- Returns:
- Result of the CreateDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDomainAssociation
default CreateDomainAssociationResponse createDomainAssociation(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
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
CreateDomainAssociationRequest.Builderavoiding the need to create one manually viaCreateDomainAssociationRequest.builder()- Parameters:
createDomainAssociationRequest- AConsumerthat will call methods onCreateDomainAssociationRequest.Builderto create a request. The request structure for the create domain association request.- Returns:
- Result of the CreateDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWebhook
default CreateWebhookResponse createWebhook(CreateWebhookRequest createWebhookRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new webhook on an Amplify app.
- Parameters:
createWebhookRequest- The request structure for the create webhook request.- Returns:
- Result of the CreateWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createWebhook
default CreateWebhookResponse createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new webhook on an Amplify app.
This is a convenience which creates an instance of the
CreateWebhookRequest.Builderavoiding the need to create one manually viaCreateWebhookRequest.builder()- Parameters:
createWebhookRequest- AConsumerthat will call methods onCreateWebhookRequest.Builderto create a request. The request structure for the create webhook request.- Returns:
- Result of the CreateWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApp
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes an existing Amplify app specified by an app ID.
- Parameters:
deleteAppRequest- Describes the request structure for the delete app request.- Returns:
- Result of the DeleteApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.NotFoundException- An entity was not found during an operation.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApp
default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes an existing Amplify app specified by an app ID.
This is a convenience which creates an instance of the
DeleteAppRequest.Builderavoiding the need to create one manually viaDeleteAppRequest.builder()- Parameters:
deleteAppRequest- AConsumerthat will call methods onDeleteAppRequest.Builderto create a request. Describes the request structure for the delete app request.- Returns:
- Result of the DeleteApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.NotFoundException- An entity was not found during an operation.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBackendEnvironment
default DeleteBackendEnvironmentResponse deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes a backend environment for an Amplify app.
- Parameters:
deleteBackendEnvironmentRequest- The request structure for the delete backend environment request.- Returns:
- Result of the DeleteBackendEnvironment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBackendEnvironment
default DeleteBackendEnvironmentResponse deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes a backend environment for an Amplify app.
This is a convenience which creates an instance of the
DeleteBackendEnvironmentRequest.Builderavoiding the need to create one manually viaDeleteBackendEnvironmentRequest.builder()- Parameters:
deleteBackendEnvironmentRequest- AConsumerthat will call methods onDeleteBackendEnvironmentRequest.Builderto create a request. The request structure for the delete backend environment request.- Returns:
- Result of the DeleteBackendEnvironment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBranch
default DeleteBranchResponse deleteBranch(DeleteBranchRequest deleteBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes a branch for an Amplify app.
- Parameters:
deleteBranchRequest- The request structure for the delete branch request.- Returns:
- Result of the DeleteBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBranch
default DeleteBranchResponse deleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes a branch for an Amplify app.
This is a convenience which creates an instance of the
DeleteBranchRequest.Builderavoiding the need to create one manually viaDeleteBranchRequest.builder()- Parameters:
deleteBranchRequest- AConsumerthat will call methods onDeleteBranchRequest.Builderto create a request. The request structure for the delete branch request.- Returns:
- Result of the DeleteBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDomainAssociation
default DeleteDomainAssociationResponse deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes a domain association for an Amplify app.
- Parameters:
deleteDomainAssociationRequest- The request structure for the delete domain association request.- Returns:
- Result of the DeleteDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDomainAssociation
default DeleteDomainAssociationResponse deleteDomainAssociation(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Deletes a domain association for an Amplify app.
This is a convenience which creates an instance of the
DeleteDomainAssociationRequest.Builderavoiding the need to create one manually viaDeleteDomainAssociationRequest.builder()- Parameters:
deleteDomainAssociationRequest- AConsumerthat will call methods onDeleteDomainAssociationRequest.Builderto create a request. The request structure for the delete domain association request.- Returns:
- Result of the DeleteDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteJob
default DeleteJobResponse deleteJob(DeleteJobRequest deleteJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Deletes a job for a branch of an Amplify app.
- Parameters:
deleteJobRequest- The request structure for the delete job request.- Returns:
- Result of the DeleteJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteJob
default DeleteJobResponse deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Deletes a job for a branch of an Amplify app.
This is a convenience which creates an instance of the
DeleteJobRequest.Builderavoiding the need to create one manually viaDeleteJobRequest.builder()- Parameters:
deleteJobRequest- AConsumerthat will call methods onDeleteJobRequest.Builderto create a request. The request structure for the delete job request.- Returns:
- Result of the DeleteJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWebhook
default DeleteWebhookResponse deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Deletes a webhook.
- Parameters:
deleteWebhookRequest- The request structure for the delete webhook request.- Returns:
- Result of the DeleteWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWebhook
default DeleteWebhookResponse deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Deletes a webhook.
This is a convenience which creates an instance of the
DeleteWebhookRequest.Builderavoiding the need to create one manually viaDeleteWebhookRequest.builder()- Parameters:
deleteWebhookRequest- AConsumerthat will call methods onDeleteWebhookRequest.Builderto create a request. The request structure for the delete webhook request.- Returns:
- Result of the DeleteWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
generateAccessLogs
default GenerateAccessLogsResponse generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest) throws NotFoundException, BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns the website access logs for a specific time range using a presigned URL.
- Parameters:
generateAccessLogsRequest- The request structure for the generate access logs request.- Returns:
- Result of the GenerateAccessLogs operation returned by the service.
- Throws:
NotFoundException- An entity was not found during an operation.BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
generateAccessLogs
default GenerateAccessLogsResponse generateAccessLogs(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest) throws NotFoundException, BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns the website access logs for a specific time range using a presigned URL.
This is a convenience which creates an instance of the
GenerateAccessLogsRequest.Builderavoiding the need to create one manually viaGenerateAccessLogsRequest.builder()- Parameters:
generateAccessLogsRequest- AConsumerthat will call methods onGenerateAccessLogsRequest.Builderto create a request. The request structure for the generate access logs request.- Returns:
- Result of the GenerateAccessLogs operation returned by the service.
- Throws:
NotFoundException- An entity was not found during an operation.BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApp
default GetAppResponse getApp(GetAppRequest getAppRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns an existing Amplify app specified by an app ID.
- Parameters:
getAppRequest- The request structure for the get app request.- Returns:
- Result of the GetApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.NotFoundException- An entity was not found during an operation.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getApp
default GetAppResponse getApp(Consumer<GetAppRequest.Builder> getAppRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns an existing Amplify app specified by an app ID.
This is a convenience which creates an instance of the
GetAppRequest.Builderavoiding the need to create one manually viaGetAppRequest.builder()- Parameters:
getAppRequest- AConsumerthat will call methods onGetAppRequest.Builderto create a request. The request structure for the get app request.- Returns:
- Result of the GetApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.NotFoundException- An entity was not found during an operation.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getArtifactUrl
default GetArtifactUrlResponse getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns the artifact info that corresponds to an artifact id.
- Parameters:
getArtifactUrlRequest- Returns the request structure for the get artifact request.- Returns:
- Result of the GetArtifactUrl operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getArtifactUrl
default GetArtifactUrlResponse getArtifactUrl(Consumer<GetArtifactUrlRequest.Builder> getArtifactUrlRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns the artifact info that corresponds to an artifact id.
This is a convenience which creates an instance of the
GetArtifactUrlRequest.Builderavoiding the need to create one manually viaGetArtifactUrlRequest.builder()- Parameters:
getArtifactUrlRequest- AConsumerthat will call methods onGetArtifactUrlRequest.Builderto create a request. Returns the request structure for the get artifact request.- Returns:
- Result of the GetArtifactUrl operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getBackendEnvironment
default GetBackendEnvironmentResponse getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a backend environment for an Amplify app.
- Parameters:
getBackendEnvironmentRequest- The request structure for the get backend environment request.- Returns:
- Result of the GetBackendEnvironment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getBackendEnvironment
default GetBackendEnvironmentResponse getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a backend environment for an Amplify app.
This is a convenience which creates an instance of the
GetBackendEnvironmentRequest.Builderavoiding the need to create one manually viaGetBackendEnvironmentRequest.builder()- Parameters:
getBackendEnvironmentRequest- AConsumerthat will call methods onGetBackendEnvironmentRequest.Builderto create a request. The request structure for the get backend environment request.- Returns:
- Result of the GetBackendEnvironment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getBranch
default GetBranchResponse getBranch(GetBranchRequest getBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a branch for an Amplify app.
- Parameters:
getBranchRequest- The request structure for the get branch request.- Returns:
- Result of the GetBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getBranch
default GetBranchResponse getBranch(Consumer<GetBranchRequest.Builder> getBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a branch for an Amplify app.
This is a convenience which creates an instance of the
GetBranchRequest.Builderavoiding the need to create one manually viaGetBranchRequest.builder()- Parameters:
getBranchRequest- AConsumerthat will call methods onGetBranchRequest.Builderto create a request. The request structure for the get branch request.- Returns:
- Result of the GetBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDomainAssociation
default GetDomainAssociationResponse getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns the domain information for an Amplify app.
- Parameters:
getDomainAssociationRequest- The request structure for the get domain association request.- Returns:
- Result of the GetDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDomainAssociation
default GetDomainAssociationResponse getDomainAssociation(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns the domain information for an Amplify app.
This is a convenience which creates an instance of the
GetDomainAssociationRequest.Builderavoiding the need to create one manually viaGetDomainAssociationRequest.builder()- Parameters:
getDomainAssociationRequest- AConsumerthat will call methods onGetDomainAssociationRequest.Builderto create a request. The request structure for the get domain association request.- Returns:
- Result of the GetDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getJob
default GetJobResponse getJob(GetJobRequest getJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns a job for a branch of an Amplify app.
- Parameters:
getJobRequest- The request structure for the get job request.- Returns:
- Result of the GetJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getJob
default GetJobResponse getJob(Consumer<GetJobRequest.Builder> getJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns a job for a branch of an Amplify app.
This is a convenience which creates an instance of the
GetJobRequest.Builderavoiding the need to create one manually viaGetJobRequest.builder()- Parameters:
getJobRequest- AConsumerthat will call methods onGetJobRequest.Builderto create a request. The request structure for the get job request.- Returns:
- Result of the GetJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWebhook
default GetWebhookResponse getWebhook(GetWebhookRequest getWebhookRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns the webhook information that corresponds to a specified webhook ID.
- Parameters:
getWebhookRequest- The request structure for the get webhook request.- Returns:
- Result of the GetWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getWebhook
default GetWebhookResponse getWebhook(Consumer<GetWebhookRequest.Builder> getWebhookRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns the webhook information that corresponds to a specified webhook ID.
This is a convenience which creates an instance of the
GetWebhookRequest.Builderavoiding the need to create one manually viaGetWebhookRequest.builder()- Parameters:
getWebhookRequest- AConsumerthat will call methods onGetWebhookRequest.Builderto create a request. The request structure for the get webhook request.- Returns:
- Result of the GetWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps(ListAppsRequest listAppsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of the existing Amplify apps.
- Parameters:
listAppsRequest- The request structure for the list apps request.- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps(Consumer<ListAppsRequest.Builder> listAppsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of the existing Amplify apps.
This is a convenience which creates an instance of the
ListAppsRequest.Builderavoiding the need to create one manually viaListAppsRequest.builder()- Parameters:
listAppsRequest- AConsumerthat will call methods onListAppsRequest.Builderto create a request. The request structure for the list apps request.- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps() throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of the existing Amplify apps.
- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listApps(ListAppsRequest), AWS API Documentation
-
listAppsPaginator
default ListAppsIterable listAppsPaginator() throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listAppsPaginator(ListAppsRequest), AWS API Documentation
-
listAppsPaginator
default ListAppsIterable listAppsPaginator(ListAppsRequest listAppsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)operation.- Parameters:
listAppsRequest- The request structure for the list apps request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAppsPaginator
default ListAppsIterable listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListAppsIterable responses = client.listAppsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)operation.
This is a convenience which creates an instance of the
ListAppsRequest.Builderavoiding the need to create one manually viaListAppsRequest.builder()- Parameters:
listAppsRequest- AConsumerthat will call methods onListAppsRequest.Builderto create a request. The request structure for the list apps request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listArtifacts
default ListArtifactsResponse listArtifacts(ListArtifactsRequest listArtifactsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of artifacts for a specified app, branch, and job.
- Parameters:
listArtifactsRequest- Describes the request structure for the list artifacts request.- Returns:
- Result of the ListArtifacts operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listArtifacts
default ListArtifactsResponse listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of artifacts for a specified app, branch, and job.
This is a convenience which creates an instance of the
ListArtifactsRequest.Builderavoiding the need to create one manually viaListArtifactsRequest.builder()- Parameters:
listArtifactsRequest- AConsumerthat will call methods onListArtifactsRequest.Builderto create a request. Describes the request structure for the list artifacts request.- Returns:
- Result of the ListArtifacts operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBackendEnvironments
default ListBackendEnvironmentsResponse listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Lists the backend environments for an Amplify app.
- Parameters:
listBackendEnvironmentsRequest- The request structure for the list backend environments request.- Returns:
- Result of the ListBackendEnvironments operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBackendEnvironments
default ListBackendEnvironmentsResponse listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Lists the backend environments for an Amplify app.
This is a convenience which creates an instance of the
ListBackendEnvironmentsRequest.Builderavoiding the need to create one manually viaListBackendEnvironmentsRequest.builder()- Parameters:
listBackendEnvironmentsRequest- AConsumerthat will call methods onListBackendEnvironmentsRequest.Builderto create a request. The request structure for the list backend environments request.- Returns:
- Result of the ListBackendEnvironments operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBranches
default ListBranchesResponse listBranches(ListBranchesRequest listBranchesRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Lists the branches of an Amplify app.
- Parameters:
listBranchesRequest- The request structure for the list branches request.- Returns:
- Result of the ListBranches operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBranches
default ListBranchesResponse listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Lists the branches of an Amplify app.
This is a convenience which creates an instance of the
ListBranchesRequest.Builderavoiding the need to create one manually viaListBranchesRequest.builder()- Parameters:
listBranchesRequest- AConsumerthat will call methods onListBranchesRequest.Builderto create a request. The request structure for the list branches request.- Returns:
- Result of the ListBranches operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBranchesPaginator
default ListBranchesIterable listBranchesPaginator(ListBranchesRequest listBranchesRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)operation.- Parameters:
listBranchesRequest- The request structure for the list branches request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBranchesPaginator
default ListBranchesIterable listBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListBranchesIterable responses = client.listBranchesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)operation.
This is a convenience which creates an instance of the
ListBranchesRequest.Builderavoiding the need to create one manually viaListBranchesRequest.builder()- Parameters:
listBranchesRequest- AConsumerthat will call methods onListBranchesRequest.Builderto create a request. The request structure for the list branches request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainAssociations
default ListDomainAssociationsResponse listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns the domain associations for an Amplify app.
- Parameters:
listDomainAssociationsRequest- The request structure for the list domain associations request.- Returns:
- Result of the ListDomainAssociations operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainAssociations
default ListDomainAssociationsResponse listDomainAssociations(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Returns the domain associations for an Amplify app.
This is a convenience which creates an instance of the
ListDomainAssociationsRequest.Builderavoiding the need to create one manually viaListDomainAssociationsRequest.builder()- Parameters:
listDomainAssociationsRequest- AConsumerthat will call methods onListDomainAssociationsRequest.Builderto create a request. The request structure for the list domain associations request.- Returns:
- Result of the ListDomainAssociations operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainAssociationsPaginator
default ListDomainAssociationsIterable listDomainAssociationsPaginator(ListDomainAssociationsRequest listDomainAssociationsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client.listDomainAssociationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)operation.- Parameters:
listDomainAssociationsRequest- The request structure for the list domain associations request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainAssociationsPaginator
default ListDomainAssociationsIterable listDomainAssociationsPaginator(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsIterable responses = client.listDomainAssociationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListDomainAssociationsRequest.Builderavoiding the need to create one manually viaListDomainAssociationsRequest.builder()- Parameters:
listDomainAssociationsRequest- AConsumerthat will call methods onListDomainAssociationsRequest.Builderto create a request. The request structure for the list domain associations request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listJobs
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Lists the jobs for a branch of an Amplify app.
- Parameters:
listJobsRequest- The request structure for the list jobs request.- Returns:
- Result of the ListJobs operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listJobs
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Lists the jobs for a branch of an Amplify app.
This is a convenience which creates an instance of the
ListJobsRequest.Builderavoiding the need to create one manually viaListJobsRequest.builder()- Parameters:
listJobsRequest- AConsumerthat will call methods onListJobsRequest.Builderto create a request. The request structure for the list jobs request.- Returns:
- Result of the ListJobs operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)operation.- Parameters:
listJobsRequest- The request structure for the list jobs request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
This is a variant of
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
2) Using For loopsoftware.amazon.awssdk.services.amplify.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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
listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)operation.
This is a convenience which creates an instance of the
ListJobsRequest.Builderavoiding the need to create one manually viaListJobsRequest.builder()- Parameters:
listJobsRequest- AConsumerthat will call methods onListJobsRequest.Builderto create a request. The request structure for the list jobs request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of tags for a specified Amazon Resource Name (ARN).
- Parameters:
listTagsForResourceRequest- The request structure to use to list tags for a resource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalFailureException- The service failed to perform an operation due to an internal issue.BadRequestException- A request contains unexpected data.ResourceNotFoundException- An operation failed due to a non-existent resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of tags for a specified Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. The request structure to use to list tags for a resource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalFailureException- The service failed to perform an operation due to an internal issue.BadRequestException- A request contains unexpected data.ResourceNotFoundException- An operation failed due to a non-existent resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWebhooks
default ListWebhooksResponse listWebhooks(ListWebhooksRequest listWebhooksRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of webhooks for an Amplify app.
- Parameters:
listWebhooksRequest- The request structure for the list webhooks request.- Returns:
- Result of the ListWebhooks operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listWebhooks
default ListWebhooksResponse listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Returns a list of webhooks for an Amplify app.
This is a convenience which creates an instance of the
ListWebhooksRequest.Builderavoiding the need to create one manually viaListWebhooksRequest.builder()- Parameters:
listWebhooksRequest- AConsumerthat will call methods onListWebhooksRequest.Builderto create a request. The request structure for the list webhooks request.- Returns:
- Result of the ListWebhooks operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startDeployment
default StartDeploymentResponse startDeployment(StartDeploymentRequest startDeploymentRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
The maximum duration between the
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill fail.- Parameters:
startDeploymentRequest- The request structure for the start a deployment request.- Returns:
- Result of the StartDeployment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startDeployment
default StartDeploymentResponse startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
The maximum duration between the
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill fail.
This is a convenience which creates an instance of the
StartDeploymentRequest.Builderavoiding the need to create one manually viaStartDeploymentRequest.builder()- Parameters:
startDeploymentRequest- AConsumerthat will call methods onStartDeploymentRequest.Builderto create a request. The request structure for the start a deployment request.- Returns:
- Result of the StartDeployment operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startJob
default StartJobResponse startJob(StartJobRequest startJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Starts a new job for a branch of an Amplify app.
- Parameters:
startJobRequest- The request structure for the start job request.- Returns:
- Result of the StartJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startJob
default StartJobResponse startJob(Consumer<StartJobRequest.Builder> startJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Starts a new job for a branch of an Amplify app.
This is a convenience which creates an instance of the
StartJobRequest.Builderavoiding the need to create one manually viaStartJobRequest.builder()- Parameters:
startJobRequest- AConsumerthat will call methods onStartJobRequest.Builderto create a request. The request structure for the start job request.- Returns:
- Result of the StartJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopJob
default StopJobResponse stopJob(StopJobRequest stopJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Stops a job that is in progress for a branch of an Amplify app.
- Parameters:
stopJobRequest- The request structure for the stop job request.- Returns:
- Result of the StopJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopJob
default StopJobResponse stopJob(Consumer<StopJobRequest.Builder> stopJobRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, NotFoundException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
Stops a job that is in progress for a branch of an Amplify app.
This is a convenience which creates an instance of the
StopJobRequest.Builderavoiding the need to create one manually viaStopJobRequest.builder()- Parameters:
stopJobRequest- AConsumerthat will call methods onStopJobRequest.Builderto create a request. The request structure for the stop job request.- Returns:
- Result of the StopJob operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.NotFoundException- An entity was not found during an operation.LimitExceededException- A resource could not be created because service quotas were exceeded.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException
Tags the resource with a tag key and value.
- Parameters:
tagResourceRequest- The request structure to tag a resource with a tag key and value.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalFailureException- The service failed to perform an operation due to an internal issue.BadRequestException- A request contains unexpected data.ResourceNotFoundException- An operation failed due to a non-existent resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException
Tags the resource with a tag key and value.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request. The request structure to tag a resource with a tag key and value.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalFailureException- The service failed to perform an operation due to an internal issue.BadRequestException- A request contains unexpected data.ResourceNotFoundException- An operation failed due to a non-existent resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException
Untags a resource with a specified Amazon Resource Name (ARN).
- Parameters:
untagResourceRequest- The request structure for the untag resource request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalFailureException- The service failed to perform an operation due to an internal issue.BadRequestException- A request contains unexpected data.ResourceNotFoundException- An operation failed due to a non-existent resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalFailureException, BadRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyException
Untags a resource with a specified Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request. The request structure for the untag resource request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalFailureException- The service failed to perform an operation due to an internal issue.BadRequestException- A request contains unexpected data.ResourceNotFoundException- An operation failed due to a non-existent resource.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApp
default UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Updates an existing Amplify app.
- Parameters:
updateAppRequest- The request structure for the update app request.- Returns:
- Result of the UpdateApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.NotFoundException- An entity was not found during an operation.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApp
default UpdateAppResponse updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest) throws BadRequestException, NotFoundException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Updates an existing Amplify app.
This is a convenience which creates an instance of the
UpdateAppRequest.Builderavoiding the need to create one manually viaUpdateAppRequest.builder()- Parameters:
updateAppRequest- AConsumerthat will call methods onUpdateAppRequest.Builderto create a request. The request structure for the update app request.- Returns:
- Result of the UpdateApp operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.NotFoundException- An entity was not found during an operation.UnauthorizedException- An operation failed due to a lack of access.InternalFailureException- The service failed to perform an operation due to an internal issue.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBranch
default UpdateBranchResponse updateBranch(UpdateBranchRequest updateBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Updates a branch for an Amplify app.
- Parameters:
updateBranchRequest- The request structure for the update branch request.- Returns:
- Result of the UpdateBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBranch
default UpdateBranchResponse updateBranch(Consumer<UpdateBranchRequest.Builder> updateBranchRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Updates a branch for an Amplify app.
This is a convenience which creates an instance of the
UpdateBranchRequest.Builderavoiding the need to create one manually viaUpdateBranchRequest.builder()- Parameters:
updateBranchRequest- AConsumerthat will call methods onUpdateBranchRequest.Builderto create a request. The request structure for the update branch request.- Returns:
- Result of the UpdateBranch operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDomainAssociation
default UpdateDomainAssociationResponse updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new domain association for an Amplify app.
- Parameters:
updateDomainAssociationRequest- The request structure for the update domain association request.- Returns:
- Result of the UpdateDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDomainAssociation
default UpdateDomainAssociationResponse updateDomainAssociation(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new domain association for an Amplify app.
This is a convenience which creates an instance of the
UpdateDomainAssociationRequest.Builderavoiding the need to create one manually viaUpdateDomainAssociationRequest.builder()- Parameters:
updateDomainAssociationRequest- AConsumerthat will call methods onUpdateDomainAssociationRequest.Builderto create a request. The request structure for the update domain association request.- Returns:
- Result of the UpdateDomainAssociation operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWebhook
default UpdateWebhookResponse updateWebhook(UpdateWebhookRequest updateWebhookRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Updates a webhook.
- Parameters:
updateWebhookRequest- The request structure for the update webhook request.- Returns:
- Result of the UpdateWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateWebhook
default UpdateWebhookResponse updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Updates a webhook.
This is a convenience which creates an instance of the
UpdateWebhookRequest.Builderavoiding the need to create one manually viaUpdateWebhookRequest.builder()- Parameters:
updateWebhookRequest- AConsumerthat will call methods onUpdateWebhookRequest.Builderto create a request. The request structure for the update webhook request.- Returns:
- Result of the UpdateWebhook operation returned by the service.
- Throws:
BadRequestException- A request contains unexpected data.UnauthorizedException- An operation failed due to a lack of access.NotFoundException- An entity was not found during an operation.InternalFailureException- The service failed to perform an operation due to an internal issue.DependentServiceFailureException- An operation failed because a dependent service threw an exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static AmplifyClient create()
Create aAmplifyClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static AmplifyClientBuilder builder()
Create a builder that can be used to configure and create aAmplifyClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default AmplifyServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-