/*
* 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 rbin-2021-06-15.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.RecycleBin.Model;
namespace Amazon.RecycleBin
{
///
/// Interface for accessing RecycleBin
///
/// This is the Recycle Bin API Reference. This documentation provides descriptions
/// and syntax for each of the actions and data types in Recycle Bin.
///
///
///
/// Recycle Bin is a resource recovery feature that enables you to restore accidentally
/// deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
/// deleted, they are retained in the Recycle Bin for a time period that you specify.
///
///
///
/// You can restore a resource from the Recycle Bin at any time before its retention period
/// expires. After you restore a resource from the Recycle Bin, the resource is removed
/// from the Recycle Bin, and you can then use it in the same way you use any other resource
/// of that type in your account. If the retention period expires and the resource is
/// not restored, the resource is permanently deleted from the Recycle Bin and is no longer
/// available for recovery. For more information about Recycle Bin, see
/// Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
///
///
public partial interface IAmazonRecycleBin : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IRecycleBinPaginatorFactory Paginators { get; }
#endif
#region CreateRule
///
/// Creates a Recycle Bin retention rule. For more information, see
/// Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User
/// Guide.
///
/// Container for the necessary parameters to execute the CreateRule service method.
///
/// The response from the CreateRule service method, as returned by RecycleBin.
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The request would cause a service quota for the number of tags per resource to be
/// exceeded.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for CreateRule Operation
CreateRuleResponse CreateRule(CreateRuleRequest request);
///
/// Initiates the asynchronous execution of the CreateRule operation.
///
///
/// Container for the necessary parameters to execute the CreateRule operation on AmazonRecycleBinClient.
/// 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 EndCreateRule
/// operation.
/// REST API Reference for CreateRule Operation
IAsyncResult BeginCreateRule(CreateRuleRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateRule operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateRule.
///
/// Returns a CreateRuleResult from RecycleBin.
/// REST API Reference for CreateRule Operation
CreateRuleResponse EndCreateRule(IAsyncResult asyncResult);
#endregion
#region DeleteRule
///
/// Deletes a Recycle Bin retention rule. For more information, see
/// Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User
/// Guide.
///
/// Container for the necessary parameters to execute the DeleteRule service method.
///
/// The response from the DeleteRule service method, as returned by RecycleBin.
///
/// The specified retention rule lock request can't be completed.
///
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for DeleteRule Operation
DeleteRuleResponse DeleteRule(DeleteRuleRequest request);
///
/// Initiates the asynchronous execution of the DeleteRule operation.
///
///
/// Container for the necessary parameters to execute the DeleteRule operation on AmazonRecycleBinClient.
/// 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 EndDeleteRule
/// operation.
/// REST API Reference for DeleteRule Operation
IAsyncResult BeginDeleteRule(DeleteRuleRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteRule operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteRule.
///
/// Returns a DeleteRuleResult from RecycleBin.
/// REST API Reference for DeleteRule Operation
DeleteRuleResponse EndDeleteRule(IAsyncResult asyncResult);
#endregion
#region GetRule
///
/// Gets information about a Recycle Bin retention rule.
///
/// Container for the necessary parameters to execute the GetRule service method.
///
/// The response from the GetRule service method, as returned by RecycleBin.
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for GetRule Operation
GetRuleResponse GetRule(GetRuleRequest request);
///
/// Initiates the asynchronous execution of the GetRule operation.
///
///
/// Container for the necessary parameters to execute the GetRule operation on AmazonRecycleBinClient.
/// 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 EndGetRule
/// operation.
/// REST API Reference for GetRule Operation
IAsyncResult BeginGetRule(GetRuleRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetRule operation.
///
///
/// The IAsyncResult returned by the call to BeginGetRule.
///
/// Returns a GetRuleResult from RecycleBin.
/// REST API Reference for GetRule Operation
GetRuleResponse EndGetRule(IAsyncResult asyncResult);
#endregion
#region ListRules
///
/// Lists the Recycle Bin retention rules in the Region.
///
/// Container for the necessary parameters to execute the ListRules service method.
///
/// The response from the ListRules service method, as returned by RecycleBin.
///
/// The service could not respond to the request due to an internal problem.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for ListRules Operation
ListRulesResponse ListRules(ListRulesRequest request);
///
/// Initiates the asynchronous execution of the ListRules operation.
///
///
/// Container for the necessary parameters to execute the ListRules operation on AmazonRecycleBinClient.
/// 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 EndListRules
/// operation.
/// REST API Reference for ListRules Operation
IAsyncResult BeginListRules(ListRulesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListRules operation.
///
///
/// The IAsyncResult returned by the call to BeginListRules.
///
/// Returns a ListRulesResult from RecycleBin.
/// REST API Reference for ListRules Operation
ListRulesResponse EndListRules(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Lists the tags assigned to a retention rule.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by RecycleBin.
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// 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 AmazonRecycleBinClient.
/// 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 RecycleBin.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region LockRule
///
/// Locks a retention rule. A locked retention rule can't be modified or deleted.
///
/// Container for the necessary parameters to execute the LockRule service method.
///
/// The response from the LockRule service method, as returned by RecycleBin.
///
/// The specified retention rule lock request can't be completed.
///
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for LockRule Operation
LockRuleResponse LockRule(LockRuleRequest request);
///
/// Initiates the asynchronous execution of the LockRule operation.
///
///
/// Container for the necessary parameters to execute the LockRule operation on AmazonRecycleBinClient.
/// 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 EndLockRule
/// operation.
/// REST API Reference for LockRule Operation
IAsyncResult BeginLockRule(LockRuleRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the LockRule operation.
///
///
/// The IAsyncResult returned by the call to BeginLockRule.
///
/// Returns a LockRuleResult from RecycleBin.
/// REST API Reference for LockRule Operation
LockRuleResponse EndLockRule(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// Assigns tags to the specified retention rule.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by RecycleBin.
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// The request would cause a service quota for the number of tags per resource to be
/// exceeded.
///
///
/// One or more of the parameters in the request is not valid.
///
/// 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 AmazonRecycleBinClient.
/// 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 RecycleBin.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UnlockRule
///
/// Unlocks a retention rule. After a retention rule is unlocked, it can be modified or
/// deleted only after the unlock delay period expires.
///
/// Container for the necessary parameters to execute the UnlockRule service method.
///
/// The response from the UnlockRule service method, as returned by RecycleBin.
///
/// The specified retention rule lock request can't be completed.
///
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for UnlockRule Operation
UnlockRuleResponse UnlockRule(UnlockRuleRequest request);
///
/// Initiates the asynchronous execution of the UnlockRule operation.
///
///
/// Container for the necessary parameters to execute the UnlockRule operation on AmazonRecycleBinClient.
/// 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 EndUnlockRule
/// operation.
/// REST API Reference for UnlockRule Operation
IAsyncResult BeginUnlockRule(UnlockRuleRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UnlockRule operation.
///
///
/// The IAsyncResult returned by the call to BeginUnlockRule.
///
/// Returns a UnlockRuleResult from RecycleBin.
/// REST API Reference for UnlockRule Operation
UnlockRuleResponse EndUnlockRule(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Unassigns a tag from a retention rule.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by RecycleBin.
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// 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 AmazonRecycleBinClient.
/// 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 RecycleBin.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
#region UpdateRule
///
/// Updates an existing Recycle Bin retention rule. You can update a retention rule's
/// description, resource tags, and retention period at any time after creation. You can't
/// update a retention rule's resource type after creation. For more information, see
///
/// Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User
/// Guide.
///
/// Container for the necessary parameters to execute the UpdateRule service method.
///
/// The response from the UpdateRule service method, as returned by RecycleBin.
///
/// The specified retention rule lock request can't be completed.
///
///
/// The service could not respond to the request due to an internal problem.
///
///
/// The specified resource was not found.
///
///
/// One or more of the parameters in the request is not valid.
///
/// REST API Reference for UpdateRule Operation
UpdateRuleResponse UpdateRule(UpdateRuleRequest request);
///
/// Initiates the asynchronous execution of the UpdateRule operation.
///
///
/// Container for the necessary parameters to execute the UpdateRule operation on AmazonRecycleBinClient.
/// 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 EndUpdateRule
/// operation.
/// REST API Reference for UpdateRule Operation
IAsyncResult BeginUpdateRule(UpdateRuleRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateRule operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateRule.
///
/// Returns a UpdateRuleResult from RecycleBin.
/// REST API Reference for UpdateRule Operation
UpdateRuleResponse EndUpdateRule(IAsyncResult asyncResult);
#endregion
}
}