com.amazonaws.services.amplifybackend.AWSAmplifyBackend Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-amplifybackend Show documentation
Show all versions of aws-java-sdk-amplifybackend Show documentation
The AWS Java SDK for AmplifyBackend module holds the client classes that are used for communicating with AmplifyBackend Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.amplifybackend;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.amplifybackend.model.*;
/**
* Interface for accessing AmplifyBackend.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.amplifybackend.AbstractAWSAmplifyBackend} instead.
*
*
*
* AWS Amplify Admin API
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplifyBackend {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "amplifybackend";
/**
*
* This operation clones an existing backend.
*
*
* @param cloneBackendRequest
* The request body for CloneBackend.
* @return Result of the CloneBackend operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CloneBackend
* @see AWS
* API Documentation
*/
CloneBackendResult cloneBackend(CloneBackendRequest cloneBackendRequest);
/**
*
* This operation creates a backend for an Amplify app. Backends are automatically created at the time of app
* creation.
*
*
* @param createBackendRequest
* The request body for CreateBackend.
* @return Result of the CreateBackend operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CreateBackend
* @see AWS
* API Documentation
*/
CreateBackendResult createBackend(CreateBackendRequest createBackendRequest);
/**
*
* Creates a new backend API resource.
*
*
* @param createBackendAPIRequest
* The request body for CreateBackendAPI.
* @return Result of the CreateBackendAPI operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CreateBackendAPI
* @see AWS API Documentation
*/
CreateBackendAPIResult createBackendAPI(CreateBackendAPIRequest createBackendAPIRequest);
/**
*
* Creates a new backend authentication resource.
*
*
* @param createBackendAuthRequest
* The request body for CreateBackendAuth.
* @return Result of the CreateBackendAuth operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CreateBackendAuth
* @see AWS API Documentation
*/
CreateBackendAuthResult createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest);
/**
*
* Creates a config object for a backend.
*
*
* @param createBackendConfigRequest
* The request body for CreateBackendConfig.
* @return Result of the CreateBackendConfig operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CreateBackendConfig
* @see AWS API Documentation
*/
CreateBackendConfigResult createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest);
/**
*
* Creates a backend storage resource.
*
*
* @param createBackendStorageRequest
* The request body for CreateBackendStorage.
* @return Result of the CreateBackendStorage operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CreateBackendStorage
* @see AWS API Documentation
*/
CreateBackendStorageResult createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest);
/**
*
* Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
*
*
* @param createTokenRequest
* @return Result of the CreateToken operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.CreateToken
* @see AWS API
* Documentation
*/
CreateTokenResult createToken(CreateTokenRequest createTokenRequest);
/**
*
* Removes an existing environment from your Amplify project.
*
*
* @param deleteBackendRequest
* @return Result of the DeleteBackend operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.DeleteBackend
* @see AWS
* API Documentation
*/
DeleteBackendResult deleteBackend(DeleteBackendRequest deleteBackendRequest);
/**
*
* Deletes an existing backend API resource.
*
*
* @param deleteBackendAPIRequest
* The request body for DeleteBackendAPI.
* @return Result of the DeleteBackendAPI operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.DeleteBackendAPI
* @see AWS API Documentation
*/
DeleteBackendAPIResult deleteBackendAPI(DeleteBackendAPIRequest deleteBackendAPIRequest);
/**
*
* Deletes an existing backend authentication resource.
*
*
* @param deleteBackendAuthRequest
* The request body for DeleteBackendAuth.
* @return Result of the DeleteBackendAuth operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.DeleteBackendAuth
* @see AWS API Documentation
*/
DeleteBackendAuthResult deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest);
/**
*
* Removes the specified backend storage resource.
*
*
* @param deleteBackendStorageRequest
* The request body for DeleteBackendStorage.
* @return Result of the DeleteBackendStorage operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.DeleteBackendStorage
* @see AWS API Documentation
*/
DeleteBackendStorageResult deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest);
/**
*
* Deletes the challenge token based on the given appId and sessionId.
*
*
* @param deleteTokenRequest
* @return Result of the DeleteToken operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.DeleteToken
* @see AWS API
* Documentation
*/
DeleteTokenResult deleteToken(DeleteTokenRequest deleteTokenRequest);
/**
*
* Generates a model schema for an existing backend API resource.
*
*
* @param generateBackendAPIModelsRequest
* The request body for GenerateBackendAPIModels.
* @return Result of the GenerateBackendAPIModels operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GenerateBackendAPIModels
* @see AWS API Documentation
*/
GenerateBackendAPIModelsResult generateBackendAPIModels(GenerateBackendAPIModelsRequest generateBackendAPIModelsRequest);
/**
*
* Provides project-level details for your Amplify UI project.
*
*
* @param getBackendRequest
* The request body for GetBackend.
* @return Result of the GetBackend operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetBackend
* @see AWS API
* Documentation
*/
GetBackendResult getBackend(GetBackendRequest getBackendRequest);
/**
*
* Gets the details for a backend API.
*
*
* @param getBackendAPIRequest
* The request body for GetBackendAPI.
* @return Result of the GetBackendAPI operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetBackendAPI
* @see AWS
* API Documentation
*/
GetBackendAPIResult getBackendAPI(GetBackendAPIRequest getBackendAPIRequest);
/**
*
* Gets a model introspection schema for an existing backend API resource.
*
*
* @param getBackendAPIModelsRequest
* The request body for GetBackendAPIModels.
* @return Result of the GetBackendAPIModels operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetBackendAPIModels
* @see AWS API Documentation
*/
GetBackendAPIModelsResult getBackendAPIModels(GetBackendAPIModelsRequest getBackendAPIModelsRequest);
/**
*
* Gets a backend auth details.
*
*
* @param getBackendAuthRequest
* The request body for GetBackendAuth.
* @return Result of the GetBackendAuth operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetBackendAuth
* @see AWS
* API Documentation
*/
GetBackendAuthResult getBackendAuth(GetBackendAuthRequest getBackendAuthRequest);
/**
*
* Returns information about a specific job.
*
*
* @param getBackendJobRequest
* @return Result of the GetBackendJob operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetBackendJob
* @see AWS
* API Documentation
*/
GetBackendJobResult getBackendJob(GetBackendJobRequest getBackendJobRequest);
/**
*
* Gets details for a backend storage resource.
*
*
* @param getBackendStorageRequest
* The request body for GetBackendStorage.
* @return Result of the GetBackendStorage operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetBackendStorage
* @see AWS API Documentation
*/
GetBackendStorageResult getBackendStorage(GetBackendStorageRequest getBackendStorageRequest);
/**
*
* Gets the challenge token based on the given appId and sessionId.
*
*
* @param getTokenRequest
* @return Result of the GetToken operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.GetToken
* @see AWS API
* Documentation
*/
GetTokenResult getToken(GetTokenRequest getTokenRequest);
/**
*
* Imports an existing backend authentication resource.
*
*
* @param importBackendAuthRequest
* The request body for ImportBackendAuth.
* @return Result of the ImportBackendAuth operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.ImportBackendAuth
* @see AWS API Documentation
*/
ImportBackendAuthResult importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest);
/**
*
* Imports an existing backend storage resource.
*
*
* @param importBackendStorageRequest
* The request body for ImportBackendStorage.
* @return Result of the ImportBackendStorage operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.ImportBackendStorage
* @see AWS API Documentation
*/
ImportBackendStorageResult importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest);
/**
*
* Lists the jobs for the backend of an Amplify app.
*
*
* @param listBackendJobsRequest
* The request body for ListBackendJobs.
* @return Result of the ListBackendJobs operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.ListBackendJobs
* @see AWS
* API Documentation
*/
ListBackendJobsResult listBackendJobs(ListBackendJobsRequest listBackendJobsRequest);
/**
*
* The list of S3 buckets in your account.
*
*
* @param listS3BucketsRequest
* The request body for S3Buckets.
* @return Result of the ListS3Buckets operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.ListS3Buckets
* @see AWS
* API Documentation
*/
ListS3BucketsResult listS3Buckets(ListS3BucketsRequest listS3BucketsRequest);
/**
*
* Removes all backend environments from your Amplify project.
*
*
* @param removeAllBackendsRequest
* The request body for RemoveAllBackends.
* @return Result of the RemoveAllBackends operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.RemoveAllBackends
* @see AWS API Documentation
*/
RemoveAllBackendsResult removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest);
/**
*
* Removes the AWS resources required to access the Amplify Admin UI.
*
*
* @param removeBackendConfigRequest
* @return Result of the RemoveBackendConfig operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.RemoveBackendConfig
* @see AWS API Documentation
*/
RemoveBackendConfigResult removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest);
/**
*
* Updates an existing backend API resource.
*
*
* @param updateBackendAPIRequest
* The request body for UpdateBackendAPI.
* @return Result of the UpdateBackendAPI operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.UpdateBackendAPI
* @see AWS API Documentation
*/
UpdateBackendAPIResult updateBackendAPI(UpdateBackendAPIRequest updateBackendAPIRequest);
/**
*
* Updates an existing backend authentication resource.
*
*
* @param updateBackendAuthRequest
* The request body for UpdateBackendAuth.
* @return Result of the UpdateBackendAuth operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.UpdateBackendAuth
* @see AWS API Documentation
*/
UpdateBackendAuthResult updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest);
/**
*
* Updates the AWS resources required to access the Amplify Admin UI.
*
*
* @param updateBackendConfigRequest
* The request body for UpdateBackendConfig.
* @return Result of the UpdateBackendConfig operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.UpdateBackendConfig
* @see AWS API Documentation
*/
UpdateBackendConfigResult updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest);
/**
*
* Updates a specific job.
*
*
* @param updateBackendJobRequest
* The request body for GetBackendJob.
* @return Result of the UpdateBackendJob operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.UpdateBackendJob
* @see AWS API Documentation
*/
UpdateBackendJobResult updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest);
/**
*
* Updates an existing backend storage resource.
*
*
* @param updateBackendStorageRequest
* The request body for UpdateBackendStorage.
* @return Result of the UpdateBackendStorage operation returned by the service.
* @throws NotFoundException
* 404 response
* @throws GatewayTimeoutException
* 504 response
* @throws TooManyRequestsException
* 429 response
* @throws BadRequestException
* 400 response
* @sample AWSAmplifyBackend.UpdateBackendStorage
* @see AWS API Documentation
*/
UpdateBackendStorageResult updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}