AWSAmplifyClient (AWS Java SDK for AWS Amplify 1.11.825 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.amplify.AWSAmplifyClient

All Implemented Interfaces:

AWSAmplify

Direct Known Subclasses:

AWSAmplifyAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAmplifyClient
extends AmazonWebServiceClient
implements AWSAmplify
```
Client for accessing Amplify. All service calls made using this client are blocking, and will not return until the service call completes.

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console 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

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.amplify.AWSAmplify
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSAmplifyClientBuilder`	`builder()`
`CreateAppResult`	`createApp(CreateAppRequest request)` Creates a new Amplify app.
`CreateBackendEnvironmentResult`	`createBackendEnvironment(CreateBackendEnvironmentRequest request)` Creates a new backend environment for an Amplify app.
`CreateBranchResult`	`createBranch(CreateBranchRequest request)` Creates a new branch for an Amplify app.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest request)` Creates a deployment for a manually deployed Amplify app.
`CreateDomainAssociationResult`	`createDomainAssociation(CreateDomainAssociationRequest request)` Creates a new domain association for an Amplify app.
`CreateWebhookResult`	`createWebhook(CreateWebhookRequest request)` Creates a new webhook on an Amplify app.
`DeleteAppResult`	`deleteApp(DeleteAppRequest request)` Deletes an existing Amplify app specified by an app ID.
`DeleteBackendEnvironmentResult`	`deleteBackendEnvironment(DeleteBackendEnvironmentRequest request)` Deletes a backend environment for an Amplify app.
`DeleteBranchResult`	`deleteBranch(DeleteBranchRequest request)` Deletes a branch for an Amplify app.
`DeleteDomainAssociationResult`	`deleteDomainAssociation(DeleteDomainAssociationRequest request)` Deletes a domain association for an Amplify app.
`DeleteJobResult`	`deleteJob(DeleteJobRequest request)` Deletes a job for a branch of an Amplify app.
`DeleteWebhookResult`	`deleteWebhook(DeleteWebhookRequest request)` Deletes a webhook.
`GenerateAccessLogsResult`	`generateAccessLogs(GenerateAccessLogsRequest request)` Returns the website access logs for a specific time range using a presigned URL.
`GetAppResult`	`getApp(GetAppRequest request)` Returns an existing Amplify app by appID.
`GetArtifactUrlResult`	`getArtifactUrl(GetArtifactUrlRequest request)` Returns the artifact info that corresponds to an artifact id.
`GetBackendEnvironmentResult`	`getBackendEnvironment(GetBackendEnvironmentRequest request)` Returns a backend environment for an Amplify app.
`GetBranchResult`	`getBranch(GetBranchRequest request)` 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 request)` Returns the domain information for an Amplify app.
`GetJobResult`	`getJob(GetJobRequest request)` Returns a job for a branch of an Amplify app.
`GetWebhookResult`	`getWebhook(GetWebhookRequest request)` Returns the webhook information that corresponds to a specified webhook ID.
`ListAppsResult`	`listApps(ListAppsRequest request)` Returns a list of the existing Amplify apps.
`ListArtifactsResult`	`listArtifacts(ListArtifactsRequest request)` Returns a list of artifacts for a specified app, branch, and job.
`ListBackendEnvironmentsResult`	`listBackendEnvironments(ListBackendEnvironmentsRequest request)` Lists the backend environments for an Amplify app.
`ListBranchesResult`	`listBranches(ListBranchesRequest request)` Lists the branches of an Amplify app.
`ListDomainAssociationsResult`	`listDomainAssociations(ListDomainAssociationsRequest request)` Returns the domain associations for an Amplify app.
`ListJobsResult`	`listJobs(ListJobsRequest request)` Lists the jobs for a branch of an Amplify app.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of tags for a specified Amazon Resource Name (ARN).
`ListWebhooksResult`	`listWebhooks(ListWebhooksRequest request)` Returns a list of webhooks for an Amplify app.
`StartDeploymentResult`	`startDeployment(StartDeploymentRequest request)` Starts a deployment for a manually deployed app.
`StartJobResult`	`startJob(StartJobRequest request)` Starts a new job for a branch of an Amplify app.
`StopJobResult`	`stopJob(StopJobRequest request)` Stops a job that is in progress for a branch of an Amplify app.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Tags the resource with a tag key and value.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Untags a resource with a specified Amazon Resource Name (ARN).
`UpdateAppResult`	`updateApp(UpdateAppRequest request)` Updates an existing Amplify app.
`UpdateBranchResult`	`updateBranch(UpdateBranchRequest request)` Updates a branch for an Amplify app.
`UpdateDomainAssociationResult`	`updateDomainAssociation(UpdateDomainAssociationRequest request)` Creates a new domain association for an Amplify app.
`UpdateWebhookResult`	`updateWebhook(UpdateWebhookRequest request)` Updates a webhook.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.amplify.AWSAmplify
shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AWSAmplifyClientBuilder builder()
```
  - createApp
```
public CreateAppResult createApp(CreateAppRequest request)
```
    Creates a new Amplify app.
    
    Specified by:
    
    createApp in interface AWSAmplify
    
    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
```
public CreateBackendEnvironmentResult createBackendEnvironment(CreateBackendEnvironmentRequest request)
```
    Creates a new backend environment for an Amplify app.
    
    Specified by:
    
    createBackendEnvironment in interface AWSAmplify
    
    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
```
public CreateBranchResult createBranch(CreateBranchRequest request)
```
    Creates a new branch for an Amplify app.
    
    Specified by:
    
    createBranch in interface AWSAmplify
    
    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
```
public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
```
    Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
    
    Specified by:
    
    createDeployment in interface AWSAmplify
    
    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
```
public CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest request)
```
    Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
    
    Specified by:
    
    createDomainAssociation in interface AWSAmplify
    
    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
```
public CreateWebhookResult createWebhook(CreateWebhookRequest request)
```
    Creates a new webhook on an Amplify app.
    
    Specified by:
    
    createWebhook in interface AWSAmplify
    
    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
```
public DeleteAppResult deleteApp(DeleteAppRequest request)
```
    Deletes an existing Amplify app specified by an app ID.
    
    Specified by:
    
    deleteApp in interface AWSAmplify
    
    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
```
public DeleteBackendEnvironmentResult deleteBackendEnvironment(DeleteBackendEnvironmentRequest request)
```
    Deletes a backend environment for an Amplify app.
    
    Specified by:
    
    deleteBackendEnvironment in interface AWSAmplify
    
    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
```
public DeleteBranchResult deleteBranch(DeleteBranchRequest request)
```
    Deletes a branch for an Amplify app.
    
    Specified by:
    
    deleteBranch in interface AWSAmplify
    
    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
```
public DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest request)
```
    Deletes a domain association for an Amplify app.
    
    Specified by:
    
    deleteDomainAssociation in interface AWSAmplify
    
    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
```
public DeleteJobResult deleteJob(DeleteJobRequest request)
```
    Deletes a job for a branch of an Amplify app.
    
    Specified by:
    
    deleteJob in interface AWSAmplify
    
    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
```
public DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
```
    Deletes a webhook.
    
    Specified by:
    
    deleteWebhook in interface AWSAmplify
    
    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
```
public GenerateAccessLogsResult generateAccessLogs(GenerateAccessLogsRequest request)
```
    Returns the website access logs for a specific time range using a presigned URL.
    
    Specified by:
    
    generateAccessLogs in interface AWSAmplify
    
    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
```
public GetAppResult getApp(GetAppRequest request)
```
    Returns an existing Amplify app by appID.
    
    Specified by:
    
    getApp in interface AWSAmplify
    
    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
```
public GetArtifactUrlResult getArtifactUrl(GetArtifactUrlRequest request)
```
    Returns the artifact info that corresponds to an artifact id.
    
    Specified by:
    
    getArtifactUrl in interface AWSAmplify
    
    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
```
public GetBackendEnvironmentResult getBackendEnvironment(GetBackendEnvironmentRequest request)
```
    Returns a backend environment for an Amplify app.
    
    Specified by:
    
    getBackendEnvironment in interface AWSAmplify
    
    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
```
public GetBranchResult getBranch(GetBranchRequest request)
```
    Returns a branch for an Amplify app.
    
    Specified by:
    
    getBranch in interface AWSAmplify
    
    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
```
public GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest request)
```
    Returns the domain information for an Amplify app.
    
    Specified by:
    
    getDomainAssociation in interface AWSAmplify
    
    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
```
public GetJobResult getJob(GetJobRequest request)
```
    Returns a job for a branch of an Amplify app.
    
    Specified by:
    
    getJob in interface AWSAmplify
    
    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
```
public GetWebhookResult getWebhook(GetWebhookRequest request)
```
    Returns the webhook information that corresponds to a specified webhook ID.
    
    Specified by:
    
    getWebhook in interface AWSAmplify
    
    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
```
public ListAppsResult listApps(ListAppsRequest request)
```
    Returns a list of the existing Amplify apps.
    
    Specified by:
    
    listApps in interface AWSAmplify
    
    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
```
public ListArtifactsResult listArtifacts(ListArtifactsRequest request)
```
    Returns a list of artifacts for a specified app, branch, and job.
    
    Specified by:
    
    listArtifacts in interface AWSAmplify
    
    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
```
public ListBackendEnvironmentsResult listBackendEnvironments(ListBackendEnvironmentsRequest request)
```
    Lists the backend environments for an Amplify app.
    
    Specified by:
    
    listBackendEnvironments in interface AWSAmplify
    
    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
```
public ListBranchesResult listBranches(ListBranchesRequest request)
```
    Lists the branches of an Amplify app.
    
    Specified by:
    
    listBranches in interface AWSAmplify
    
    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
```
public ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest request)
```
    Returns the domain associations for an Amplify app.
    
    Specified by:
    
    listDomainAssociations in interface AWSAmplify
    
    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
```
public ListJobsResult listJobs(ListJobsRequest request)
```
    Lists the jobs for a branch of an Amplify app.
    
    Specified by:
    
    listJobs in interface AWSAmplify
    
    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
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns a list of tags for a specified Amazon Resource Name (ARN).
    
    Specified by:
    
    listTagsForResource in interface AWSAmplify
    
    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
```
public ListWebhooksResult listWebhooks(ListWebhooksRequest request)
```
    Returns a list of webhooks for an Amplify app.
    
    Specified by:
    
    listWebhooks in interface AWSAmplify
    
    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
```
public StartDeploymentResult startDeployment(StartDeploymentRequest request)
```
    Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
    
    Specified by:
    
    startDeployment in interface AWSAmplify
    
    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
```
public StartJobResult startJob(StartJobRequest request)
```
    Starts a new job for a branch of an Amplify app.
    
    Specified by:
    
    startJob in interface AWSAmplify
    
    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
```
public StopJobResult stopJob(StopJobRequest request)
```
    Stops a job that is in progress for a branch of an Amplify app.
    
    Specified by:
    
    stopJob in interface AWSAmplify
    
    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
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Tags the resource with a tag key and value.
    
    Specified by:
    
    tagResource in interface AWSAmplify
    
    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
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Untags a resource with a specified Amazon Resource Name (ARN).
    
    Specified by:
    
    untagResource in interface AWSAmplify
    
    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
```
public UpdateAppResult updateApp(UpdateAppRequest request)
```
    Updates an existing Amplify app.
    
    Specified by:
    
    updateApp in interface AWSAmplify
    
    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
```
public UpdateBranchResult updateBranch(UpdateBranchRequest request)
```
    Updates a branch for an Amplify app.
    
    Specified by:
    
    updateBranch in interface AWSAmplify
    
    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
```
public UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest request)
```
    Creates a new domain association for an Amplify app.
    
    Specified by:
    
    updateDomainAssociation in interface AWSAmplify
    
    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
```
public UpdateWebhookResult updateWebhook(UpdateWebhookRequest request)
```
    Updates a webhook.
    
    Specified by:
    
    updateWebhook in interface AWSAmplify
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSAmplify
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AWSAmplifyClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.amplify.AWSAmplify

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.amplify.AWSAmplify

Field Detail

configFactory

Method Detail

builder

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

getCachedResponseMetadata