/*
* 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 docdb-elastic-2022-11-28.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.DocDBElastic.Model;
namespace Amazon.DocDBElastic
{
///
/// Interface for accessing DocDBElastic
///
/// The new Amazon Elastic DocumentDB service endpoint.
///
public partial interface IAmazonDocDBElastic : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IDocDBElasticPaginatorFactory Paginators { get; }
#endif
#region CreateCluster
///
/// Creates a new Elastic DocumentDB cluster and returns its Cluster structure.
///
/// Container for the necessary parameters to execute the CreateCluster service method.
///
/// The response from the CreateCluster service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an access conflict.
///
///
/// There was an internal server error.
///
///
/// The service quota for the action was exceeded.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for CreateCluster Operation
CreateClusterResponse CreateCluster(CreateClusterRequest request);
///
/// Initiates the asynchronous execution of the CreateCluster operation.
///
///
/// Container for the necessary parameters to execute the CreateCluster operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCluster
/// operation.
/// REST API Reference for CreateCluster Operation
IAsyncResult BeginCreateCluster(CreateClusterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateCluster operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateCluster.
///
/// Returns a CreateClusterResult from DocDBElastic.
/// REST API Reference for CreateCluster Operation
CreateClusterResponse EndCreateCluster(IAsyncResult asyncResult);
#endregion
#region CreateClusterSnapshot
///
/// Creates a snapshot of a cluster.
///
/// Container for the necessary parameters to execute the CreateClusterSnapshot service method.
///
/// The response from the CreateClusterSnapshot service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an access conflict.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// The service quota for the action was exceeded.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for CreateClusterSnapshot Operation
CreateClusterSnapshotResponse CreateClusterSnapshot(CreateClusterSnapshotRequest request);
///
/// Initiates the asynchronous execution of the CreateClusterSnapshot operation.
///
///
/// Container for the necessary parameters to execute the CreateClusterSnapshot operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateClusterSnapshot
/// operation.
/// REST API Reference for CreateClusterSnapshot Operation
IAsyncResult BeginCreateClusterSnapshot(CreateClusterSnapshotRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateClusterSnapshot operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateClusterSnapshot.
///
/// Returns a CreateClusterSnapshotResult from DocDBElastic.
/// REST API Reference for CreateClusterSnapshot Operation
CreateClusterSnapshotResponse EndCreateClusterSnapshot(IAsyncResult asyncResult);
#endregion
#region DeleteCluster
///
/// Delete a Elastic DocumentDB cluster.
///
/// Container for the necessary parameters to execute the DeleteCluster service method.
///
/// The response from the DeleteCluster service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an access conflict.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for DeleteCluster Operation
DeleteClusterResponse DeleteCluster(DeleteClusterRequest request);
///
/// Initiates the asynchronous execution of the DeleteCluster operation.
///
///
/// Container for the necessary parameters to execute the DeleteCluster operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCluster
/// operation.
/// REST API Reference for DeleteCluster Operation
IAsyncResult BeginDeleteCluster(DeleteClusterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteCluster operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteCluster.
///
/// Returns a DeleteClusterResult from DocDBElastic.
/// REST API Reference for DeleteCluster Operation
DeleteClusterResponse EndDeleteCluster(IAsyncResult asyncResult);
#endregion
#region DeleteClusterSnapshot
///
/// Delete a Elastic DocumentDB snapshot.
///
/// Container for the necessary parameters to execute the DeleteClusterSnapshot service method.
///
/// The response from the DeleteClusterSnapshot service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an access conflict.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for DeleteClusterSnapshot Operation
DeleteClusterSnapshotResponse DeleteClusterSnapshot(DeleteClusterSnapshotRequest request);
///
/// Initiates the asynchronous execution of the DeleteClusterSnapshot operation.
///
///
/// Container for the necessary parameters to execute the DeleteClusterSnapshot operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteClusterSnapshot
/// operation.
/// REST API Reference for DeleteClusterSnapshot Operation
IAsyncResult BeginDeleteClusterSnapshot(DeleteClusterSnapshotRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteClusterSnapshot operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteClusterSnapshot.
///
/// Returns a DeleteClusterSnapshotResult from DocDBElastic.
/// REST API Reference for DeleteClusterSnapshot Operation
DeleteClusterSnapshotResponse EndDeleteClusterSnapshot(IAsyncResult asyncResult);
#endregion
#region GetCluster
///
/// Returns information about a specific Elastic DocumentDB cluster.
///
/// Container for the necessary parameters to execute the GetCluster service method.
///
/// The response from the GetCluster service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for GetCluster Operation
GetClusterResponse GetCluster(GetClusterRequest request);
///
/// Initiates the asynchronous execution of the GetCluster operation.
///
///
/// Container for the necessary parameters to execute the GetCluster operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCluster
/// operation.
/// REST API Reference for GetCluster Operation
IAsyncResult BeginGetCluster(GetClusterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetCluster operation.
///
///
/// The IAsyncResult returned by the call to BeginGetCluster.
///
/// Returns a GetClusterResult from DocDBElastic.
/// REST API Reference for GetCluster Operation
GetClusterResponse EndGetCluster(IAsyncResult asyncResult);
#endregion
#region GetClusterSnapshot
///
/// Returns information about a specific Elastic DocumentDB snapshot
///
/// Container for the necessary parameters to execute the GetClusterSnapshot service method.
///
/// The response from the GetClusterSnapshot service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for GetClusterSnapshot Operation
GetClusterSnapshotResponse GetClusterSnapshot(GetClusterSnapshotRequest request);
///
/// Initiates the asynchronous execution of the GetClusterSnapshot operation.
///
///
/// Container for the necessary parameters to execute the GetClusterSnapshot operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetClusterSnapshot
/// operation.
/// REST API Reference for GetClusterSnapshot Operation
IAsyncResult BeginGetClusterSnapshot(GetClusterSnapshotRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetClusterSnapshot operation.
///
///
/// The IAsyncResult returned by the call to BeginGetClusterSnapshot.
///
/// Returns a GetClusterSnapshotResult from DocDBElastic.
/// REST API Reference for GetClusterSnapshot Operation
GetClusterSnapshotResponse EndGetClusterSnapshot(IAsyncResult asyncResult);
#endregion
#region ListClusters
///
/// Returns information about provisioned Elastic DocumentDB clusters.
///
/// Container for the necessary parameters to execute the ListClusters service method.
///
/// The response from the ListClusters service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an internal server error.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for ListClusters Operation
ListClustersResponse ListClusters(ListClustersRequest request);
///
/// Initiates the asynchronous execution of the ListClusters operation.
///
///
/// Container for the necessary parameters to execute the ListClusters operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClusters
/// operation.
/// REST API Reference for ListClusters Operation
IAsyncResult BeginListClusters(ListClustersRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListClusters operation.
///
///
/// The IAsyncResult returned by the call to BeginListClusters.
///
/// Returns a ListClustersResult from DocDBElastic.
/// REST API Reference for ListClusters Operation
ListClustersResponse EndListClusters(IAsyncResult asyncResult);
#endregion
#region ListClusterSnapshots
///
/// Returns information about Elastic DocumentDB snapshots for a specified cluster.
///
/// Container for the necessary parameters to execute the ListClusterSnapshots service method.
///
/// The response from the ListClusterSnapshots service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an internal server error.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for ListClusterSnapshots Operation
ListClusterSnapshotsResponse ListClusterSnapshots(ListClusterSnapshotsRequest request);
///
/// Initiates the asynchronous execution of the ListClusterSnapshots operation.
///
///
/// Container for the necessary parameters to execute the ListClusterSnapshots operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClusterSnapshots
/// operation.
/// REST API Reference for ListClusterSnapshots Operation
IAsyncResult BeginListClusterSnapshots(ListClusterSnapshotsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListClusterSnapshots operation.
///
///
/// The IAsyncResult returned by the call to BeginListClusterSnapshots.
///
/// Returns a ListClusterSnapshotsResult from DocDBElastic.
/// REST API Reference for ListClusterSnapshots Operation
ListClusterSnapshotsResponse EndListClusterSnapshots(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Lists all tags on a Elastic DocumentDB resource
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by DocDBElastic.
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from DocDBElastic.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region RestoreClusterFromSnapshot
///
/// Restores a Elastic DocumentDB cluster from a snapshot.
///
/// Container for the necessary parameters to execute the RestoreClusterFromSnapshot service method.
///
/// The response from the RestoreClusterFromSnapshot service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an access conflict.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// The service quota for the action was exceeded.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for RestoreClusterFromSnapshot Operation
RestoreClusterFromSnapshotResponse RestoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest request);
///
/// Initiates the asynchronous execution of the RestoreClusterFromSnapshot operation.
///
///
/// Container for the necessary parameters to execute the RestoreClusterFromSnapshot operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreClusterFromSnapshot
/// operation.
/// REST API Reference for RestoreClusterFromSnapshot Operation
IAsyncResult BeginRestoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the RestoreClusterFromSnapshot operation.
///
///
/// The IAsyncResult returned by the call to BeginRestoreClusterFromSnapshot.
///
/// Returns a RestoreClusterFromSnapshotResult from DocDBElastic.
/// REST API Reference for RestoreClusterFromSnapshot Operation
RestoreClusterFromSnapshotResponse EndRestoreClusterFromSnapshot(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// Adds metadata tags to a Elastic DocumentDB resource
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by DocDBElastic.
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from DocDBElastic.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Removes metadata tags to a Elastic DocumentDB resource
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by DocDBElastic.
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from DocDBElastic.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
#region UpdateCluster
///
/// Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password,
/// upgrading API version setting up a backup window and maintenance window
///
/// Container for the necessary parameters to execute the UpdateCluster service method.
///
/// The response from the UpdateCluster service method, as returned by DocDBElastic.
///
/// An exception that occurs when there are not sufficient permissions to perform an action.
///
///
/// There was an access conflict.
///
///
/// There was an internal server error.
///
///
/// The specified resource could not be located.
///
///
/// ThrottlingException will be thrown when request was denied due to request throttling.
///
///
/// A structure defining a validation exception.
///
/// REST API Reference for UpdateCluster Operation
UpdateClusterResponse UpdateCluster(UpdateClusterRequest request);
///
/// Initiates the asynchronous execution of the UpdateCluster operation.
///
///
/// Container for the necessary parameters to execute the UpdateCluster operation on AmazonDocDBElasticClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateCluster
/// operation.
/// REST API Reference for UpdateCluster Operation
IAsyncResult BeginUpdateCluster(UpdateClusterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateCluster operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateCluster.
///
/// Returns a UpdateClusterResult from DocDBElastic.
/// REST API Reference for UpdateCluster Operation
UpdateClusterResponse EndUpdateCluster(IAsyncResult asyncResult);
#endregion
}
}