/*
* 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 backupstorage-2018-04-10.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.BackupStorage.Model;
namespace Amazon.BackupStorage
{
///
/// Interface for accessing BackupStorage
///
/// The frontend service for Cryo Storage.
///
public partial interface IAmazonBackupStorage : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IBackupStoragePaginatorFactory Paginators { get; }
#endif
#region DeleteObject
///
/// Delete Object from the incremental base Backup.
///
/// Container for the necessary parameters to execute the DeleteObject service method.
///
/// The response from the DeleteObject service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Attempted to make an operation on non-existing or expired
/// resource.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for DeleteObject Operation
DeleteObjectResponse DeleteObject(DeleteObjectRequest request);
///
/// Initiates the asynchronous execution of the DeleteObject operation.
///
///
/// Container for the necessary parameters to execute the DeleteObject operation on AmazonBackupStorageClient.
/// 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 EndDeleteObject
/// operation.
/// REST API Reference for DeleteObject Operation
IAsyncResult BeginDeleteObject(DeleteObjectRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteObject operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteObject.
///
/// Returns a DeleteObjectResult from BackupStorage.
/// REST API Reference for DeleteObject Operation
DeleteObjectResponse EndDeleteObject(IAsyncResult asyncResult);
#endregion
#region GetChunk
///
/// Gets the specified object's chunk.
///
/// Container for the necessary parameters to execute the GetChunk service method.
///
/// The response from the GetChunk service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message
/// for details.
///
///
/// Non-retryable exception. Attempted to make an operation on non-existing or expired
/// resource.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for GetChunk Operation
GetChunkResponse GetChunk(GetChunkRequest request);
///
/// Initiates the asynchronous execution of the GetChunk operation.
///
///
/// Container for the necessary parameters to execute the GetChunk operation on AmazonBackupStorageClient.
/// 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 EndGetChunk
/// operation.
/// REST API Reference for GetChunk Operation
IAsyncResult BeginGetChunk(GetChunkRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetChunk operation.
///
///
/// The IAsyncResult returned by the call to BeginGetChunk.
///
/// Returns a GetChunkResult from BackupStorage.
/// REST API Reference for GetChunk Operation
GetChunkResponse EndGetChunk(IAsyncResult asyncResult);
#endregion
#region GetObjectMetadata
///
/// Get metadata associated with an Object.
///
/// Container for the necessary parameters to execute the GetObjectMetadata service method.
///
/// The response from the GetObjectMetadata service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message
/// for details.
///
///
/// Non-retryable exception. Attempted to make an operation on non-existing or expired
/// resource.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for GetObjectMetadata Operation
GetObjectMetadataResponse GetObjectMetadata(GetObjectMetadataRequest request);
///
/// Initiates the asynchronous execution of the GetObjectMetadata operation.
///
///
/// Container for the necessary parameters to execute the GetObjectMetadata operation on AmazonBackupStorageClient.
/// 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 EndGetObjectMetadata
/// operation.
/// REST API Reference for GetObjectMetadata Operation
IAsyncResult BeginGetObjectMetadata(GetObjectMetadataRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetObjectMetadata operation.
///
///
/// The IAsyncResult returned by the call to BeginGetObjectMetadata.
///
/// Returns a GetObjectMetadataResult from BackupStorage.
/// REST API Reference for GetObjectMetadata Operation
GetObjectMetadataResponse EndGetObjectMetadata(IAsyncResult asyncResult);
#endregion
#region ListChunks
///
/// List chunks in a given Object
///
/// Container for the necessary parameters to execute the ListChunks service method.
///
/// The response from the ListChunks service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Attempted to make an operation on non-existing or expired
/// resource.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
/// REST API Reference for ListChunks Operation
ListChunksResponse ListChunks(ListChunksRequest request);
///
/// Initiates the asynchronous execution of the ListChunks operation.
///
///
/// Container for the necessary parameters to execute the ListChunks operation on AmazonBackupStorageClient.
/// 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 EndListChunks
/// operation.
/// REST API Reference for ListChunks Operation
IAsyncResult BeginListChunks(ListChunksRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListChunks operation.
///
///
/// The IAsyncResult returned by the call to BeginListChunks.
///
/// Returns a ListChunksResult from BackupStorage.
/// REST API Reference for ListChunks Operation
ListChunksResponse EndListChunks(IAsyncResult asyncResult);
#endregion
#region ListObjects
///
/// List all Objects in a given Backup.
///
/// Container for the necessary parameters to execute the ListObjects service method.
///
/// The response from the ListObjects service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message
/// for details.
///
///
/// Non-retryable exception. Attempted to make an operation on non-existing or expired
/// resource.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for ListObjects Operation
ListObjectsResponse ListObjects(ListObjectsRequest request);
///
/// Initiates the asynchronous execution of the ListObjects operation.
///
///
/// Container for the necessary parameters to execute the ListObjects operation on AmazonBackupStorageClient.
/// 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 EndListObjects
/// operation.
/// REST API Reference for ListObjects Operation
IAsyncResult BeginListObjects(ListObjectsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListObjects operation.
///
///
/// The IAsyncResult returned by the call to BeginListObjects.
///
/// Returns a ListObjectsResult from BackupStorage.
/// REST API Reference for ListObjects Operation
ListObjectsResponse EndListObjects(IAsyncResult asyncResult);
#endregion
#region NotifyObjectComplete
///
/// Complete upload
///
/// Container for the necessary parameters to execute the NotifyObjectComplete service method.
///
/// The response from the NotifyObjectComplete service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message
/// for details.
///
///
/// Retryalble exception. Indicated issues while reading an input stream due to the networking
/// issues or connection drop on the client side.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for NotifyObjectComplete Operation
NotifyObjectCompleteResponse NotifyObjectComplete(NotifyObjectCompleteRequest request);
///
/// Initiates the asynchronous execution of the NotifyObjectComplete operation.
///
///
/// Container for the necessary parameters to execute the NotifyObjectComplete operation on AmazonBackupStorageClient.
/// 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 EndNotifyObjectComplete
/// operation.
/// REST API Reference for NotifyObjectComplete Operation
IAsyncResult BeginNotifyObjectComplete(NotifyObjectCompleteRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the NotifyObjectComplete operation.
///
///
/// The IAsyncResult returned by the call to BeginNotifyObjectComplete.
///
/// Returns a NotifyObjectCompleteResult from BackupStorage.
/// REST API Reference for NotifyObjectComplete Operation
NotifyObjectCompleteResponse EndNotifyObjectComplete(IAsyncResult asyncResult);
#endregion
#region PutChunk
///
/// Upload chunk.
///
/// Container for the necessary parameters to execute the PutChunk service method.
///
/// The response from the PutChunk service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message
/// for details.
///
///
/// Retryalble exception. Indicated issues while reading an input stream due to the networking
/// issues or connection drop on the client side.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for PutChunk Operation
PutChunkResponse PutChunk(PutChunkRequest request);
///
/// Initiates the asynchronous execution of the PutChunk operation.
///
///
/// Container for the necessary parameters to execute the PutChunk operation on AmazonBackupStorageClient.
/// 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 EndPutChunk
/// operation.
/// REST API Reference for PutChunk Operation
IAsyncResult BeginPutChunk(PutChunkRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the PutChunk operation.
///
///
/// The IAsyncResult returned by the call to BeginPutChunk.
///
/// Returns a PutChunkResult from BackupStorage.
/// REST API Reference for PutChunk Operation
PutChunkResponse EndPutChunk(IAsyncResult asyncResult);
#endregion
#region PutObject
///
/// Upload object that can store object metadata String and data blob in single API call
/// using inline chunk field.
///
/// Container for the necessary parameters to execute the PutObject service method.
///
/// The response from the PutObject service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message
/// for details.
///
///
/// Retryalble exception. Indicated issues while reading an input stream due to the networking
/// issues or connection drop on the client side.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for PutObject Operation
PutObjectResponse PutObject(PutObjectRequest request);
///
/// Initiates the asynchronous execution of the PutObject operation.
///
///
/// Container for the necessary parameters to execute the PutObject operation on AmazonBackupStorageClient.
/// 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 EndPutObject
/// operation.
/// REST API Reference for PutObject Operation
IAsyncResult BeginPutObject(PutObjectRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the PutObject operation.
///
///
/// The IAsyncResult returned by the call to BeginPutObject.
///
/// Returns a PutObjectResult from BackupStorage.
/// REST API Reference for PutObject Operation
PutObjectResponse EndPutObject(IAsyncResult asyncResult);
#endregion
#region StartObject
///
/// Start upload containing one or many chunks.
///
/// Container for the necessary parameters to execute the StartObject service method.
///
/// The response from the StartObject service method, as returned by BackupStorage.
///
///
///
///
/// Non-retryable exception. Attempted to create already existing object or chunk. This
/// message contains a checksum of already presented data.
///
///
/// Non-retryable exception, indicates client error (wrong argument passed to API). See
/// exception message for details.
///
///
/// Non-retryable exception. Attempted to make an operation on non-existing or expired
/// resource.
///
///
/// Retryable exception. In general indicates internal failure that can be fixed by retry.
///
///
/// Deprecated. To be removed from the model.
///
///
/// Retryable exception, indicates internal server error.
///
///
/// Increased rate over throttling limits. Can be retried with exponential backoff.
///
/// REST API Reference for StartObject Operation
StartObjectResponse StartObject(StartObjectRequest request);
///
/// Initiates the asynchronous execution of the StartObject operation.
///
///
/// Container for the necessary parameters to execute the StartObject operation on AmazonBackupStorageClient.
/// 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 EndStartObject
/// operation.
/// REST API Reference for StartObject Operation
IAsyncResult BeginStartObject(StartObjectRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartObject operation.
///
///
/// The IAsyncResult returned by the call to BeginStartObject.
///
/// Returns a StartObjectResult from BackupStorage.
/// REST API Reference for StartObject Operation
StartObjectResponse EndStartObject(IAsyncResult asyncResult);
#endregion
}
}