Interface AmplifyBackendClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
AWS Amplify Admin API
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AmplifyBackendClientBuilder
builder()
Create a builder that can be used to configure and create aAmplifyBackendClient
.default CloneBackendResponse
cloneBackend
(Consumer<CloneBackendRequest.Builder> cloneBackendRequest) This operation clones an existing backend.default CloneBackendResponse
cloneBackend
(CloneBackendRequest cloneBackendRequest) This operation clones an existing backend.static AmplifyBackendClient
create()
Create aAmplifyBackendClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 CreateBackendStorageResponse
createBackendStorage
(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest) Creates a backend storage resource.default CreateBackendStorageResponse
createBackendStorage
(CreateBackendStorageRequest createBackendStorageRequest) Creates a backend storage resource.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 DeleteBackendStorageResponse
deleteBackendStorage
(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest) Removes the specified backend storage resource.default DeleteBackendStorageResponse
deleteBackendStorage
(DeleteBackendStorageRequest deleteBackendStorageRequest) Removes the specified backend storage 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) Gets a model introspection schema for an existing backend API resource.default GetBackendApiModelsResponse
getBackendAPIModels
(GetBackendApiModelsRequest getBackendApiModelsRequest) Gets a model introspection schema for an existing backend API resource.default GetBackendAuthResponse
getBackendAuth
(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest) Gets a backend auth details.default GetBackendAuthResponse
getBackendAuth
(GetBackendAuthRequest getBackendAuthRequest) Gets a 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 GetBackendStorageResponse
getBackendStorage
(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest) Gets details for a backend storage resource.default GetBackendStorageResponse
getBackendStorage
(GetBackendStorageRequest getBackendStorageRequest) Gets details for a backend storage resource.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 ImportBackendAuthResponse
importBackendAuth
(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest) Imports an existing backend authentication resource.default ImportBackendAuthResponse
importBackendAuth
(ImportBackendAuthRequest importBackendAuthRequest) Imports an existing backend authentication resource.default ImportBackendStorageResponse
importBackendStorage
(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest) Imports an existing backend storage resource.default ImportBackendStorageResponse
importBackendStorage
(ImportBackendStorageRequest importBackendStorageRequest) Imports an existing backend storage resource.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) This is a variant oflistBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.default ListBackendJobsIterable
listBackendJobsPaginator
(ListBackendJobsRequest listBackendJobsRequest) This is a variant oflistBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.default ListS3BucketsResponse
listS3Buckets
(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest) The list of S3 buckets in your account.default ListS3BucketsResponse
listS3Buckets
(ListS3BucketsRequest listS3BucketsRequest) The list of S3 buckets in your account.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 required to access the Amplify Admin UI.default RemoveBackendConfigResponse
removeBackendConfig
(RemoveBackendConfigRequest removeBackendConfigRequest) Removes the AWS resources required to access the Amplify Admin UI.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 required to access the Amplify Admin UI.default UpdateBackendConfigResponse
updateBackendConfig
(UpdateBackendConfigRequest updateBackendConfigRequest) Updates the AWS resources 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.default UpdateBackendStorageResponse
updateBackendStorage
(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest) Updates an existing backend storage resource.default UpdateBackendStorageResponse
updateBackendStorage
(UpdateBackendStorageRequest updateBackendStorageRequest) Updates an existing backend storage resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cloneBackend
default CloneBackendResponse cloneBackend(CloneBackendRequest cloneBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException This operation clones an existing backend.
- Parameters:
cloneBackendRequest
- The request body for CloneBackend.- Returns:
- Result of the CloneBackend operation returned by the service.
- See Also:
-
cloneBackend
default 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 viaCloneBackendRequest.builder()
- Parameters:
cloneBackendRequest
- AConsumer
that will call methods onCloneBackendRequest.Builder
to create a request. The request body for CloneBackend.- Returns:
- Result of the CloneBackend operation returned by the service.
- See Also:
-
createBackend
default 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.
- Parameters:
createBackendRequest
- The request body for CreateBackend.- Returns:
- Result of the CreateBackend operation returned by the service.
- See Also:
-
createBackend
default 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 viaCreateBackendRequest.builder()
- Parameters:
createBackendRequest
- AConsumer
that will call methods onCreateBackendRequest.Builder
to create a request. The request body for CreateBackend.- Returns:
- Result of the CreateBackend operation returned by the service.
- See Also:
-
createBackendAPI
default CreateBackendApiResponse createBackendAPI(CreateBackendApiRequest createBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Creates a new backend API resource.
- Parameters:
createBackendApiRequest
- The request body for CreateBackendAPI.- Returns:
- Result of the CreateBackendAPI operation returned by the service.
- See Also:
-
createBackendAPI
default 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 viaCreateBackendApiRequest.builder()
- Parameters:
createBackendApiRequest
- AConsumer
that will call methods onCreateBackendApiRequest.Builder
to create a request. The request body for CreateBackendAPI.- Returns:
- Result of the CreateBackendAPI operation returned by the service.
- See Also:
-
createBackendAuth
default CreateBackendAuthResponse createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Creates a new backend authentication resource.
- Parameters:
createBackendAuthRequest
- The request body for CreateBackendAuth.- Returns:
- Result of the CreateBackendAuth operation returned by the service.
- See Also:
-
createBackendAuth
default 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 viaCreateBackendAuthRequest.builder()
- Parameters:
createBackendAuthRequest
- AConsumer
that will call methods onCreateBackendAuthRequest.Builder
to create a request. The request body for CreateBackendAuth.- Returns:
- Result of the CreateBackendAuth operation returned by the service.
- See Also:
-
createBackendConfig
default CreateBackendConfigResponse createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Creates a config object for a backend.
- Parameters:
createBackendConfigRequest
- The request body for CreateBackendConfig.- Returns:
- Result of the CreateBackendConfig operation returned by the service.
- See Also:
-
createBackendConfig
default 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 viaCreateBackendConfigRequest.builder()
- Parameters:
createBackendConfigRequest
- AConsumer
that will call methods onCreateBackendConfigRequest.Builder
to create a request. The request body for CreateBackendConfig.- Returns:
- Result of the CreateBackendConfig operation returned by the service.
- See Also:
-
createBackendStorage
default CreateBackendStorageResponse createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Creates a backend storage resource.
- Parameters:
createBackendStorageRequest
- The request body for CreateBackendStorage.- Returns:
- Result of the CreateBackendStorage operation returned by the service.
- See Also:
-
createBackendStorage
default CreateBackendStorageResponse createBackendStorage(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Creates a backend storage resource.
This is a convenience which creates an instance of the
CreateBackendStorageRequest.Builder
avoiding the need to create one manually viaCreateBackendStorageRequest.builder()
- Parameters:
createBackendStorageRequest
- AConsumer
that will call methods onCreateBackendStorageRequest.Builder
to create a request. The request body for CreateBackendStorage.- Returns:
- Result of the CreateBackendStorage operation returned by the service.
- See Also:
-
createToken
default 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.
- Parameters:
createTokenRequest
-- Returns:
- Result of the CreateToken operation returned by the service.
- See Also:
-
createToken
default 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 viaCreateTokenRequest.builder()
- Parameters:
createTokenRequest
- AConsumer
that will call methods onCreateTokenRequest.Builder
to create a request.- Returns:
- Result of the CreateToken operation returned by the service.
- See Also:
-
deleteBackend
default DeleteBackendResponse deleteBackend(DeleteBackendRequest deleteBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Removes an existing environment from your Amplify project.
- Parameters:
deleteBackendRequest
-- Returns:
- Result of the DeleteBackend operation returned by the service.
- See Also:
-
deleteBackend
default 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 viaDeleteBackendRequest.builder()
- Parameters:
deleteBackendRequest
- AConsumer
that will call methods onDeleteBackendRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackend operation returned by the service.
- See Also:
-
deleteBackendAPI
default DeleteBackendApiResponse deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Deletes an existing backend API resource.
- Parameters:
deleteBackendApiRequest
- The request body for DeleteBackendAPI.- Returns:
- Result of the DeleteBackendAPI operation returned by the service.
- See Also:
-
deleteBackendAPI
default 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 viaDeleteBackendApiRequest.builder()
- Parameters:
deleteBackendApiRequest
- AConsumer
that will call methods onDeleteBackendApiRequest.Builder
to create a request. The request body for DeleteBackendAPI.- Returns:
- Result of the DeleteBackendAPI operation returned by the service.
- See Also:
-
deleteBackendAuth
default DeleteBackendAuthResponse deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Deletes an existing backend authentication resource.
- Parameters:
deleteBackendAuthRequest
- The request body for DeleteBackendAuth.- Returns:
- Result of the DeleteBackendAuth operation returned by the service.
- See Also:
-
deleteBackendAuth
default 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 viaDeleteBackendAuthRequest.builder()
- Parameters:
deleteBackendAuthRequest
- AConsumer
that will call methods onDeleteBackendAuthRequest.Builder
to create a request. The request body for DeleteBackendAuth.- Returns:
- Result of the DeleteBackendAuth operation returned by the service.
- See Also:
-
deleteBackendStorage
default DeleteBackendStorageResponse deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Removes the specified backend storage resource.
- Parameters:
deleteBackendStorageRequest
- The request body for DeleteBackendStorage.- Returns:
- Result of the DeleteBackendStorage operation returned by the service.
- See Also:
-
deleteBackendStorage
default DeleteBackendStorageResponse deleteBackendStorage(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Removes the specified backend storage resource.
This is a convenience which creates an instance of the
DeleteBackendStorageRequest.Builder
avoiding the need to create one manually viaDeleteBackendStorageRequest.builder()
- Parameters:
deleteBackendStorageRequest
- AConsumer
that will call methods onDeleteBackendStorageRequest.Builder
to create a request. The request body for DeleteBackendStorage.- Returns:
- Result of the DeleteBackendStorage operation returned by the service.
- See Also:
-
deleteToken
default DeleteTokenResponse deleteToken(DeleteTokenRequest deleteTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Deletes the challenge token based on the given appId and sessionId.
- Parameters:
deleteTokenRequest
-- Returns:
- Result of the DeleteToken operation returned by the service.
- See Also:
-
deleteToken
default 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 viaDeleteTokenRequest.builder()
- Parameters:
deleteTokenRequest
- AConsumer
that will call methods onDeleteTokenRequest.Builder
to create a request.- Returns:
- Result of the DeleteToken operation returned by the service.
- See Also:
-
generateBackendAPIModels
default GenerateBackendApiModelsResponse generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Generates a model schema for an existing backend API resource.
- Parameters:
generateBackendApiModelsRequest
- The request body for GenerateBackendAPIModels.- Returns:
- Result of the GenerateBackendAPIModels operation returned by the service.
- See Also:
-
generateBackendAPIModels
default 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 viaGenerateBackendApiModelsRequest.builder()
- Parameters:
generateBackendApiModelsRequest
- AConsumer
that will call methods onGenerateBackendApiModelsRequest.Builder
to create a request. The request body for GenerateBackendAPIModels.- Returns:
- Result of the GenerateBackendAPIModels operation returned by the service.
- See Also:
-
getBackend
default GetBackendResponse getBackend(GetBackendRequest getBackendRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Provides project-level details for your Amplify UI project.
- Parameters:
getBackendRequest
- The request body for GetBackend.- Returns:
- Result of the GetBackend operation returned by the service.
- See Also:
-
getBackend
default 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 viaGetBackendRequest.builder()
- Parameters:
getBackendRequest
- AConsumer
that will call methods onGetBackendRequest.Builder
to create a request. The request body for GetBackend.- Returns:
- Result of the GetBackend operation returned by the service.
- See Also:
-
getBackendAPI
default GetBackendApiResponse getBackendAPI(GetBackendApiRequest getBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets the details for a backend API.
- Parameters:
getBackendApiRequest
- The request body for GetBackendAPI.- Returns:
- Result of the GetBackendAPI operation returned by the service.
- See Also:
-
getBackendAPI
default 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 viaGetBackendApiRequest.builder()
- Parameters:
getBackendApiRequest
- AConsumer
that will call methods onGetBackendApiRequest.Builder
to create a request. The request body for GetBackendAPI.- Returns:
- Result of the GetBackendAPI operation returned by the service.
- See Also:
-
getBackendAPIModels
default GetBackendApiModelsResponse getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets a model introspection schema for an existing backend API resource.
- Parameters:
getBackendApiModelsRequest
- The request body for GetBackendAPIModels.- Returns:
- Result of the GetBackendAPIModels operation returned by the service.
- See Also:
-
getBackendAPIModels
default GetBackendApiModelsResponse getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets a model introspection schema for an existing backend API resource.
This is a convenience which creates an instance of the
GetBackendApiModelsRequest.Builder
avoiding the need to create one manually viaGetBackendApiModelsRequest.builder()
- Parameters:
getBackendApiModelsRequest
- AConsumer
that will call methods onGetBackendApiModelsRequest.Builder
to create a request. The request body for GetBackendAPIModels.- Returns:
- Result of the GetBackendAPIModels operation returned by the service.
- See Also:
-
getBackendAuth
default GetBackendAuthResponse getBackendAuth(GetBackendAuthRequest getBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets a backend auth details.
- Parameters:
getBackendAuthRequest
- The request body for GetBackendAuth.- Returns:
- Result of the GetBackendAuth operation returned by the service.
- See Also:
-
getBackendAuth
default GetBackendAuthResponse getBackendAuth(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets a backend auth details.
This is a convenience which creates an instance of the
GetBackendAuthRequest.Builder
avoiding the need to create one manually viaGetBackendAuthRequest.builder()
- Parameters:
getBackendAuthRequest
- AConsumer
that will call methods onGetBackendAuthRequest.Builder
to create a request. The request body for GetBackendAuth.- Returns:
- Result of the GetBackendAuth operation returned by the service.
- See Also:
-
getBackendJob
default GetBackendJobResponse getBackendJob(GetBackendJobRequest getBackendJobRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Returns information about a specific job.
- Parameters:
getBackendJobRequest
-- Returns:
- Result of the GetBackendJob operation returned by the service.
- See Also:
-
getBackendJob
default 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 viaGetBackendJobRequest.builder()
- Parameters:
getBackendJobRequest
- AConsumer
that will call methods onGetBackendJobRequest.Builder
to create a request.- Returns:
- Result of the GetBackendJob operation returned by the service.
- See Also:
-
getBackendStorage
default GetBackendStorageResponse getBackendStorage(GetBackendStorageRequest getBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets details for a backend storage resource.
- Parameters:
getBackendStorageRequest
- The request body for GetBackendStorage.- Returns:
- Result of the GetBackendStorage operation returned by the service.
- See Also:
-
getBackendStorage
default GetBackendStorageResponse getBackendStorage(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets details for a backend storage resource.
This is a convenience which creates an instance of the
GetBackendStorageRequest.Builder
avoiding the need to create one manually viaGetBackendStorageRequest.builder()
- Parameters:
getBackendStorageRequest
- AConsumer
that will call methods onGetBackendStorageRequest.Builder
to create a request. The request body for GetBackendStorage.- Returns:
- Result of the GetBackendStorage operation returned by the service.
- See Also:
-
getToken
default GetTokenResponse getToken(GetTokenRequest getTokenRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Gets the challenge token based on the given appId and sessionId.
- Parameters:
getTokenRequest
-- Returns:
- Result of the GetToken operation returned by the service.
- See Also:
-
getToken
default 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 viaGetTokenRequest.builder()
- Parameters:
getTokenRequest
- AConsumer
that will call methods onGetTokenRequest.Builder
to create a request.- Returns:
- Result of the GetToken operation returned by the service.
- See Also:
-
importBackendAuth
default ImportBackendAuthResponse importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Imports an existing backend authentication resource.
- Parameters:
importBackendAuthRequest
- The request body for ImportBackendAuth.- Returns:
- Result of the ImportBackendAuth operation returned by the service.
- See Also:
-
importBackendAuth
default ImportBackendAuthResponse importBackendAuth(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Imports an existing backend authentication resource.
This is a convenience which creates an instance of the
ImportBackendAuthRequest.Builder
avoiding the need to create one manually viaImportBackendAuthRequest.builder()
- Parameters:
importBackendAuthRequest
- AConsumer
that will call methods onImportBackendAuthRequest.Builder
to create a request. The request body for ImportBackendAuth.- Returns:
- Result of the ImportBackendAuth operation returned by the service.
- See Also:
-
importBackendStorage
default ImportBackendStorageResponse importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Imports an existing backend storage resource.
- Parameters:
importBackendStorageRequest
- The request body for ImportBackendStorage.- Returns:
- Result of the ImportBackendStorage operation returned by the service.
- See Also:
-
importBackendStorage
default ImportBackendStorageResponse importBackendStorage(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Imports an existing backend storage resource.
This is a convenience which creates an instance of the
ImportBackendStorageRequest.Builder
avoiding the need to create one manually viaImportBackendStorageRequest.builder()
- Parameters:
importBackendStorageRequest
- AConsumer
that will call methods onImportBackendStorageRequest.Builder
to create a request. The request body for ImportBackendStorage.- Returns:
- Result of the ImportBackendStorage operation returned by the service.
- See Also:
-
listBackendJobs
default ListBackendJobsResponse listBackendJobs(ListBackendJobsRequest listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Lists the jobs for the backend of an Amplify app.
- Parameters:
listBackendJobsRequest
- The request body for ListBackendJobs.- Returns:
- Result of the ListBackendJobs operation returned by the service.
- See Also:
-
listBackendJobs
default 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 viaListBackendJobsRequest.builder()
- Parameters:
listBackendJobsRequest
- AConsumer
that will call methods onListBackendJobsRequest.Builder
to create a request. The request body for ListBackendJobs.- Returns:
- Result of the ListBackendJobs operation returned by the service.
- See Also:
-
listBackendJobsPaginator
default ListBackendJobsIterable listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException 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 Streamsoftware.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listBackendJobsRequest
- The request body for ListBackendJobs.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBackendJobsPaginator
default ListBackendJobsIterable listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException 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 Streamsoftware.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListBackendJobsRequest.builder()
- Parameters:
listBackendJobsRequest
- AConsumer
that will call methods onListBackendJobsRequest.Builder
to create a request. The request body for ListBackendJobs.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listS3Buckets
default ListS3BucketsResponse listS3Buckets(ListS3BucketsRequest listS3BucketsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException The list of S3 buckets in your account.
- Parameters:
listS3BucketsRequest
- The request body for S3Buckets.- Returns:
- Result of the ListS3Buckets operation returned by the service.
- See Also:
-
listS3Buckets
default ListS3BucketsResponse listS3Buckets(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException The list of S3 buckets in your account.
This is a convenience which creates an instance of the
ListS3BucketsRequest.Builder
avoiding the need to create one manually viaListS3BucketsRequest.builder()
- Parameters:
listS3BucketsRequest
- AConsumer
that will call methods onListS3BucketsRequest.Builder
to create a request. The request body for S3Buckets.- Returns:
- Result of the ListS3Buckets operation returned by the service.
- See Also:
-
removeAllBackends
default RemoveAllBackendsResponse removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Removes all backend environments from your Amplify project.
- Parameters:
removeAllBackendsRequest
- The request body for RemoveAllBackends.- Returns:
- Result of the RemoveAllBackends operation returned by the service.
- See Also:
-
removeAllBackends
default 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 viaRemoveAllBackendsRequest.builder()
- Parameters:
removeAllBackendsRequest
- AConsumer
that will call methods onRemoveAllBackendsRequest.Builder
to create a request. The request body for RemoveAllBackends.- Returns:
- Result of the RemoveAllBackends operation returned by the service.
- See Also:
-
removeBackendConfig
default RemoveBackendConfigResponse removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Removes the AWS resources required to access the Amplify Admin UI.
- Parameters:
removeBackendConfigRequest
-- Returns:
- Result of the RemoveBackendConfig operation returned by the service.
- See Also:
-
removeBackendConfig
default RemoveBackendConfigResponse removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Removes the AWS resources 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 viaRemoveBackendConfigRequest.builder()
- Parameters:
removeBackendConfigRequest
- AConsumer
that will call methods onRemoveBackendConfigRequest.Builder
to create a request.- Returns:
- Result of the RemoveBackendConfig operation returned by the service.
- See Also:
-
updateBackendAPI
default UpdateBackendApiResponse updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates an existing backend API resource.
- Parameters:
updateBackendApiRequest
- The request body for UpdateBackendAPI.- Returns:
- Result of the UpdateBackendAPI operation returned by the service.
- See Also:
-
updateBackendAPI
default 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 viaUpdateBackendApiRequest.builder()
- Parameters:
updateBackendApiRequest
- AConsumer
that will call methods onUpdateBackendApiRequest.Builder
to create a request. The request body for UpdateBackendAPI.- Returns:
- Result of the UpdateBackendAPI operation returned by the service.
- See Also:
-
updateBackendAuth
default UpdateBackendAuthResponse updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates an existing backend authentication resource.
- Parameters:
updateBackendAuthRequest
- The request body for UpdateBackendAuth.- Returns:
- Result of the UpdateBackendAuth operation returned by the service.
- See Also:
-
updateBackendAuth
default 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 viaUpdateBackendAuthRequest.builder()
- Parameters:
updateBackendAuthRequest
- AConsumer
that will call methods onUpdateBackendAuthRequest.Builder
to create a request. The request body for UpdateBackendAuth.- Returns:
- Result of the UpdateBackendAuth operation returned by the service.
- See Also:
-
updateBackendConfig
default UpdateBackendConfigResponse updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates the AWS resources required to access the Amplify Admin UI.
- Parameters:
updateBackendConfigRequest
- The request body for UpdateBackendConfig.- Returns:
- Result of the UpdateBackendConfig operation returned by the service.
- See Also:
-
updateBackendConfig
default UpdateBackendConfigResponse updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates the AWS resources 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 viaUpdateBackendConfigRequest.builder()
- Parameters:
updateBackendConfigRequest
- AConsumer
that will call methods onUpdateBackendConfigRequest.Builder
to create a request. The request body for UpdateBackendConfig.- Returns:
- Result of the UpdateBackendConfig operation returned by the service.
- See Also:
-
updateBackendJob
default UpdateBackendJobResponse updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates a specific job.
- Parameters:
updateBackendJobRequest
- The request body for GetBackendJob.- Returns:
- Result of the UpdateBackendJob operation returned by the service.
- See Also:
-
updateBackendJob
default 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 viaUpdateBackendJobRequest.builder()
- Parameters:
updateBackendJobRequest
- AConsumer
that will call methods onUpdateBackendJobRequest.Builder
to create a request. The request body for GetBackendJob.- Returns:
- Result of the UpdateBackendJob operation returned by the service.
- See Also:
-
updateBackendStorage
default UpdateBackendStorageResponse updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates an existing backend storage resource.
- Parameters:
updateBackendStorageRequest
- The request body for UpdateBackendStorage.- Returns:
- Result of the UpdateBackendStorage operation returned by the service.
- See Also:
-
updateBackendStorage
default UpdateBackendStorageResponse updateBackendStorage(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest) throws NotFoundException, GatewayTimeoutException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, AmplifyBackendException Updates an existing backend storage resource.
This is a convenience which creates an instance of the
UpdateBackendStorageRequest.Builder
avoiding the need to create one manually viaUpdateBackendStorageRequest.builder()
- Parameters:
updateBackendStorageRequest
- AConsumer
that will call methods onUpdateBackendStorageRequest.Builder
to create a request. The request body for UpdateBackendStorage.- Returns:
- Result of the UpdateBackendStorage operation returned by the service.
- See Also:
-
create
Create aAmplifyBackendClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAmplifyBackendClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-