/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the amplifybackend-2020-08-11.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.AmplifyBackend.Model; namespace Amazon.AmplifyBackend { /// /// Interface for accessing AmplifyBackend /// /// AWS Amplify Admin API /// public partial interface IAmazonAmplifyBackend : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IAmplifyBackendPaginatorFactory Paginators { get; } #endif #region CloneBackend /// /// This operation clones an existing backend. /// /// Container for the necessary parameters to execute the CloneBackend service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CloneBackend service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CloneBackend Operation Task CloneBackendAsync(CloneBackendRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateBackend /// /// This operation creates a backend for an Amplify app. Backends are automatically created /// at the time of app creation. /// /// Container for the necessary parameters to execute the CreateBackend service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateBackend service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CreateBackend Operation Task CreateBackendAsync(CreateBackendRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateBackendAPI /// /// Creates a new backend API resource. /// /// Container for the necessary parameters to execute the CreateBackendAPI service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateBackendAPI service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CreateBackendAPI Operation Task CreateBackendAPIAsync(CreateBackendAPIRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateBackendAuth /// /// Creates a new backend authentication resource. /// /// Container for the necessary parameters to execute the CreateBackendAuth service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateBackendAuth service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CreateBackendAuth Operation Task CreateBackendAuthAsync(CreateBackendAuthRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateBackendConfig /// /// Creates a config object for a backend. /// /// Container for the necessary parameters to execute the CreateBackendConfig service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateBackendConfig service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CreateBackendConfig Operation Task CreateBackendConfigAsync(CreateBackendConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateBackendStorage /// /// Creates a backend storage resource. /// /// Container for the necessary parameters to execute the CreateBackendStorage service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateBackendStorage service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CreateBackendStorage Operation Task CreateBackendStorageAsync(CreateBackendStorageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateToken /// /// Generates a one-time challenge code to authenticate a user into your Amplify Admin /// UI. /// /// Container for the necessary parameters to execute the CreateToken service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateToken service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for CreateToken Operation Task CreateTokenAsync(CreateTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteBackend /// /// Removes an existing environment from your Amplify project. /// /// Container for the necessary parameters to execute the DeleteBackend service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteBackend service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for DeleteBackend Operation Task DeleteBackendAsync(DeleteBackendRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteBackendAPI /// /// Deletes an existing backend API resource. /// /// Container for the necessary parameters to execute the DeleteBackendAPI service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteBackendAPI service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for DeleteBackendAPI Operation Task DeleteBackendAPIAsync(DeleteBackendAPIRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteBackendAuth /// /// Deletes an existing backend authentication resource. /// /// Container for the necessary parameters to execute the DeleteBackendAuth service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteBackendAuth service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for DeleteBackendAuth Operation Task DeleteBackendAuthAsync(DeleteBackendAuthRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteBackendStorage /// /// Removes the specified backend storage resource. /// /// Container for the necessary parameters to execute the DeleteBackendStorage service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteBackendStorage service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for DeleteBackendStorage Operation Task DeleteBackendStorageAsync(DeleteBackendStorageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteToken /// /// Deletes the challenge token based on the given appId and sessionId. /// /// Container for the necessary parameters to execute the DeleteToken service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteToken service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for DeleteToken Operation Task DeleteTokenAsync(DeleteTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GenerateBackendAPIModels /// /// Generates a model schema for an existing backend API resource. /// /// Container for the necessary parameters to execute the GenerateBackendAPIModels service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GenerateBackendAPIModels service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GenerateBackendAPIModels Operation Task GenerateBackendAPIModelsAsync(GenerateBackendAPIModelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBackend /// /// Provides project-level details for your Amplify UI project. /// /// Container for the necessary parameters to execute the GetBackend service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBackend service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetBackend Operation Task GetBackendAsync(GetBackendRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBackendAPI /// /// Gets the details for a backend API. /// /// Container for the necessary parameters to execute the GetBackendAPI service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBackendAPI service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetBackendAPI Operation Task GetBackendAPIAsync(GetBackendAPIRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBackendAPIModels /// /// Gets a model introspection schema for an existing backend API resource. /// /// Container for the necessary parameters to execute the GetBackendAPIModels service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBackendAPIModels service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetBackendAPIModels Operation Task GetBackendAPIModelsAsync(GetBackendAPIModelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBackendAuth /// /// Gets a backend auth details. /// /// Container for the necessary parameters to execute the GetBackendAuth service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBackendAuth service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetBackendAuth Operation Task GetBackendAuthAsync(GetBackendAuthRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBackendJob /// /// Returns information about a specific job. /// /// Container for the necessary parameters to execute the GetBackendJob service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBackendJob service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetBackendJob Operation Task GetBackendJobAsync(GetBackendJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBackendStorage /// /// Gets details for a backend storage resource. /// /// Container for the necessary parameters to execute the GetBackendStorage service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBackendStorage service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetBackendStorage Operation Task GetBackendStorageAsync(GetBackendStorageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetToken /// /// Gets the challenge token based on the given appId and sessionId. /// /// Container for the necessary parameters to execute the GetToken service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetToken service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for GetToken Operation Task GetTokenAsync(GetTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportBackendAuth /// /// Imports an existing backend authentication resource. /// /// Container for the necessary parameters to execute the ImportBackendAuth service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportBackendAuth service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for ImportBackendAuth Operation Task ImportBackendAuthAsync(ImportBackendAuthRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportBackendStorage /// /// Imports an existing backend storage resource. /// /// Container for the necessary parameters to execute the ImportBackendStorage service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportBackendStorage service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for ImportBackendStorage Operation Task ImportBackendStorageAsync(ImportBackendStorageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListBackendJobs /// /// Lists the jobs for the backend of an Amplify app. /// /// Container for the necessary parameters to execute the ListBackendJobs service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListBackendJobs service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for ListBackendJobs Operation Task ListBackendJobsAsync(ListBackendJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListS3Buckets /// /// The list of S3 buckets in your account. /// /// Container for the necessary parameters to execute the ListS3Buckets service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListS3Buckets service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for ListS3Buckets Operation Task ListS3BucketsAsync(ListS3BucketsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveAllBackends /// /// Removes all backend environments from your Amplify project. /// /// Container for the necessary parameters to execute the RemoveAllBackends service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveAllBackends service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for RemoveAllBackends Operation Task RemoveAllBackendsAsync(RemoveAllBackendsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveBackendConfig /// /// Removes the AWS resources required to access the Amplify Admin UI. /// /// Container for the necessary parameters to execute the RemoveBackendConfig service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveBackendConfig service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for RemoveBackendConfig Operation Task RemoveBackendConfigAsync(RemoveBackendConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateBackendAPI /// /// Updates an existing backend API resource. /// /// Container for the necessary parameters to execute the UpdateBackendAPI service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateBackendAPI service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for UpdateBackendAPI Operation Task UpdateBackendAPIAsync(UpdateBackendAPIRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateBackendAuth /// /// Updates an existing backend authentication resource. /// /// Container for the necessary parameters to execute the UpdateBackendAuth service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateBackendAuth service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for UpdateBackendAuth Operation Task UpdateBackendAuthAsync(UpdateBackendAuthRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateBackendConfig /// /// Updates the AWS resources required to access the Amplify Admin UI. /// /// Container for the necessary parameters to execute the UpdateBackendConfig service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateBackendConfig service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for UpdateBackendConfig Operation Task UpdateBackendConfigAsync(UpdateBackendConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateBackendJob /// /// Updates a specific job. /// /// Container for the necessary parameters to execute the UpdateBackendJob service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateBackendJob service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for UpdateBackendJob Operation Task UpdateBackendJobAsync(UpdateBackendJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateBackendStorage /// /// Updates an existing backend storage resource. /// /// Container for the necessary parameters to execute the UpdateBackendStorage service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateBackendStorage service method, as returned by AmplifyBackend. /// /// An error returned if a request is not formed properly. /// /// /// An error returned if there's a temporary issue with the service. /// /// /// An error returned when a specific resource type is not found. /// /// /// An error that is returned when a limit of a specific type has been exceeded. /// /// REST API Reference for UpdateBackendStorage Operation Task UpdateBackendStorageAsync(UpdateBackendStorageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }