/*
* 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 amplifyuibuilder-2021-08-11.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.AmplifyUIBuilder.Model;
namespace Amazon.AmplifyUIBuilder
{
///
/// Interface for accessing AmplifyUIBuilder
///
/// The Amplify UI Builder API provides a programmatic interface for creating and configuring
/// user interface (UI) component libraries and themes for use in your Amplify applications.
/// You can then connect these UI components to an application's backend Amazon Web Services
/// resources.
///
///
///
/// You can also use the Amplify Studio visual designer to create UI components and model
/// data for an app. For more information, see Introduction
/// in the Amplify Docs.
///
///
///
/// The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
/// for client app development. For more information, see the Amplify
/// Framework. For more information about deploying an Amplify application to Amazon
/// Web Services, see the Amplify
/// User Guide.
///
///
public partial interface IAmazonAmplifyUIBuilder : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IAmplifyUIBuilderPaginatorFactory Paginators { get; }
#endif
#region CreateComponent
///
/// Creates a new component for an Amplify app.
///
/// Container for the necessary parameters to execute the CreateComponent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateComponent service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The resource specified in the request conflicts with an existing resource.
///
///
/// You exceeded your service quota. Service quotas, also referred to as limits, are the
/// maximum number of service resources or operations for your Amazon Web Services account.
///
/// REST API Reference for CreateComponent Operation
Task CreateComponentAsync(CreateComponentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateForm
///
/// Creates a new form for an Amplify.
///
/// Container for the necessary parameters to execute the CreateForm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateForm service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The resource specified in the request conflicts with an existing resource.
///
///
/// You exceeded your service quota. Service quotas, also referred to as limits, are the
/// maximum number of service resources or operations for your Amazon Web Services account.
///
/// REST API Reference for CreateForm Operation
Task CreateFormAsync(CreateFormRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateTheme
///
/// Creates a theme to apply to the components in an Amplify app.
///
/// Container for the necessary parameters to execute the CreateTheme service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateTheme service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The resource specified in the request conflicts with an existing resource.
///
///
/// You exceeded your service quota. Service quotas, also referred to as limits, are the
/// maximum number of service resources or operations for your Amazon Web Services account.
///
/// REST API Reference for CreateTheme Operation
Task CreateThemeAsync(CreateThemeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteComponent
///
/// Deletes a component from an Amplify app.
///
/// Container for the necessary parameters to execute the DeleteComponent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteComponent service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
/// REST API Reference for DeleteComponent Operation
Task DeleteComponentAsync(DeleteComponentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteForm
///
/// Deletes a form from an Amplify app.
///
/// Container for the necessary parameters to execute the DeleteForm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteForm service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
/// REST API Reference for DeleteForm Operation
Task DeleteFormAsync(DeleteFormRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteTheme
///
/// Deletes a theme from an Amplify app.
///
/// Container for the necessary parameters to execute the DeleteTheme service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteTheme service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
/// REST API Reference for DeleteTheme Operation
Task DeleteThemeAsync(DeleteThemeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExchangeCodeForToken
///
/// Exchanges an access code for a token.
///
/// Container for the necessary parameters to execute the ExchangeCodeForToken service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExchangeCodeForToken service method, as returned by AmplifyUIBuilder.
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ExchangeCodeForToken Operation
Task ExchangeCodeForTokenAsync(ExchangeCodeForTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExportComponents
///
/// Exports component configurations to code that is ready to integrate into an Amplify
/// app.
///
/// Container for the necessary parameters to execute the ExportComponents service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExportComponents service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ExportComponents Operation
Task ExportComponentsAsync(ExportComponentsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExportForms
///
/// Exports form configurations to code that is ready to integrate into an Amplify app.
///
/// Container for the necessary parameters to execute the ExportForms service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExportForms service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ExportForms Operation
Task ExportFormsAsync(ExportFormsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ExportThemes
///
/// Exports theme configurations to code that is ready to integrate into an Amplify app.
///
/// Container for the necessary parameters to execute the ExportThemes service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ExportThemes service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ExportThemes Operation
Task ExportThemesAsync(ExportThemesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetCodegenJob
///
/// Returns an existing code generation job.
///
/// Container for the necessary parameters to execute the GetCodegenJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetCodegenJob service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
///
/// The request was denied due to request throttling.
///
/// REST API Reference for GetCodegenJob Operation
Task GetCodegenJobAsync(GetCodegenJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetComponent
///
/// Returns an existing component for an Amplify app.
///
/// Container for the necessary parameters to execute the GetComponent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetComponent service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
/// REST API Reference for GetComponent Operation
Task GetComponentAsync(GetComponentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetForm
///
/// Returns an existing form for an Amplify app.
///
/// Container for the necessary parameters to execute the GetForm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetForm service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
/// REST API Reference for GetForm Operation
Task GetFormAsync(GetFormRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetMetadata
///
/// Returns existing metadata for an Amplify app.
///
/// Container for the necessary parameters to execute the GetMetadata service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMetadata service method, as returned by AmplifyUIBuilder.
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// You don't have permission to perform this operation.
///
/// REST API Reference for GetMetadata Operation
Task GetMetadataAsync(GetMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetTheme
///
/// Returns an existing theme for an Amplify app.
///
/// Container for the necessary parameters to execute the GetTheme service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetTheme service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The requested resource does not exist, or access was denied.
///
/// REST API Reference for GetTheme Operation
Task GetThemeAsync(GetThemeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListCodegenJobs
///
/// Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
///
/// Container for the necessary parameters to execute the ListCodegenJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListCodegenJobs service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The request was denied due to request throttling.
///
/// REST API Reference for ListCodegenJobs Operation
Task ListCodegenJobsAsync(ListCodegenJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListComponents
///
/// Retrieves a list of components for a specified Amplify app and backend environment.
///
/// Container for the necessary parameters to execute the ListComponents service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListComponents service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ListComponents Operation
Task ListComponentsAsync(ListComponentsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListForms
///
/// Retrieves a list of forms for a specified Amplify app and backend environment.
///
/// Container for the necessary parameters to execute the ListForms service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListForms service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ListForms Operation
Task ListFormsAsync(ListFormsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListThemes
///
/// Retrieves a list of themes for a specified Amplify app and backend environment.
///
/// Container for the necessary parameters to execute the ListThemes service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListThemes service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for ListThemes Operation
Task ListThemesAsync(ListThemesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutMetadataFlag
///
/// Stores the metadata information about a feature on a form.
///
/// Container for the necessary parameters to execute the PutMetadataFlag service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutMetadataFlag service method, as returned by AmplifyUIBuilder.
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// You don't have permission to perform this operation.
///
/// REST API Reference for PutMetadataFlag Operation
Task PutMetadataFlagAsync(PutMetadataFlagRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RefreshToken
///
/// Refreshes a previously issued access token that might have expired.
///
/// Container for the necessary parameters to execute the RefreshToken service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RefreshToken service method, as returned by AmplifyUIBuilder.
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
/// REST API Reference for RefreshToken Operation
Task RefreshTokenAsync(RefreshTokenRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartCodegenJob
///
/// Starts a code generation job for for a specified Amplify app and backend environment.
///
/// Container for the necessary parameters to execute the StartCodegenJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartCodegenJob service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The request was denied due to request throttling.
///
/// REST API Reference for StartCodegenJob Operation
Task StartCodegenJobAsync(StartCodegenJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateComponent
///
/// Updates an existing component.
///
/// Container for the necessary parameters to execute the UpdateComponent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateComponent service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The resource specified in the request conflicts with an existing resource.
///
/// REST API Reference for UpdateComponent Operation
Task UpdateComponentAsync(UpdateComponentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateForm
///
/// Updates an existing form.
///
/// Container for the necessary parameters to execute the UpdateForm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateForm service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The resource specified in the request conflicts with an existing resource.
///
/// REST API Reference for UpdateForm Operation
Task UpdateFormAsync(UpdateFormRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateTheme
///
/// Updates an existing theme.
///
/// Container for the necessary parameters to execute the UpdateTheme service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateTheme service method, as returned by AmplifyUIBuilder.
///
/// An internal error has occurred. Please retry your request.
///
///
/// An invalid or out-of-range value was supplied for the input parameter.
///
///
/// The resource specified in the request conflicts with an existing resource.
///
/// REST API Reference for UpdateTheme Operation
Task UpdateThemeAsync(UpdateThemeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}