Interface AmplifyClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AmplifyClientBuilder
builder()
Create a builder that can be used to configure and create aAmplifyClient
.static AmplifyClient
create()
Create aAmplifyClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAppResponse
createApp
(Consumer<CreateAppRequest.Builder> createAppRequest) Creates a new Amplify app.default CreateAppResponse
createApp
(CreateAppRequest createAppRequest) Creates a new Amplify app.default CreateBackendEnvironmentResponse
createBackendEnvironment
(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest) Creates a new backend environment for an Amplify app.default CreateBackendEnvironmentResponse
createBackendEnvironment
(CreateBackendEnvironmentRequest createBackendEnvironmentRequest) Creates a new backend environment for an Amplify app.default CreateBranchResponse
createBranch
(Consumer<CreateBranchRequest.Builder> createBranchRequest) Creates a new branch for an Amplify app.default CreateBranchResponse
createBranch
(CreateBranchRequest createBranchRequest) Creates a new branch for an Amplify app.default CreateDeploymentResponse
createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Creates a deployment for a manually deployed Amplify app.default CreateDeploymentResponse
createDeployment
(CreateDeploymentRequest createDeploymentRequest) Creates a deployment for a manually deployed Amplify app.default CreateDomainAssociationResponse
createDomainAssociation
(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest) Creates a new domain association for an Amplify app.default CreateDomainAssociationResponse
createDomainAssociation
(CreateDomainAssociationRequest createDomainAssociationRequest) Creates a new domain association for an Amplify app.default CreateWebhookResponse
createWebhook
(Consumer<CreateWebhookRequest.Builder> createWebhookRequest) Creates a new webhook on an Amplify app.default CreateWebhookResponse
createWebhook
(CreateWebhookRequest createWebhookRequest) Creates a new webhook on an Amplify app.default DeleteAppResponse
deleteApp
(Consumer<DeleteAppRequest.Builder> deleteAppRequest) Deletes an existing Amplify app specified by an app ID.default DeleteAppResponse
deleteApp
(DeleteAppRequest deleteAppRequest) Deletes an existing Amplify app specified by an app ID.default DeleteBackendEnvironmentResponse
deleteBackendEnvironment
(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest) Deletes a backend environment for an Amplify app.default DeleteBackendEnvironmentResponse
deleteBackendEnvironment
(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest) Deletes a backend environment for an Amplify app.default DeleteBranchResponse
deleteBranch
(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest) Deletes a branch for an Amplify app.default DeleteBranchResponse
deleteBranch
(DeleteBranchRequest deleteBranchRequest) Deletes a branch for an Amplify app.default DeleteDomainAssociationResponse
deleteDomainAssociation
(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest) Deletes a domain association for an Amplify app.default DeleteDomainAssociationResponse
deleteDomainAssociation
(DeleteDomainAssociationRequest deleteDomainAssociationRequest) Deletes a domain association for an Amplify app.default DeleteJobResponse
deleteJob
(Consumer<DeleteJobRequest.Builder> deleteJobRequest) Deletes a job for a branch of an Amplify app.default DeleteJobResponse
deleteJob
(DeleteJobRequest deleteJobRequest) Deletes a job for a branch of an Amplify app.default DeleteWebhookResponse
deleteWebhook
(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) Deletes a webhook.default DeleteWebhookResponse
deleteWebhook
(DeleteWebhookRequest deleteWebhookRequest) Deletes a webhook.default GenerateAccessLogsResponse
generateAccessLogs
(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest) Returns the website access logs for a specific time range using a presigned URL.default GenerateAccessLogsResponse
generateAccessLogs
(GenerateAccessLogsRequest generateAccessLogsRequest) Returns the website access logs for a specific time range using a presigned URL.default GetAppResponse
getApp
(Consumer<GetAppRequest.Builder> getAppRequest) Returns an existing Amplify app specified by an app ID.default GetAppResponse
getApp
(GetAppRequest getAppRequest) Returns an existing Amplify app specified by an app ID.default GetArtifactUrlResponse
getArtifactUrl
(Consumer<GetArtifactUrlRequest.Builder> getArtifactUrlRequest) Returns the artifact info that corresponds to an artifact id.default GetArtifactUrlResponse
getArtifactUrl
(GetArtifactUrlRequest getArtifactUrlRequest) Returns the artifact info that corresponds to an artifact id.default GetBackendEnvironmentResponse
getBackendEnvironment
(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest) Returns a backend environment for an Amplify app.default GetBackendEnvironmentResponse
getBackendEnvironment
(GetBackendEnvironmentRequest getBackendEnvironmentRequest) Returns a backend environment for an Amplify app.default GetBranchResponse
getBranch
(Consumer<GetBranchRequest.Builder> getBranchRequest) Returns a branch for an Amplify app.default GetBranchResponse
getBranch
(GetBranchRequest getBranchRequest) Returns a branch for an Amplify app.default GetDomainAssociationResponse
getDomainAssociation
(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest) Returns the domain information for an Amplify app.default GetDomainAssociationResponse
getDomainAssociation
(GetDomainAssociationRequest getDomainAssociationRequest) Returns the domain information for an Amplify app.default GetJobResponse
getJob
(Consumer<GetJobRequest.Builder> getJobRequest) Returns a job for a branch of an Amplify app.default GetJobResponse
getJob
(GetJobRequest getJobRequest) Returns a job for a branch of an Amplify app.default GetWebhookResponse
getWebhook
(Consumer<GetWebhookRequest.Builder> getWebhookRequest) Returns the webhook information that corresponds to a specified webhook ID.default GetWebhookResponse
getWebhook
(GetWebhookRequest getWebhookRequest) Returns the webhook information that corresponds to a specified webhook ID.default ListAppsResponse
listApps()
Returns a list of the existing Amplify apps.default ListAppsResponse
listApps
(Consumer<ListAppsRequest.Builder> listAppsRequest) Returns a list of the existing Amplify apps.default ListAppsResponse
listApps
(ListAppsRequest listAppsRequest) Returns a list of the existing Amplify apps.default ListAppsIterable
This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.default ListAppsIterable
listAppsPaginator
(Consumer<ListAppsRequest.Builder> listAppsRequest) This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.default ListAppsIterable
listAppsPaginator
(ListAppsRequest listAppsRequest) This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.default ListArtifactsResponse
listArtifacts
(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest) Returns a list of artifacts for a specified app, branch, and job.default ListArtifactsResponse
listArtifacts
(ListArtifactsRequest listArtifactsRequest) Returns a list of artifacts for a specified app, branch, and job.default ListBackendEnvironmentsResponse
listBackendEnvironments
(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest) Lists the backend environments for an Amplify app.default ListBackendEnvironmentsResponse
listBackendEnvironments
(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest) Lists the backend environments for an Amplify app.default ListBranchesResponse
listBranches
(Consumer<ListBranchesRequest.Builder> listBranchesRequest) Lists the branches of an Amplify app.default ListBranchesResponse
listBranches
(ListBranchesRequest listBranchesRequest) Lists the branches of an Amplify app.default ListBranchesIterable
listBranchesPaginator
(Consumer<ListBranchesRequest.Builder> listBranchesRequest) This is a variant oflistBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation.default ListBranchesIterable
listBranchesPaginator
(ListBranchesRequest listBranchesRequest) This is a variant oflistBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation.default ListDomainAssociationsResponse
listDomainAssociations
(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) Returns the domain associations for an Amplify app.default ListDomainAssociationsResponse
listDomainAssociations
(ListDomainAssociationsRequest listDomainAssociationsRequest) Returns the domain associations for an Amplify app.default ListDomainAssociationsIterable
listDomainAssociationsPaginator
(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) This is a variant oflistDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation.default ListDomainAssociationsIterable
listDomainAssociationsPaginator
(ListDomainAssociationsRequest listDomainAssociationsRequest) This is a variant oflistDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation.default ListJobsResponse
listJobs
(Consumer<ListJobsRequest.Builder> listJobsRequest) Lists the jobs for a branch of an Amplify app.default ListJobsResponse
listJobs
(ListJobsRequest listJobsRequest) Lists the jobs for a branch of an Amplify app.default ListJobsIterable
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation.default ListJobsIterable
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).default ListWebhooksResponse
listWebhooks
(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest) Returns a list of webhooks for an Amplify app.default ListWebhooksResponse
listWebhooks
(ListWebhooksRequest listWebhooksRequest) Returns a list of webhooks for an Amplify app.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartDeploymentResponse
startDeployment
(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest) Starts a deployment for a manually deployed app.default StartDeploymentResponse
startDeployment
(StartDeploymentRequest startDeploymentRequest) Starts a deployment for a manually deployed app.default StartJobResponse
startJob
(Consumer<StartJobRequest.Builder> startJobRequest) Starts a new job for a branch of an Amplify app.default StartJobResponse
startJob
(StartJobRequest startJobRequest) Starts a new job for a branch of an Amplify app.default StopJobResponse
stopJob
(Consumer<StopJobRequest.Builder> stopJobRequest) Stops a job that is in progress for a branch of an Amplify app.default StopJobResponse
stopJob
(StopJobRequest stopJobRequest) Stops a job that is in progress for a branch of an Amplify app.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags the resource with a tag key and value.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Tags the resource with a tag key and value.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untags a resource with a specified Amazon Resource Name (ARN).default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Untags a resource with a specified Amazon Resource Name (ARN).default UpdateAppResponse
updateApp
(Consumer<UpdateAppRequest.Builder> updateAppRequest) Updates an existing Amplify app.default UpdateAppResponse
updateApp
(UpdateAppRequest updateAppRequest) Updates an existing Amplify app.default UpdateBranchResponse
updateBranch
(Consumer<UpdateBranchRequest.Builder> updateBranchRequest) Updates a branch for an Amplify app.default UpdateBranchResponse
updateBranch
(UpdateBranchRequest updateBranchRequest) Updates a branch for an Amplify app.default UpdateDomainAssociationResponse
updateDomainAssociation
(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest) Creates a new domain association for an Amplify app.default UpdateDomainAssociationResponse
updateDomainAssociation
(UpdateDomainAssociationRequest updateDomainAssociationRequest) Creates a new domain association for an Amplify app.default UpdateWebhookResponse
updateWebhook
(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest) Updates a webhook.default UpdateWebhookResponse
updateWebhook
(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 Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateAppRequest.builder()
- Parameters:
createAppRequest
- AConsumer
that will call methods onCreateAppRequest.Builder
to create a request. The request structure used to create apps in Amplify.- Returns:
- Result of the CreateApp operation returned by the service.
- See Also:
-
createBackendEnvironment
default CreateBackendEnvironmentResponse createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException Creates a new backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
createBackendEnvironmentRequest
- The request structure for the backend environment create request.- Returns:
- Result of the CreateBackendEnvironment operation returned by the service.
- See Also:
-
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 API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
CreateBackendEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateBackendEnvironmentRequest.builder()
- Parameters:
createBackendEnvironmentRequest
- AConsumer
that will call methods onCreateBackendEnvironmentRequest.Builder
to create a request. The request structure for the backend environment create request.- Returns:
- Result of the CreateBackendEnvironment operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateBranchRequest.builder()
- Parameters:
createBranchRequest
- AConsumer
that will call methods onCreateBranchRequest.Builder
to create a request. The request structure for the create branch request.- Returns:
- Result of the CreateBranch operation returned by the service.
- See Also:
-
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
CreateDeployment
call and theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.- Parameters:
createDeploymentRequest
- The request structure for the create a new deployment request.- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
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
CreateDeployment
call and theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builder
avoiding the need to create one manually viaCreateDeploymentRequest.builder()
- Parameters:
createDeploymentRequest
- AConsumer
that will call methods onCreateDeploymentRequest.Builder
to create a request. The request structure for the create a new deployment request.- Returns:
- Result of the CreateDeployment operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateDomainAssociationRequest.builder()
- Parameters:
createDomainAssociationRequest
- AConsumer
that will call methods onCreateDomainAssociationRequest.Builder
to create a request. The request structure for the create domain association request.- Returns:
- Result of the CreateDomainAssociation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateWebhookRequest.builder()
- Parameters:
createWebhookRequest
- AConsumer
that will call methods onCreateWebhookRequest.Builder
to create a request. The request structure for the create webhook request.- Returns:
- Result of the CreateWebhook operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteAppRequest.builder()
- Parameters:
deleteAppRequest
- AConsumer
that will call methods onDeleteAppRequest.Builder
to create a request. Describes the request structure for the delete app request.- Returns:
- Result of the DeleteApp operation returned by the service.
- See Also:
-
deleteBackendEnvironment
default DeleteBackendEnvironmentResponse deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException Deletes a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
deleteBackendEnvironmentRequest
- The request structure for the delete backend environment request.- Returns:
- Result of the DeleteBackendEnvironment operation returned by the service.
- See Also:
-
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 API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
DeleteBackendEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteBackendEnvironmentRequest.builder()
- Parameters:
deleteBackendEnvironmentRequest
- AConsumer
that will call methods onDeleteBackendEnvironmentRequest.Builder
to create a request. The request structure for the delete backend environment request.- Returns:
- Result of the DeleteBackendEnvironment operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteBranchRequest.builder()
- Parameters:
deleteBranchRequest
- AConsumer
that will call methods onDeleteBranchRequest.Builder
to create a request. The request structure for the delete branch request.- Returns:
- Result of the DeleteBranch operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteDomainAssociationRequest.builder()
- Parameters:
deleteDomainAssociationRequest
- AConsumer
that will call methods onDeleteDomainAssociationRequest.Builder
to create a request. The request structure for the delete domain association request.- Returns:
- Result of the DeleteDomainAssociation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteJobRequest.builder()
- Parameters:
deleteJobRequest
- AConsumer
that will call methods onDeleteJobRequest.Builder
to create a request. The request structure for the delete job request.- Returns:
- Result of the DeleteJob operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteWebhookRequest.builder()
- Parameters:
deleteWebhookRequest
- AConsumer
that will call methods onDeleteWebhookRequest.Builder
to create a request. The request structure for the delete webhook request.- Returns:
- Result of the DeleteWebhook operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGenerateAccessLogsRequest.builder()
- Parameters:
generateAccessLogsRequest
- AConsumer
that will call methods onGenerateAccessLogsRequest.Builder
to create a request. The request structure for the generate access logs request.- Returns:
- Result of the GenerateAccessLogs operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetAppRequest.builder()
- Parameters:
getAppRequest
- AConsumer
that will call methods onGetAppRequest.Builder
to create a request. The request structure for the get app request.- Returns:
- Result of the GetApp operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetArtifactUrlRequest.builder()
- Parameters:
getArtifactUrlRequest
- AConsumer
that will call methods onGetArtifactUrlRequest.Builder
to create a request. Returns the request structure for the get artifact request.- Returns:
- Result of the GetArtifactUrl operation returned by the service.
- See Also:
-
getBackendEnvironment
default GetBackendEnvironmentResponse getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest) throws BadRequestException, UnauthorizedException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException Returns a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
getBackendEnvironmentRequest
- The request structure for the get backend environment request.- Returns:
- Result of the GetBackendEnvironment operation returned by the service.
- See Also:
-
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 API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
GetBackendEnvironmentRequest.Builder
avoiding the need to create one manually viaGetBackendEnvironmentRequest.builder()
- Parameters:
getBackendEnvironmentRequest
- AConsumer
that will call methods onGetBackendEnvironmentRequest.Builder
to create a request. The request structure for the get backend environment request.- Returns:
- Result of the GetBackendEnvironment operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetBranchRequest.builder()
- Parameters:
getBranchRequest
- AConsumer
that will call methods onGetBranchRequest.Builder
to create a request. The request structure for the get branch request.- Returns:
- Result of the GetBranch operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetDomainAssociationRequest.builder()
- Parameters:
getDomainAssociationRequest
- AConsumer
that will call methods onGetDomainAssociationRequest.Builder
to create a request. The request structure for the get domain association request.- Returns:
- Result of the GetDomainAssociation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetJobRequest.builder()
- Parameters:
getJobRequest
- AConsumer
that will call methods onGetJobRequest.Builder
to create a request. The request structure for the get job request.- Returns:
- Result of the GetJob operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetWebhookRequest.builder()
- Parameters:
getWebhookRequest
- AConsumer
that will call methods onGetWebhookRequest.Builder
to create a request. The request structure for the get webhook request.- Returns:
- Result of the GetWebhook operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to create a request. The request structure for the list apps request.- Returns:
- Result of the ListApps operation returned by the service.
- See Also:
-
listApps
default ListAppsResponse listApps() throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyExceptionReturns a list of the existing Amplify apps.
- Returns:
- Result of the ListApps operation returned by the service.
- See Also:
-
listAppsPaginator
default ListAppsIterable listAppsPaginator() throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyExceptionThis 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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to 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.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListArtifactsRequest.builder()
- Parameters:
listArtifactsRequest
- AConsumer
that will call methods onListArtifactsRequest.Builder
to create a request. Describes the request structure for the list artifacts request.- Returns:
- Result of the ListArtifacts operation returned by the service.
- See Also:
-
listBackendEnvironments
default ListBackendEnvironmentsResponse listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException Lists the backend environments for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
listBackendEnvironmentsRequest
- The request structure for the list backend environments request.- Returns:
- Result of the ListBackendEnvironments operation returned by the service.
- See Also:
-
listBackendEnvironments
default ListBackendEnvironmentsResponse listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException Lists the backend environments for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
ListBackendEnvironmentsRequest.Builder
avoiding the need to create one manually viaListBackendEnvironmentsRequest.builder()
- Parameters:
listBackendEnvironmentsRequest
- AConsumer
that will call methods onListBackendEnvironmentsRequest.Builder
to create a request. The request structure for the list backend environments request.- Returns:
- Result of the ListBackendEnvironments operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListBranchesRequest.builder()
- Parameters:
listBranchesRequest
- AConsumer
that will call methods onListBranchesRequest.Builder
to create a request. The request structure for the list branches request.- Returns:
- Result of the ListBranches operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListBranchesRequest.builder()
- Parameters:
listBranchesRequest
- AConsumer
that will call methods onListBranchesRequest.Builder
to 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.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListDomainAssociationsRequest.builder()
- Parameters:
listDomainAssociationsRequest
- AConsumer
that will call methods onListDomainAssociationsRequest.Builder
to create a request. The request structure for the list domain associations request.- Returns:
- Result of the ListDomainAssociations operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDomainAssociationsRequest.builder()
- Parameters:
listDomainAssociationsRequest
- AConsumer
that will call methods onListDomainAssociationsRequest.Builder
to 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.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. The request structure for the list jobs request.- Returns:
- Result of the ListJobs operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to 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.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request. The request structure to use to list tags for a resource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListWebhooksRequest.builder()
- Parameters:
listWebhooksRequest
- AConsumer
that will call methods onListWebhooksRequest.Builder
to create a request. The request structure for the list webhooks request.- Returns:
- Result of the ListWebhooks operation returned by the service.
- See Also:
-
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
CreateDeployment
call and theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.- Parameters:
startDeploymentRequest
- The request structure for the start a deployment request.- Returns:
- Result of the StartDeployment operation returned by the service.
- See Also:
-
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
CreateDeployment
call and theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.
This is a convenience which creates an instance of the
StartDeploymentRequest.Builder
avoiding the need to create one manually viaStartDeploymentRequest.builder()
- Parameters:
startDeploymentRequest
- AConsumer
that will call methods onStartDeploymentRequest.Builder
to create a request. The request structure for the start a deployment request.- Returns:
- Result of the StartDeployment operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaStartJobRequest.builder()
- Parameters:
startJobRequest
- AConsumer
that will call methods onStartJobRequest.Builder
to create a request. The request structure for the start job request.- Returns:
- Result of the StartJob operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaStopJobRequest.builder()
- Parameters:
stopJobRequest
- AConsumer
that will call methods onStopJobRequest.Builder
to create a request. The request structure for the stop job request.- Returns:
- Result of the StopJob operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to 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.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request. The request structure for the untag resource request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateAppRequest.builder()
- Parameters:
updateAppRequest
- AConsumer
that will call methods onUpdateAppRequest.Builder
to create a request. The request structure for the update app request.- Returns:
- Result of the UpdateApp operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateBranchRequest.builder()
- Parameters:
updateBranchRequest
- AConsumer
that will call methods onUpdateBranchRequest.Builder
to create a request. The request structure for the update branch request.- Returns:
- Result of the UpdateBranch operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateDomainAssociationRequest.builder()
- Parameters:
updateDomainAssociationRequest
- AConsumer
that will call methods onUpdateDomainAssociationRequest.Builder
to create a request. The request structure for the update domain association request.- Returns:
- Result of the UpdateDomainAssociation operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateWebhookRequest.builder()
- Parameters:
updateWebhookRequest
- AConsumer
that will call methods onUpdateWebhookRequest.Builder
to create a request. The request structure for the update webhook request.- Returns:
- Result of the UpdateWebhook operation returned by the service.
- See Also:
-
create
Create aAmplifyClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAmplifyClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-