@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AmplifyBackendClient extends SdkClient
builder() method.
AWS Amplify Admin API
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static AmplifyBackendClientBuilder |
builder()
Create a builder that can be used to configure and create a
AmplifyBackendClient. |
default CloneBackendResponse |
cloneBackend(CloneBackendRequest cloneBackendRequest)
This operation clones an existing backend.
|
default CloneBackendResponse |
cloneBackend(Consumer<CloneBackendRequest.Builder> cloneBackendRequest)
This operation clones an existing backend.
|
static AmplifyBackendClient |
create()
Create a
AmplifyBackendClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateBackendResponse |
createBackend(Consumer<CreateBackendRequest.Builder> createBackendRequest)
This operation creates a backend for an Amplify app.
|
default CreateBackendResponse |
createBackend(CreateBackendRequest createBackendRequest)
This operation creates a backend for an Amplify app.
|
default CreateBackendApiResponse |
createBackendAPI(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest)
Creates a new backend API resource.
|
default CreateBackendApiResponse |
createBackendAPI(CreateBackendApiRequest createBackendApiRequest)
Creates a new backend API resource.
|
default CreateBackendAuthResponse |
createBackendAuth(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest)
Creates a new backend authentication resource.
|
default CreateBackendAuthResponse |
createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest)
Creates a new backend authentication resource.
|
default CreateBackendConfigResponse |
createBackendConfig(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest)
Creates a config object for a backend.
|
default CreateBackendConfigResponse |
createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest)
Creates a config object for a backend.
|
default CreateTokenResponse |
createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest)
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
|
default CreateTokenResponse |
createToken(CreateTokenRequest createTokenRequest)
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
|
default DeleteBackendResponse |
deleteBackend(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest)
Removes an existing environment from your Amplify project.
|
default DeleteBackendResponse |
deleteBackend(DeleteBackendRequest deleteBackendRequest)
Removes an existing environment from your Amplify project.
|
default DeleteBackendApiResponse |
deleteBackendAPI(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest)
Deletes an existing backend API resource.
|
default DeleteBackendApiResponse |
deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest)
Deletes an existing backend API resource.
|
default DeleteBackendAuthResponse |
deleteBackendAuth(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest)
Deletes an existing backend authentication resource.
|
default DeleteBackendAuthResponse |
deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest)
Deletes an existing backend authentication resource.
|
default DeleteTokenResponse |
deleteToken(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest)
Deletes the challenge token based on the given appId and sessionId.
|
default DeleteTokenResponse |
deleteToken(DeleteTokenRequest deleteTokenRequest)
Deletes the challenge token based on the given appId and sessionId.
|
default GenerateBackendApiModelsResponse |
generateBackendAPIModels(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest)
Generates a model schema for an existing backend API resource.
|
default GenerateBackendApiModelsResponse |
generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest)
Generates a model schema for an existing backend API resource.
|
default GetBackendResponse |
getBackend(Consumer<GetBackendRequest.Builder> getBackendRequest)
Provides project-level details for your Amplify UI project.
|
default GetBackendResponse |
getBackend(GetBackendRequest getBackendRequest)
Provides project-level details for your Amplify UI project.
|
default GetBackendApiResponse |
getBackendAPI(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest)
Gets the details for a backend API.
|
default GetBackendApiResponse |
getBackendAPI(GetBackendApiRequest getBackendApiRequest)
Gets the details for a backend API.
|
default GetBackendApiModelsResponse |
getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest)
Generates a model schema for existing backend API resource.
|
default GetBackendApiModelsResponse |
getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest)
Generates a model schema for existing backend API resource.
|
default GetBackendAuthResponse |
getBackendAuth(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest)
Gets backend auth details.
|
default GetBackendAuthResponse |
getBackendAuth(GetBackendAuthRequest getBackendAuthRequest)
Gets backend auth details.
|
default GetBackendJobResponse |
getBackendJob(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest)
Returns information about a specific job.
|
default GetBackendJobResponse |
getBackendJob(GetBackendJobRequest getBackendJobRequest)
Returns information about a specific job.
|
default GetTokenResponse |
getToken(Consumer<GetTokenRequest.Builder> getTokenRequest)
Gets the challenge token based on the given appId and sessionId.
|
default GetTokenResponse |
getToken(GetTokenRequest getTokenRequest)
Gets the challenge token based on the given appId and sessionId.
|
default ListBackendJobsResponse |
listBackendJobs(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
|
default ListBackendJobsResponse |
listBackendJobs(ListBackendJobsRequest listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
|
default ListBackendJobsIterable |
listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
|
default ListBackendJobsIterable |
listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
|
default RemoveAllBackendsResponse |
removeAllBackends(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest)
Removes all backend environments from your Amplify project.
|
default RemoveAllBackendsResponse |
removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest)
Removes all backend environments from your Amplify project.
|
default RemoveBackendConfigResponse |
removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest)
Removes the AWS resources that are required to access the Amplify Admin UI.
|
default RemoveBackendConfigResponse |
removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest)
Removes the AWS resources that are required to access the Amplify Admin UI.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateBackendApiResponse |
updateBackendAPI(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest)
Updates an existing backend API resource.
|
default UpdateBackendApiResponse |
updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest)
Updates an existing backend API resource.
|
default UpdateBackendAuthResponse |
updateBackendAuth(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest)
Updates an existing backend authentication resource.
|
default UpdateBackendAuthResponse |
updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest)
Updates an existing backend authentication resource.
|
default UpdateBackendConfigResponse |
updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest)
Updates the AWS resources that are required to access the Amplify Admin UI.
|
default UpdateBackendConfigResponse |
updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest)
Updates the AWS resources that are required to access the Amplify Admin UI.
|
default UpdateBackendJobResponse |
updateBackendJob(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest)
Updates a specific job.
|
default UpdateBackendJobResponse |
updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest)
Updates a specific job.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static AmplifyBackendClient create()
AmplifyBackendClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AmplifyBackendClientBuilder builder()
AmplifyBackendClient.default CloneBackendResponse cloneBackend(CloneBackendRequest cloneBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
This operation clones an existing backend.
cloneBackendRequest - The request body for CloneBackend.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CloneBackendResponse cloneBackend(Consumer<CloneBackendRequest.Builder> cloneBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
This operation clones an existing backend.
This is a convenience which creates an instance of the CloneBackendRequest.Builder avoiding the need to
create one manually via CloneBackendRequest.builder()
cloneBackendRequest - A Consumer that will call methods on CloneBackendRequest.Builder to create a request. The
request body for CloneBackend.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendResponse createBackend(CreateBackendRequest createBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
createBackendRequest - The request body for CreateBackend.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendResponse createBackend(Consumer<CreateBackendRequest.Builder> createBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
This is a convenience which creates an instance of the CreateBackendRequest.Builder avoiding the need to
create one manually via CreateBackendRequest.builder()
createBackendRequest - A Consumer that will call methods on CreateBackendRequest.Builder to create a request. The
request body for CreateBackend.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendApiResponse createBackendAPI(CreateBackendApiRequest createBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Creates a new backend API resource.
createBackendApiRequest - The request body for CreateBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendApiResponse createBackendAPI(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Creates a new backend API resource.
This is a convenience which creates an instance of the CreateBackendApiRequest.Builder avoiding the need
to create one manually via CreateBackendApiRequest.builder()
createBackendApiRequest - A Consumer that will call methods on CreateBackendAPIRequest.Builder to create a request.
The request body for CreateBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendAuthResponse createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Creates a new backend authentication resource.
createBackendAuthRequest - The request body for CreateBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendAuthResponse createBackendAuth(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Creates a new backend authentication resource.
This is a convenience which creates an instance of the CreateBackendAuthRequest.Builder avoiding the need
to create one manually via CreateBackendAuthRequest.builder()
createBackendAuthRequest - A Consumer that will call methods on CreateBackendAuthRequest.Builder to create a request.
The request body for CreateBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendConfigResponse createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Creates a config object for a backend.
createBackendConfigRequest - The request body for CreateBackendConfig.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBackendConfigResponse createBackendConfig(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Creates a config object for a backend.
This is a convenience which creates an instance of the CreateBackendConfigRequest.Builder avoiding the
need to create one manually via CreateBackendConfigRequest.builder()
createBackendConfigRequest - A Consumer that will call methods on CreateBackendConfigRequest.Builder to create a
request. The request body for CreateBackendConfig.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTokenResponse createToken(CreateTokenRequest createTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
createTokenRequest - NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTokenResponse createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
This is a convenience which creates an instance of the CreateTokenRequest.Builder avoiding the need to
create one manually via CreateTokenRequest.builder()
createTokenRequest - A Consumer that will call methods on CreateTokenRequest.Builder to create a request.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackendResponse deleteBackend(DeleteBackendRequest deleteBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Removes an existing environment from your Amplify project.
deleteBackendRequest - NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackendResponse deleteBackend(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Removes an existing environment from your Amplify project.
This is a convenience which creates an instance of the DeleteBackendRequest.Builder avoiding the need to
create one manually via DeleteBackendRequest.builder()
deleteBackendRequest - A Consumer that will call methods on DeleteBackendRequest.Builder to create a request.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackendApiResponse deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Deletes an existing backend API resource.
deleteBackendApiRequest - The request body for DeleteBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackendApiResponse deleteBackendAPI(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Deletes an existing backend API resource.
This is a convenience which creates an instance of the DeleteBackendApiRequest.Builder avoiding the need
to create one manually via DeleteBackendApiRequest.builder()
deleteBackendApiRequest - A Consumer that will call methods on DeleteBackendAPIRequest.Builder to create a request.
The request body for DeleteBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackendAuthResponse deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Deletes an existing backend authentication resource.
deleteBackendAuthRequest - The request body for DeleteBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBackendAuthResponse deleteBackendAuth(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Deletes an existing backend authentication resource.
This is a convenience which creates an instance of the DeleteBackendAuthRequest.Builder avoiding the need
to create one manually via DeleteBackendAuthRequest.builder()
deleteBackendAuthRequest - A Consumer that will call methods on DeleteBackendAuthRequest.Builder to create a request.
The request body for DeleteBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTokenResponse deleteToken(DeleteTokenRequest deleteTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Deletes the challenge token based on the given appId and sessionId.
deleteTokenRequest - NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTokenResponse deleteToken(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Deletes the challenge token based on the given appId and sessionId.
This is a convenience which creates an instance of the DeleteTokenRequest.Builder avoiding the need to
create one manually via DeleteTokenRequest.builder()
deleteTokenRequest - A Consumer that will call methods on DeleteTokenRequest.Builder to create a request.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateBackendApiModelsResponse generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Generates a model schema for an existing backend API resource.
generateBackendApiModelsRequest - The request body for GenerateBackendAPIModels.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateBackendApiModelsResponse generateBackendAPIModels(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Generates a model schema for an existing backend API resource.
This is a convenience which creates an instance of the GenerateBackendApiModelsRequest.Builder avoiding
the need to create one manually via GenerateBackendApiModelsRequest.builder()
generateBackendApiModelsRequest - A Consumer that will call methods on GenerateBackendAPIModelsRequest.Builder to create a
request. The request body for GenerateBackendAPIModels.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendResponse getBackend(GetBackendRequest getBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Provides project-level details for your Amplify UI project.
getBackendRequest - The request body for GetBackend.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendResponse getBackend(Consumer<GetBackendRequest.Builder> getBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Provides project-level details for your Amplify UI project.
This is a convenience which creates an instance of the GetBackendRequest.Builder avoiding the need to
create one manually via GetBackendRequest.builder()
getBackendRequest - A Consumer that will call methods on GetBackendRequest.Builder to create a request. The
request body for GetBackend.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendApiResponse getBackendAPI(GetBackendApiRequest getBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Gets the details for a backend API.
getBackendApiRequest - The request body for GetBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendApiResponse getBackendAPI(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Gets the details for a backend API.
This is a convenience which creates an instance of the GetBackendApiRequest.Builder avoiding the need to
create one manually via GetBackendApiRequest.builder()
getBackendApiRequest - A Consumer that will call methods on GetBackendAPIRequest.Builder to create a request. The
request body for GetBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendApiModelsResponse getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Generates a model schema for existing backend API resource.
getBackendApiModelsRequest - The request body for GetBackendAPIModels.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendApiModelsResponse getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Generates a model schema for existing backend API resource.
This is a convenience which creates an instance of the GetBackendApiModelsRequest.Builder avoiding the
need to create one manually via GetBackendApiModelsRequest.builder()
getBackendApiModelsRequest - A Consumer that will call methods on GetBackendAPIModelsRequest.Builder to create a
request. The request body for GetBackendAPIModels.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendAuthResponse getBackendAuth(GetBackendAuthRequest getBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Gets backend auth details.
getBackendAuthRequest - The request body for GetBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendAuthResponse getBackendAuth(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Gets backend auth details.
This is a convenience which creates an instance of the GetBackendAuthRequest.Builder avoiding the need to
create one manually via GetBackendAuthRequest.builder()
getBackendAuthRequest - A Consumer that will call methods on GetBackendAuthRequest.Builder to create a request.
The request body for GetBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendJobResponse getBackendJob(GetBackendJobRequest getBackendJobRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Returns information about a specific job.
getBackendJobRequest - NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBackendJobResponse getBackendJob(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Returns information about a specific job.
This is a convenience which creates an instance of the GetBackendJobRequest.Builder avoiding the need to
create one manually via GetBackendJobRequest.builder()
getBackendJobRequest - A Consumer that will call methods on GetBackendJobRequest.Builder to create a request.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTokenResponse getToken(GetTokenRequest getTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Gets the challenge token based on the given appId and sessionId.
getTokenRequest - NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTokenResponse getToken(Consumer<GetTokenRequest.Builder> getTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Gets the challenge token based on the given appId and sessionId.
This is a convenience which creates an instance of the GetTokenRequest.Builder avoiding the need to
create one manually via GetTokenRequest.builder()
getTokenRequest - A Consumer that will call methods on GetTokenRequest.Builder to create a request.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackendJobsResponse listBackendJobs(ListBackendJobsRequest listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Lists the jobs for the backend of an Amplify app.
listBackendJobsRequest - The request body for ListBackendJobs.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackendJobsResponse listBackendJobs(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Lists the jobs for the backend of an Amplify app.
This is a convenience which creates an instance of the ListBackendJobsRequest.Builder avoiding the need
to create one manually via ListBackendJobsRequest.builder()
listBackendJobsRequest - A Consumer that will call methods on ListBackendJobsRequest.Builder to create a request.
The request body for ListBackendJobs.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackendJobsIterable listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Lists the jobs for the backend of an Amplify app.
This is a variant of
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client
.listBackendJobsPaginator(request);
for (software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.
listBackendJobsRequest - The request body for ListBackendJobs.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBackendJobsIterable listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Lists the jobs for the backend of an Amplify app.
This is a variant of
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client
.listBackendJobsPaginator(request);
for (software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.
This is a convenience which creates an instance of the ListBackendJobsRequest.Builder avoiding the need
to create one manually via ListBackendJobsRequest.builder()
listBackendJobsRequest - A Consumer that will call methods on ListBackendJobsRequest.Builder to create a request.
The request body for ListBackendJobs.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveAllBackendsResponse removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Removes all backend environments from your Amplify project.
removeAllBackendsRequest - The request body for RemoveAllBackends.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveAllBackendsResponse removeAllBackends(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Removes all backend environments from your Amplify project.
This is a convenience which creates an instance of the RemoveAllBackendsRequest.Builder avoiding the need
to create one manually via RemoveAllBackendsRequest.builder()
removeAllBackendsRequest - A Consumer that will call methods on RemoveAllBackendsRequest.Builder to create a request.
The request body for RemoveAllBackends.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveBackendConfigResponse removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Removes the AWS resources that are required to access the Amplify Admin UI.
removeBackendConfigRequest - NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveBackendConfigResponse removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Removes the AWS resources that are required to access the Amplify Admin UI.
This is a convenience which creates an instance of the RemoveBackendConfigRequest.Builder avoiding the
need to create one manually via RemoveBackendConfigRequest.builder()
removeBackendConfigRequest - A Consumer that will call methods on RemoveBackendConfigRequest.Builder to create a
request.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendApiResponse updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates an existing backend API resource.
updateBackendApiRequest - The request body for UpdateBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendApiResponse updateBackendAPI(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates an existing backend API resource.
This is a convenience which creates an instance of the UpdateBackendApiRequest.Builder avoiding the need
to create one manually via UpdateBackendApiRequest.builder()
updateBackendApiRequest - A Consumer that will call methods on UpdateBackendAPIRequest.Builder to create a request.
The request body for UpdateBackendAPI.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendAuthResponse updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates an existing backend authentication resource.
updateBackendAuthRequest - The request body for UpdateBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendAuthResponse updateBackendAuth(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates an existing backend authentication resource.
This is a convenience which creates an instance of the UpdateBackendAuthRequest.Builder avoiding the need
to create one manually via UpdateBackendAuthRequest.builder()
updateBackendAuthRequest - A Consumer that will call methods on UpdateBackendAuthRequest.Builder to create a request.
The request body for UpdateBackendAuth.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendConfigResponse updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates the AWS resources that are required to access the Amplify Admin UI.
updateBackendConfigRequest - The request body for UpdateBackendConfig.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendConfigResponse updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates the AWS resources that are required to access the Amplify Admin UI.
This is a convenience which creates an instance of the UpdateBackendConfigRequest.Builder avoiding the
need to create one manually via UpdateBackendConfigRequest.builder()
updateBackendConfigRequest - A Consumer that will call methods on UpdateBackendConfigRequest.Builder to create a
request. The request body for UpdateBackendConfig.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendJobResponse updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates a specific job.
updateBackendJobRequest - The request body for GetBackendJob.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBackendJobResponse updateBackendJob(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException
Updates a specific job.
This is a convenience which creates an instance of the UpdateBackendJobRequest.Builder avoiding the need
to create one manually via UpdateBackendJobRequest.builder()
updateBackendJobRequest - A Consumer that will call methods on UpdateBackendJobRequest.Builder to create a request.
The request body for GetBackendJob.NotFoundException - 404 responseGatewayTimeoutException - 504 responseTooManyRequestsException - 429 responseBadRequestException - 400 responseSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AmplifyBackendException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.