/*
* 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 cloudhsmv2-2017-04-28.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.CloudHSMV2.Model;
namespace Amazon.CloudHSMV2
{
///
/// Interface for accessing CloudHSMV2
///
/// For more information about AWS CloudHSM, see AWS
/// CloudHSM and the AWS
/// CloudHSM User Guide.
///
public partial interface IAmazonCloudHSMV2 : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ICloudHSMV2PaginatorFactory Paginators { get; }
#endif
#region CopyBackupToRegion
///
/// Copy an AWS CloudHSM cluster backup to a different region.
///
/// Container for the necessary parameters to execute the CopyBackupToRegion service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyBackupToRegion service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for CopyBackupToRegion Operation
Task CopyBackupToRegionAsync(CopyBackupToRegionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateCluster
///
/// Creates a new AWS CloudHSM cluster.
///
/// Container for the necessary parameters to execute the CreateCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateCluster service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for CreateCluster Operation
Task CreateClusterAsync(CreateClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateHsm
///
/// Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
///
/// Container for the necessary parameters to execute the CreateHsm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateHsm service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for CreateHsm Operation
Task CreateHsmAsync(CreateHsmRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteBackup
///
/// Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after
/// the DeleteBackup request is made. For more information on restoring a backup, see
/// RestoreBackup.
///
/// Container for the necessary parameters to execute the DeleteBackup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteBackup service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for DeleteBackup Operation
Task DeleteBackupAsync(DeleteBackupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteCluster
///
/// Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must
/// delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters.
/// To delete an HSM, use DeleteHsm.
///
/// Container for the necessary parameters to execute the DeleteCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteCluster service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for DeleteCluster Operation
Task DeleteClusterAsync(DeleteClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteHsm
///
/// Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the
/// IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI.
/// You need to specify only one of these values. To find these values, use DescribeClusters.
///
/// Container for the necessary parameters to execute the DeleteHsm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteHsm service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for DeleteHsm Operation
Task DeleteHsmAsync(DeleteHsmRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeBackups
///
/// Gets information about backups of AWS CloudHSM clusters.
///
///
///
/// This is a paginated operation, which means that each response might contain only a
/// subset of all the backups. When the response contains only a subset of backups, it
/// includes a NextToken value. Use this value in a subsequent DescribeBackups
/// request to get more backups. When you receive a response with no NextToken
/// (or an empty or null value), that means there are no more backups to get.
///
///
/// Container for the necessary parameters to execute the DescribeBackups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeBackups service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for DescribeBackups Operation
Task DescribeBackupsAsync(DescribeBackupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeClusters
///
/// Gets information about AWS CloudHSM clusters.
///
///
///
/// This is a paginated operation, which means that each response might contain only a
/// subset of all the clusters. When the response contains only a subset of clusters,
/// it includes a NextToken value. Use this value in a subsequent DescribeClusters
/// request to get more clusters. When you receive a response with no NextToken
/// (or an empty or null value), that means there are no more clusters to get.
///
///
/// Container for the necessary parameters to execute the DescribeClusters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeClusters service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for DescribeClusters Operation
Task DescribeClustersAsync(DescribeClustersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region InitializeCluster
///
/// Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your
/// issuing certificate authority (CA) and the CA's root certificate. Before you can claim
/// a cluster, you must sign the cluster's certificate signing request (CSR) with your
/// issuing CA. To get the cluster's CSR, use DescribeClusters.
///
/// Container for the necessary parameters to execute the InitializeCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the InitializeCluster service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for InitializeCluster Operation
Task InitializeClusterAsync(InitializeClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTags
///
/// Gets a list of tags for the specified AWS CloudHSM cluster.
///
///
///
/// This is a paginated operation, which means that each response might contain only a
/// subset of all the tags. When the response contains only a subset of tags, it includes
/// a NextToken value. Use this value in a subsequent ListTags
/// request to get more tags. When you receive a response with no NextToken
/// (or an empty or null value), that means there are no more tags to get.
///
///
/// Container for the necessary parameters to execute the ListTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTags service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for ListTags Operation
Task ListTagsAsync(ListTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyBackupAttributes
///
/// Modifies attributes for AWS CloudHSM backup.
///
/// Container for the necessary parameters to execute the ModifyBackupAttributes service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyBackupAttributes service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for ModifyBackupAttributes Operation
Task ModifyBackupAttributesAsync(ModifyBackupAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ModifyCluster
///
/// Modifies AWS CloudHSM cluster.
///
/// Container for the necessary parameters to execute the ModifyCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyCluster service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for ModifyCluster Operation
Task ModifyClusterAsync(ModifyClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RestoreBackup
///
/// Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION
/// state. For mor information on deleting a backup, see DeleteBackup.
///
/// Container for the necessary parameters to execute the RestoreBackup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RestoreBackup service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
/// REST API Reference for RestoreBackup Operation
Task RestoreBackupAsync(RestoreBackupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes the specified tag or tags from the specified AWS CloudHSM cluster.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by CloudHSMV2.
///
/// The request was rejected because the requester does not have permission to perform
/// the requested operation.
///
///
/// The request was rejected because of an AWS CloudHSM internal failure. The request
/// can be retried.
///
///
/// The request was rejected because it is not a valid request.
///
///
/// The request was rejected because it refers to a resource that cannot be found.
///
///
/// The request was rejected because an error occurred.
///
///
/// The request was rejected because of a tagging failure. Verify the tag conditions in
/// all applicable policies, and then retry the request.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}