@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAmplifyBackendClient extends AmazonWebServiceClient implements AWSAmplifyBackend
AWS Amplify Admin API
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSAmplifyBackendClientBuilder |
builder() |
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSAmplifyBackendClientBuilder builder()
public CloneBackendResult cloneBackend(CloneBackendRequest request)
This operation clones an existing backend.
cloneBackend
in interface AWSAmplifyBackend
cloneBackendRequest
- The request body for CloneBackend.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic CreateBackendResult createBackend(CreateBackendRequest request)
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
createBackend
in interface AWSAmplifyBackend
createBackendRequest
- The request body for CreateBackend.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic CreateBackendAPIResult createBackendAPI(CreateBackendAPIRequest request)
Creates a new backend API resource.
createBackendAPI
in interface AWSAmplifyBackend
createBackendAPIRequest
- The request body for CreateBackendAPI.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic CreateBackendAuthResult createBackendAuth(CreateBackendAuthRequest request)
Creates a new backend authentication resource.
createBackendAuth
in interface AWSAmplifyBackend
createBackendAuthRequest
- The request body for CreateBackendAuth.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic CreateBackendConfigResult createBackendConfig(CreateBackendConfigRequest request)
Creates a config object for a backend.
createBackendConfig
in interface AWSAmplifyBackend
createBackendConfigRequest
- The request body for CreateBackendConfig.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic CreateBackendStorageResult createBackendStorage(CreateBackendStorageRequest request)
Creates a backend storage resource.
createBackendStorage
in interface AWSAmplifyBackend
createBackendStorageRequest
- The request body for CreateBackendStorage.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic CreateTokenResult createToken(CreateTokenRequest request)
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
createToken
in interface AWSAmplifyBackend
createTokenRequest
- NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic DeleteBackendResult deleteBackend(DeleteBackendRequest request)
Removes an existing environment from your Amplify project.
deleteBackend
in interface AWSAmplifyBackend
deleteBackendRequest
- NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic DeleteBackendAPIResult deleteBackendAPI(DeleteBackendAPIRequest request)
Deletes an existing backend API resource.
deleteBackendAPI
in interface AWSAmplifyBackend
deleteBackendAPIRequest
- The request body for DeleteBackendAPI.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic DeleteBackendAuthResult deleteBackendAuth(DeleteBackendAuthRequest request)
Deletes an existing backend authentication resource.
deleteBackendAuth
in interface AWSAmplifyBackend
deleteBackendAuthRequest
- The request body for DeleteBackendAuth.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic DeleteBackendStorageResult deleteBackendStorage(DeleteBackendStorageRequest request)
Removes the specified backend storage resource.
deleteBackendStorage
in interface AWSAmplifyBackend
deleteBackendStorageRequest
- The request body for DeleteBackendStorage.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic DeleteTokenResult deleteToken(DeleteTokenRequest request)
Deletes the challenge token based on the given appId and sessionId.
deleteToken
in interface AWSAmplifyBackend
deleteTokenRequest
- NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GenerateBackendAPIModelsResult generateBackendAPIModels(GenerateBackendAPIModelsRequest request)
Generates a model schema for an existing backend API resource.
generateBackendAPIModels
in interface AWSAmplifyBackend
generateBackendAPIModelsRequest
- The request body for GenerateBackendAPIModels.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetBackendResult getBackend(GetBackendRequest request)
Provides project-level details for your Amplify UI project.
getBackend
in interface AWSAmplifyBackend
getBackendRequest
- The request body for GetBackend.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetBackendAPIResult getBackendAPI(GetBackendAPIRequest request)
Gets the details for a backend API.
getBackendAPI
in interface AWSAmplifyBackend
getBackendAPIRequest
- The request body for GetBackendAPI.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetBackendAPIModelsResult getBackendAPIModels(GetBackendAPIModelsRequest request)
Gets a model introspection schema for an existing backend API resource.
getBackendAPIModels
in interface AWSAmplifyBackend
getBackendAPIModelsRequest
- The request body for GetBackendAPIModels.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetBackendAuthResult getBackendAuth(GetBackendAuthRequest request)
Gets a backend auth details.
getBackendAuth
in interface AWSAmplifyBackend
getBackendAuthRequest
- The request body for GetBackendAuth.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetBackendJobResult getBackendJob(GetBackendJobRequest request)
Returns information about a specific job.
getBackendJob
in interface AWSAmplifyBackend
getBackendJobRequest
- NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetBackendStorageResult getBackendStorage(GetBackendStorageRequest request)
Gets details for a backend storage resource.
getBackendStorage
in interface AWSAmplifyBackend
getBackendStorageRequest
- The request body for GetBackendStorage.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic GetTokenResult getToken(GetTokenRequest request)
Gets the challenge token based on the given appId and sessionId.
getToken
in interface AWSAmplifyBackend
getTokenRequest
- NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic ImportBackendAuthResult importBackendAuth(ImportBackendAuthRequest request)
Imports an existing backend authentication resource.
importBackendAuth
in interface AWSAmplifyBackend
importBackendAuthRequest
- The request body for ImportBackendAuth.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic ImportBackendStorageResult importBackendStorage(ImportBackendStorageRequest request)
Imports an existing backend storage resource.
importBackendStorage
in interface AWSAmplifyBackend
importBackendStorageRequest
- The request body for ImportBackendStorage.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic ListBackendJobsResult listBackendJobs(ListBackendJobsRequest request)
Lists the jobs for the backend of an Amplify app.
listBackendJobs
in interface AWSAmplifyBackend
listBackendJobsRequest
- The request body for ListBackendJobs.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic ListS3BucketsResult listS3Buckets(ListS3BucketsRequest request)
The list of S3 buckets in your account.
listS3Buckets
in interface AWSAmplifyBackend
listS3BucketsRequest
- The request body for S3Buckets.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic RemoveAllBackendsResult removeAllBackends(RemoveAllBackendsRequest request)
Removes all backend environments from your Amplify project.
removeAllBackends
in interface AWSAmplifyBackend
removeAllBackendsRequest
- The request body for RemoveAllBackends.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic RemoveBackendConfigResult removeBackendConfig(RemoveBackendConfigRequest request)
Removes the AWS resources required to access the Amplify Admin UI.
removeBackendConfig
in interface AWSAmplifyBackend
removeBackendConfigRequest
- NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic UpdateBackendAPIResult updateBackendAPI(UpdateBackendAPIRequest request)
Updates an existing backend API resource.
updateBackendAPI
in interface AWSAmplifyBackend
updateBackendAPIRequest
- The request body for UpdateBackendAPI.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic UpdateBackendAuthResult updateBackendAuth(UpdateBackendAuthRequest request)
Updates an existing backend authentication resource.
updateBackendAuth
in interface AWSAmplifyBackend
updateBackendAuthRequest
- The request body for UpdateBackendAuth.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic UpdateBackendConfigResult updateBackendConfig(UpdateBackendConfigRequest request)
Updates the AWS resources required to access the Amplify Admin UI.
updateBackendConfig
in interface AWSAmplifyBackend
updateBackendConfigRequest
- The request body for UpdateBackendConfig.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic UpdateBackendJobResult updateBackendJob(UpdateBackendJobRequest request)
Updates a specific job.
updateBackendJob
in interface AWSAmplifyBackend
updateBackendJobRequest
- The request body for GetBackendJob.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic UpdateBackendStorageResult updateBackendStorage(UpdateBackendStorageRequest request)
Updates an existing backend storage resource.
updateBackendStorage
in interface AWSAmplifyBackend
updateBackendStorageRequest
- The request body for UpdateBackendStorage.NotFoundException
- 404 responseGatewayTimeoutException
- 504 responseTooManyRequestsException
- 429 responseBadRequestException
- 400 responsepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSAmplifyBackend
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSAmplifyBackend
shutdown
in class AmazonWebServiceClient