/*
* 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.Threading;
using System.Threading.Tasks;
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 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteObjectAsync(DeleteObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetChunk
///
/// Gets the specified object's chunk.
///
/// Container for the necessary parameters to execute the GetChunk service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetChunkAsync(GetChunkRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetObjectMetadata
///
/// Get metadata associated with an Object.
///
/// Container for the necessary parameters to execute the GetObjectMetadata service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetObjectMetadataAsync(GetObjectMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListChunks
///
/// List chunks in a given Object
///
/// Container for the necessary parameters to execute the ListChunks service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListChunksAsync(ListChunksRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListObjects
///
/// List all Objects in a given Backup.
///
/// Container for the necessary parameters to execute the ListObjects service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListObjectsAsync(ListObjectsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region NotifyObjectComplete
///
/// Complete upload
///
/// Container for the necessary parameters to execute the NotifyObjectComplete service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task NotifyObjectCompleteAsync(NotifyObjectCompleteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutChunk
///
/// Upload chunk.
///
/// Container for the necessary parameters to execute the PutChunk service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task PutChunkAsync(PutChunkRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task PutObjectAsync(PutObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartObject
///
/// Start upload containing one or many chunks.
///
/// Container for the necessary parameters to execute the StartObject service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task StartObjectAsync(StartObjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}