AWSAmplify (AWS SDK for Java

All Known Subinterfaces:

AWSAmplifyAsync

All Known Implementing Classes:

AbstractAWSAmplify, AbstractAWSAmplifyAsync, AWSAmplifyAsyncClient, AWSAmplifyClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplify
```
Interface for accessing Amplify.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAmplify instead.

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateAppResult`	`createApp(CreateAppRequest createAppRequest)` Creates a new Amplify app.
`CreateBackendEnvironmentResult`	`createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)` Creates a new backend environment for an Amplify app.
`CreateBranchResult`	`createBranch(CreateBranchRequest createBranchRequest)` Creates a new branch for an Amplify app.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)` Creates a deployment for a manually deployed Amplify app.
`CreateDomainAssociationResult`	`createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)` Creates a new domain association for an Amplify app.
`CreateWebhookResult`	`createWebhook(CreateWebhookRequest createWebhookRequest)` Creates a new webhook on an Amplify app.
`DeleteAppResult`	`deleteApp(DeleteAppRequest deleteAppRequest)` Deletes an existing Amplify app specified by an app ID.
`DeleteBackendEnvironmentResult`	`deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)` Deletes a backend environment for an Amplify app.
`DeleteBranchResult`	`deleteBranch(DeleteBranchRequest deleteBranchRequest)` Deletes a branch for an Amplify app.
`DeleteDomainAssociationResult`	`deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)` Deletes a domain association for an Amplify app.
`DeleteJobResult`	`deleteJob(DeleteJobRequest deleteJobRequest)` Deletes a job for a branch of an Amplify app.
`DeleteWebhookResult`	`deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)` Deletes a webhook.
`GenerateAccessLogsResult`	`generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)` Returns the website access logs for a specific time range using a presigned URL.
`GetAppResult`	`getApp(GetAppRequest getAppRequest)` Returns an existing Amplify app specified by an app ID.
`GetArtifactUrlResult`	`getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)` Returns the artifact info that corresponds to an artifact id.
`GetBackendEnvironmentResult`	`getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)` Returns a backend environment for an Amplify app.
`GetBranchResult`	`getBranch(GetBranchRequest getBranchRequest)` Returns a branch for an Amplify app.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDomainAssociationResult`	`getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)` Returns the domain information for an Amplify app.
`GetJobResult`	`getJob(GetJobRequest getJobRequest)` Returns a job for a branch of an Amplify app.
`GetWebhookResult`	`getWebhook(GetWebhookRequest getWebhookRequest)` Returns the webhook information that corresponds to a specified webhook ID.
`ListAppsResult`	`listApps(ListAppsRequest listAppsRequest)` Returns a list of the existing Amplify apps.
`ListArtifactsResult`	`listArtifacts(ListArtifactsRequest listArtifactsRequest)` Returns a list of artifacts for a specified app, branch, and job.
`ListBackendEnvironmentsResult`	`listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)` Lists the backend environments for an Amplify app.
`ListBranchesResult`	`listBranches(ListBranchesRequest listBranchesRequest)` Lists the branches of an Amplify app.
`ListDomainAssociationsResult`	`listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)` Returns the domain associations for an Amplify app.
`ListJobsResult`	`listJobs(ListJobsRequest listJobsRequest)` Lists the jobs for a branch of an Amplify app.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of tags for a specified Amazon Resource Name (ARN).
`ListWebhooksResult`	`listWebhooks(ListWebhooksRequest listWebhooksRequest)` Returns a list of webhooks for an Amplify app.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDeploymentResult`	`startDeployment(StartDeploymentRequest startDeploymentRequest)` Starts a deployment for a manually deployed app.
`StartJobResult`	`startJob(StartJobRequest startJobRequest)` Starts a new job for a branch of an Amplify app.
`StopJobResult`	`stopJob(StopJobRequest stopJobRequest)` Stops a job that is in progress for a branch of an Amplify app.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Tags the resource with a tag key and value.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Untags a resource with a specified Amazon Resource Name (ARN).
`UpdateAppResult`	`updateApp(UpdateAppRequest updateAppRequest)` Updates an existing Amplify app.
`UpdateBranchResult`	`updateBranch(UpdateBranchRequest updateBranchRequest)` Updates a branch for an Amplify app.
`UpdateDomainAssociationResult`	`updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)` Creates a new domain association for an Amplify app.
`UpdateWebhookResult`	`updateWebhook(UpdateWebhookRequest updateWebhookRequest)` Updates a webhook.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createApp
```
CreateAppResult createApp(CreateAppRequest createAppRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - createBackendEnvironment
```
CreateBackendEnvironmentResult createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)
```
    Creates a new backend environment for an Amplify app.
    
    This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createBranch
```
CreateBranchResult createBranch(CreateBranchRequest createBranchRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - createDeployment
```
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
```
    Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
    
    The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDomainAssociation
```
CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - createWebhook
```
CreateWebhookResult createWebhook(CreateWebhookRequest createWebhookRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteApp
```
DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteBackendEnvironment
```
DeleteBackendEnvironmentResult deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)
```
    Deletes a backend environment for an Amplify app.
    
    This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteBranch
```
DeleteBranchResult deleteBranch(DeleteBranchRequest deleteBranchRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDomainAssociation
```
DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteJob
```
DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteWebhook
```
DeleteWebhookResult deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - generateAccessLogs
```
GenerateAccessLogsResult generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - getApp
```
GetAppResult getApp(GetAppRequest getAppRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - getArtifactUrl
```
GetArtifactUrlResult getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - getBackendEnvironment
```
GetBackendEnvironmentResult getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)
```
    Returns a backend environment for an Amplify app.
    
    This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBranch
```
GetBranchResult getBranch(GetBranchRequest getBranchRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - getDomainAssociation
```
GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - getJob
```
GetJobResult getJob(GetJobRequest getJobRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - getWebhook
```
GetWebhookResult getWebhook(GetWebhookRequest getWebhookRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listApps
```
ListAppsResult listApps(ListAppsRequest listAppsRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listArtifacts
```
ListArtifactsResult listArtifacts(ListArtifactsRequest listArtifactsRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listBackendEnvironments
```
ListBackendEnvironmentsResult listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)
```
    Lists the backend environments for an Amplify app.
    
    This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listBranches
```
ListBranchesResult listBranches(ListBranchesRequest listBranchesRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listDomainAssociations
```
ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listJobs
```
ListJobsResult listJobs(ListJobsRequest listJobsRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - listWebhooks
```
ListWebhooksResult listWebhooks(ListWebhooksRequest listWebhooksRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - startDeployment
```
StartDeploymentResult startDeployment(StartDeploymentRequest startDeploymentRequest)
```
    Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
    
    The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startJob
```
StartJobResult startJob(StartJobRequest startJobRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - stopJob
```
StopJobResult stopJob(StopJobRequest stopJobRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - updateApp
```
UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - updateBranch
```
UpdateBranchResult updateBranch(UpdateBranchRequest updateBranchRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - updateDomainAssociation
```
UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - updateWebhook
```
UpdateWebhookResult updateWebhook(UpdateWebhookRequest updateWebhookRequest)
```
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.778

Interface AWSAmplify

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createApp

createBackendEnvironment

createBranch

createDeployment

createDomainAssociation

createWebhook

deleteApp

deleteBackendEnvironment

deleteBranch

deleteDomainAssociation

deleteJob

deleteWebhook

generateAccessLogs

getApp

getArtifactUrl

getBackendEnvironment

getBranch

getDomainAssociation

getJob

getWebhook

listApps

listArtifacts

listBackendEnvironments

listBranches

listDomainAssociations

listJobs

listTagsForResource

listWebhooks

startDeployment

startJob

stopJob

tagResource

untagResource

updateApp

updateBranch

updateDomainAssociation

updateWebhook

shutdown

getCachedResponseMetadata