AmazonKeyManagementServiceClient.DisableKeyRotationAsync Method (string, CancellationToken) | AWS SDK for .NET V3 (original) (raw)

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z

Syntax

public virtual Task DisableKeyRotationAsync( String keyId, CancellationToken cancellationToken )

Parameters

keyId

Type: System.String

Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. Specify the key ID or key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

cancellationToken

Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

The response from the DisableKeyRotation service method, as returned by KeyManagementService.

Exceptions

Exception	Condition
DependencyTimeoutException	The system timed out while trying to fulfill the request. You can retry the request.
DisabledException	The request was rejected because the specified KMS key is not enabled.
InvalidArnException	The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInternalException	The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException	The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following: The key state of the KMS key is not compatible with the operation. To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide. For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
NotFoundException	The request was rejected because the specified entity or resource could not be found.
UnsupportedOperationException	The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0