AbstractAWSAmplifyBackend (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.amplifybackend

Class AbstractAWSAmplifyBackend

java.lang.Object
- com.amazonaws.services.amplifybackend.AbstractAWSAmplifyBackend

All Implemented Interfaces:

AWSAmplifyBackend

Direct Known Subclasses:

AbstractAWSAmplifyBackendAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSAmplifyBackend
extends Object
implements AWSAmplifyBackend 
```
Abstract implementation of AWSAmplifyBackend. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.amplifybackend.AWSAmplifyBackend
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`CloneBackendResult`	`cloneBackend (CloneBackendRequest request)` This operation clones an existing backend.
`CreateBackendResult`	`createBackend (CreateBackendRequest request)` This operation creates a backend for an Amplify app.
`CreateBackendAPIResult`	`createBackendAPI (CreateBackendAPIRequest request)` Creates a new backend API resource.
`CreateBackendAuthResult`	`createBackendAuth (CreateBackendAuthRequest request)` Creates a new backend authentication resource.
`CreateBackendConfigResult`	`createBackendConfig (CreateBackendConfigRequest request)` Creates a config object for a backend.
`CreateBackendStorageResult`	`createBackendStorage (CreateBackendStorageRequest request)` Creates a backend storage resource.
`CreateTokenResult`	`createToken (CreateTokenRequest request)` Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
`DeleteBackendResult`	`deleteBackend (DeleteBackendRequest request)` Removes an existing environment from your Amplify project.
`DeleteBackendAPIResult`	`deleteBackendAPI (DeleteBackendAPIRequest request)` Deletes an existing backend API resource.
`DeleteBackendAuthResult`	`deleteBackendAuth (DeleteBackendAuthRequest request)` Deletes an existing backend authentication resource.
`DeleteBackendStorageResult`	`deleteBackendStorage (DeleteBackendStorageRequest request)` Removes the specified backend storage resource.
`DeleteTokenResult`	`deleteToken (DeleteTokenRequest request)` Deletes the challenge token based on the given appId and sessionId.
`GenerateBackendAPIModelsResult`	`generateBackendAPIModels (GenerateBackendAPIModelsRequest request)` Generates a model schema for an existing backend API resource.
`GetBackendResult`	`getBackend (GetBackendRequest request)` Provides project-level details for your Amplify UI project.
`GetBackendAPIResult`	`getBackendAPI (GetBackendAPIRequest request)` Gets the details for a backend API.
`GetBackendAPIModelsResult`	`getBackendAPIModels (GetBackendAPIModelsRequest request)` Gets a model introspection schema for an existing backend API resource.
`GetBackendAuthResult`	`getBackendAuth (GetBackendAuthRequest request)` Gets a backend auth details.
`GetBackendJobResult`	`getBackendJob (GetBackendJobRequest request)` Returns information about a specific job.
`GetBackendStorageResult`	`getBackendStorage (GetBackendStorageRequest request)` Gets details for a backend storage resource.
`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.
`GetTokenResult`	`getToken (GetTokenRequest request)` Gets the challenge token based on the given appId and sessionId.
`ImportBackendAuthResult`	`importBackendAuth (ImportBackendAuthRequest request)` Imports an existing backend authentication resource.
`ImportBackendStorageResult`	`importBackendStorage (ImportBackendStorageRequest request)` Imports an existing backend storage resource.
`ListBackendJobsResult`	`listBackendJobs (ListBackendJobsRequest request)` Lists the jobs for the backend of an Amplify app.
`ListS3BucketsResult`	`listS3Buckets (ListS3BucketsRequest request)` The list of S3 buckets in your account.
`RemoveAllBackendsResult`	`removeAllBackends (RemoveAllBackendsRequest request)` Removes all backend environments from your Amplify project.
`RemoveBackendConfigResult`	`removeBackendConfig (RemoveBackendConfigRequest request)` Removes the AWS resources required to access the Amplify Admin UI.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`UpdateBackendAPIResult`	`updateBackendAPI (UpdateBackendAPIRequest request)` Updates an existing backend API resource.
`UpdateBackendAuthResult`	`updateBackendAuth (UpdateBackendAuthRequest request)` Updates an existing backend authentication resource.
`UpdateBackendConfigResult`	`updateBackendConfig (UpdateBackendConfigRequest request)` Updates the AWS resources required to access the Amplify Admin UI.
`UpdateBackendJobResult`	`updateBackendJob (UpdateBackendJobRequest request)` Updates a specific job.
`UpdateBackendStorageResult`	`updateBackendStorage (UpdateBackendStorageRequest request)` Updates an existing backend storage resource.

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

- Method Detail
  - cloneBackend
```
public CloneBackendResult cloneBackend(CloneBackendRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    This operation clones an existing backend.
    
    Specified by:
    
    cloneBackend in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for CloneBackend.
    
    Returns:
    
    Result of the CloneBackend operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackend
```
public CreateBackendResult createBackend(CreateBackendRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
    
    Specified by:
    
    createBackend in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for CreateBackend.
    
    Returns:
    
    Result of the CreateBackend operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackendAPI
```
public CreateBackendAPIResult createBackendAPI(CreateBackendAPIRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Creates a new backend API resource.
    
    Specified by:
    
    createBackendAPI in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for CreateBackendAPI.
    
    Returns:
    
    Result of the CreateBackendAPI operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackendAuth
```
public CreateBackendAuthResult createBackendAuth(CreateBackendAuthRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Creates a new backend authentication resource.
    
    Specified by:
    
    createBackendAuth in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for CreateBackendAuth.
    
    Returns:
    
    Result of the CreateBackendAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackendConfig
```
public CreateBackendConfigResult createBackendConfig(CreateBackendConfigRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Creates a config object for a backend.
    
    Specified by:
    
    createBackendConfig in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for CreateBackendConfig.
    
    Returns:
    
    Result of the CreateBackendConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackendStorage
```
public CreateBackendStorageResult createBackendStorage(CreateBackendStorageRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Creates a backend storage resource.
    
    Specified by:
    
    createBackendStorage in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for CreateBackendStorage.
    
    Returns:
    
    Result of the CreateBackendStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createToken
```
public CreateTokenResult createToken(CreateTokenRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
    
    Specified by:
    
    createToken in interface AWSAmplifyBackend
    
    Returns:
    
    Result of the CreateToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackend
```
public DeleteBackendResult deleteBackend(DeleteBackendRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Removes an existing environment from your Amplify project.
    
    Specified by:
    
    deleteBackend in interface AWSAmplifyBackend
    
    Returns:
    
    Result of the DeleteBackend operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackendAPI
```
public DeleteBackendAPIResult deleteBackendAPI(DeleteBackendAPIRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Deletes an existing backend API resource.
    
    Specified by:
    
    deleteBackendAPI in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for DeleteBackendAPI.
    
    Returns:
    
    Result of the DeleteBackendAPI operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackendAuth
```
public DeleteBackendAuthResult deleteBackendAuth(DeleteBackendAuthRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Deletes an existing backend authentication resource.
    
    Specified by:
    
    deleteBackendAuth in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for DeleteBackendAuth.
    
    Returns:
    
    Result of the DeleteBackendAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackendStorage
```
public DeleteBackendStorageResult deleteBackendStorage(DeleteBackendStorageRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Removes the specified backend storage resource.
    
    Specified by:
    
    deleteBackendStorage in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for DeleteBackendStorage.
    
    Returns:
    
    Result of the DeleteBackendStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteToken
```
public DeleteTokenResult deleteToken(DeleteTokenRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Deletes the challenge token based on the given appId and sessionId.
    
    Specified by:
    
    deleteToken in interface AWSAmplifyBackend
    
    Returns:
    
    Result of the DeleteToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - generateBackendAPIModels
```
public GenerateBackendAPIModelsResult generateBackendAPIModels(GenerateBackendAPIModelsRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Generates a model schema for an existing backend API resource.
    
    Specified by:
    
    generateBackendAPIModels in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GenerateBackendAPIModels.
    
    Returns:
    
    Result of the GenerateBackendAPIModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackend
```
public GetBackendResult getBackend(GetBackendRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Provides project-level details for your Amplify UI project.
    
    Specified by:
    
    getBackend in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GetBackend.
    
    Returns:
    
    Result of the GetBackend operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackendAPI
```
public GetBackendAPIResult getBackendAPI(GetBackendAPIRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Gets the details for a backend API.
    
    Specified by:
    
    getBackendAPI in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GetBackendAPI.
    
    Returns:
    
    Result of the GetBackendAPI operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackendAPIModels
```
public GetBackendAPIModelsResult getBackendAPIModels(GetBackendAPIModelsRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Gets a model introspection schema for an existing backend API resource.
    
    Specified by:
    
    getBackendAPIModels in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GetBackendAPIModels.
    
    Returns:
    
    Result of the GetBackendAPIModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackendAuth
```
public GetBackendAuthResult getBackendAuth(GetBackendAuthRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Gets a backend auth details.
    
    Specified by:
    
    getBackendAuth in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GetBackendAuth.
    
    Returns:
    
    Result of the GetBackendAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackendJob
```
public GetBackendJobResult getBackendJob(GetBackendJobRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Returns information about a specific job.
    
    Specified by:
    
    getBackendJob in interface AWSAmplifyBackend
    
    Returns:
    
    Result of the GetBackendJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackendStorage
```
public GetBackendStorageResult getBackendStorage(GetBackendStorageRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Gets details for a backend storage resource.
    
    Specified by:
    
    getBackendStorage in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GetBackendStorage.
    
    Returns:
    
    Result of the GetBackendStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getToken
```
public GetTokenResult getToken(GetTokenRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Gets the challenge token based on the given appId and sessionId.
    
    Specified by:
    
    getToken in interface AWSAmplifyBackend
    
    Returns:
    
    Result of the GetToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importBackendAuth
```
public ImportBackendAuthResult importBackendAuth(ImportBackendAuthRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Imports an existing backend authentication resource.
    
    Specified by:
    
    importBackendAuth in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for ImportBackendAuth.
    
    Returns:
    
    Result of the ImportBackendAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importBackendStorage
```
public ImportBackendStorageResult importBackendStorage(ImportBackendStorageRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Imports an existing backend storage resource.
    
    Specified by:
    
    importBackendStorage in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for ImportBackendStorage.
    
    Returns:
    
    Result of the ImportBackendStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackendJobs
```
public ListBackendJobsResult listBackendJobs(ListBackendJobsRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Lists the jobs for the backend of an Amplify app.
    
    Specified by:
    
    listBackendJobs in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for ListBackendJobs.
    
    Returns:
    
    Result of the ListBackendJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listS3Buckets
```
public ListS3BucketsResult listS3Buckets(ListS3BucketsRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    The list of S3 buckets in your account.
    
    Specified by:
    
    listS3Buckets in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for S3Buckets.
    
    Returns:
    
    Result of the ListS3Buckets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeAllBackends
```
public RemoveAllBackendsResult removeAllBackends(RemoveAllBackendsRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Removes all backend environments from your Amplify project.
    
    Specified by:
    
    removeAllBackends in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for RemoveAllBackends.
    
    Returns:
    
    Result of the RemoveAllBackends operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeBackendConfig
```
public RemoveBackendConfigResult removeBackendConfig(RemoveBackendConfigRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Removes the AWS resources required to access the Amplify Admin UI.
    
    Specified by:
    
    removeBackendConfig in interface AWSAmplifyBackend
    
    Returns:
    
    Result of the RemoveBackendConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBackendAPI
```
public UpdateBackendAPIResult updateBackendAPI(UpdateBackendAPIRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Updates an existing backend API resource.
    
    Specified by:
    
    updateBackendAPI in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for UpdateBackendAPI.
    
    Returns:
    
    Result of the UpdateBackendAPI operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBackendAuth
```
public UpdateBackendAuthResult updateBackendAuth(UpdateBackendAuthRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Updates an existing backend authentication resource.
    
    Specified by:
    
    updateBackendAuth in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for UpdateBackendAuth.
    
    Returns:
    
    Result of the UpdateBackendAuth operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBackendConfig
```
public UpdateBackendConfigResult updateBackendConfig(UpdateBackendConfigRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Updates the AWS resources required to access the Amplify Admin UI.
    
    Specified by:
    
    updateBackendConfig in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for UpdateBackendConfig.
    
    Returns:
    
    Result of the UpdateBackendConfig operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBackendJob
```
public UpdateBackendJobResult updateBackendJob(UpdateBackendJobRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Updates a specific job.
    
    Specified by:
    
    updateBackendJob in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for GetBackendJob.
    
    Returns:
    
    Result of the UpdateBackendJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBackendStorage
```
public UpdateBackendStorageResult updateBackendStorage(UpdateBackendStorageRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    Updates an existing backend storage resource.
    
    Specified by:
    
    updateBackendStorage in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The request body for UpdateBackendStorage.
    
    Returns:
    
    Result of the UpdateBackendStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSAmplifyBackend
    
    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.
    
    Specified by:
    
    shutdown in interface AWSAmplifyBackend
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSAmplifyBackend
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSAmplifyBackend
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AbstractAWSAmplifyBackend

Field Summary

Fields inherited from interface com.amazonaws.services.amplifybackend.AWSAmplifyBackend

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cloneBackend

createBackend

createBackendAPI

createBackendAuth

createBackendConfig

createBackendStorage

createToken

deleteBackend

deleteBackendAPI

deleteBackendAuth

deleteBackendStorage

deleteToken

generateBackendAPIModels

getBackend

getBackendAPI

getBackendAPIModels

getBackendAuth

getBackendJob

getBackendStorage

getToken

importBackendAuth

importBackendStorage

listBackendJobs

listS3Buckets

removeAllBackends

removeBackendConfig

updateBackendAPI

updateBackendAuth

updateBackendConfig

updateBackendJob

updateBackendStorage

shutdown

getCachedResponseMetadata