C# Class Amazon.KeyManagementService.AmazonKeyManagementServiceClient

Implementation for accessing KeyManagementService AWS Key Management Service

AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.

All AWS KMS operations require Signature Version 4.

Logging API Requests

AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Additional Resources

For more information about credentials and request signing, see the following:

AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.

Commonly Used APIs

Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.

Encrypt
Decrypt
GenerateDataKey
GenerateDataKeyWithoutPlaintext

Inheritance: AmazonServiceClient, IAmazonKeyManagementService

Datei anzeigen Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method	Description
AmazonKeyManagementServiceClient ( ) : System	Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonKeyManagementServiceClient ( AWSCredentials credentials ) : System	Constructs AmazonKeyManagementServiceClient with AWS Credentials
AmazonKeyManagementServiceClient ( AWSCredentials credentials, AmazonKeyManagementServiceConfig clientConfig ) : System	Constructs AmazonKeyManagementServiceClient with AWS Credentials and an AmazonKeyManagementServiceClient Configuration object.
AmazonKeyManagementServiceClient ( AWSCredentials credentials, RegionEndpoint region ) : System	Constructs AmazonKeyManagementServiceClient with AWS Credentials
AmazonKeyManagementServiceClient ( AmazonKeyManagementServiceConfig config ) : System	Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonKeyManagementServiceClient ( RegionEndpoint region ) : System	Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System	Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key
AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonKeyManagementServiceConfig clientConfig ) : System	Constructs AmazonKeyManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonKeyManagementServiceClient Configuration object.
AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System	Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key
AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System	Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key
AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonKeyManagementServiceConfig clientConfig ) : System	Constructs AmazonKeyManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonKeyManagementServiceClient Configuration object.
AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System	Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key
BeginCancelKeyDeletion ( CancelKeyDeletionRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the CancelKeyDeletion operation.
BeginCreateAlias ( CreateAliasRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the CreateAlias operation.
BeginCreateGrant ( CreateGrantRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the CreateGrant operation.
BeginCreateKey ( CreateKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the CreateKey operation.
BeginDecrypt ( DecryptRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the Decrypt operation.
BeginDeleteAlias ( Amazon.KeyManagementService.Model.DeleteAliasRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DeleteAlias operation.
BeginDeleteImportedKeyMaterial ( DeleteImportedKeyMaterialRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DeleteImportedKeyMaterial operation.
BeginDescribeKey ( DescribeKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DescribeKey operation.
BeginDisableKey ( DisableKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DisableKey operation.
BeginDisableKeyRotation ( Amazon.KeyManagementService.Model.DisableKeyRotationRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the DisableKeyRotation operation.
BeginEnableKey ( EnableKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the EnableKey operation.
BeginEnableKeyRotation ( EnableKeyRotationRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the EnableKeyRotation operation.
BeginEncrypt ( EncryptRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the Encrypt operation.
BeginGenerateDataKey ( GenerateDataKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the GenerateDataKey operation.
BeginGenerateDataKeyWithoutPlaintext ( GenerateDataKeyWithoutPlaintextRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation.
BeginGenerateRandom ( GenerateRandomRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the GenerateRandom operation.
BeginGetKeyPolicy ( GetKeyPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the GetKeyPolicy operation.
BeginGetKeyRotationStatus ( GetKeyRotationStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the GetKeyRotationStatus operation.
BeginGetParametersForImport ( GetParametersForImportRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the GetParametersForImport operation.
BeginImportKeyMaterial ( ImportKeyMaterialRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ImportKeyMaterial operation.
BeginListAliases ( ListAliasesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListAliases operation.
BeginListGrants ( ListGrantsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListGrants operation.
BeginListKeyPolicies ( ListKeyPoliciesRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListKeyPolicies operation.
BeginListKeys ( ListKeysRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListKeys operation.
BeginListRetirableGrants ( ListRetirableGrantsRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ListRetirableGrants operation.
BeginPutKeyPolicy ( PutKeyPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the PutKeyPolicy operation.
BeginReEncrypt ( ReEncryptRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ReEncrypt operation.
BeginRetireGrant ( RetireGrantRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the RetireGrant operation.
BeginRevokeGrant ( RevokeGrantRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the RevokeGrant operation.
BeginScheduleKeyDeletion ( ScheduleKeyDeletionRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the ScheduleKeyDeletion operation.
BeginUpdateAlias ( UpdateAliasRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the UpdateAlias operation.
BeginUpdateKeyDescription ( UpdateKeyDescriptionRequest request, AsyncCallback callback, object state ) : IAsyncResult	Initiates the asynchronous execution of the UpdateKeyDescription operation.
CancelKeyDeletion ( CancelKeyDeletionRequest request ) : CancelKeyDeletionResponse	Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the `Disabled` state. To enable a CMK, use EnableKey. For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
CancelKeyDeletion ( string keyId ) : CancelKeyDeletionResponse	Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the `Disabled` state. To enable a CMK, use EnableKey. For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
CancelKeyDeletionAsync ( CancelKeyDeletionRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the CancelKeyDeletion operation.
CancelKeyDeletionAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the `Disabled` state. To enable a CMK, use EnableKey. For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
CreateAlias ( CreateAliasRequest request ) : CreateAliasResponse	Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). The alias and the key it is mapped to must be in the same AWS account and the same region. To map an alias to a different key, call UpdateAlias.
CreateAlias ( string aliasName, string targetKeyId ) : CreateAliasResponse	Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). The alias and the key it is mapped to must be in the same AWS account and the same region. To map an alias to a different key, call UpdateAlias.
CreateAliasAsync ( CreateAliasRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the CreateAlias operation.
CreateAliasAsync ( string aliasName, string targetKeyId, System cancellationToken = default(CancellationToken) ) : Task	Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). The alias and the key it is mapped to must be in the same AWS account and the same region. To map an alias to a different key, call UpdateAlias.
CreateGrant ( CreateGrantRequest request ) : CreateGrantResponse	Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
CreateGrantAsync ( CreateGrantRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the CreateGrant operation.
CreateKey ( CreateKeyRequest request ) : CreateKeyResponse	Creates a customer master key (CMK). You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following: The GenerateDataKey operation AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
CreateKeyAsync ( CreateKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the CreateKey operation.
Decrypt ( DecryptRequest request ) : DecryptResponse	Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions: GenerateDataKey GenerateDataKeyWithoutPlaintext Encrypt Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant `Decrypt` permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant `Decrypt` access in an IAM user policy. Instead grant `Decrypt` access only in key policies. If you must grant `Decrypt` access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
DecryptAsync ( DecryptRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the Decrypt operation.
DeleteAlias ( Amazon.KeyManagementService.Model.DeleteAliasRequest request ) : DeleteAliasResponse	Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
DeleteAlias ( string aliasName ) : DeleteAliasResponse	Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
DeleteAliasAsync ( Amazon.KeyManagementService.Model.DeleteAliasRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DeleteAlias operation.
DeleteAliasAsync ( string aliasName, System cancellationToken = default(CancellationToken) ) : Task	Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
DeleteImportedKeyMaterial ( DeleteImportedKeyMaterialRequest request ) : DeleteImportedKeyMaterialResponse	Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. When the specified CMK is in the `PendingDeletion` state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to `PendingImport`. After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
DeleteImportedKeyMaterialAsync ( DeleteImportedKeyMaterialRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DeleteImportedKeyMaterial operation.
DescribeKey ( DescribeKeyRequest request ) : DescribeKeyResponse	Provides detailed information about the specified customer master key.
DescribeKey ( string keyId ) : DescribeKeyResponse	Provides detailed information about the specified customer master key.
DescribeKeyAsync ( DescribeKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DescribeKey operation.
DescribeKeyAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Provides detailed information about the specified customer master key.
DisableKey ( DisableKeyRequest request ) : DisableKeyResponse	Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
DisableKey ( string keyId ) : DisableKeyResponse	Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
DisableKeyAsync ( DisableKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DisableKey operation.
DisableKeyAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
DisableKeyRotation ( Amazon.KeyManagementService.Model.DisableKeyRotationRequest request ) : DisableKeyRotationResponse	Disables rotation of the specified key.
DisableKeyRotation ( string keyId ) : DisableKeyRotationResponse	Disables rotation of the specified key.
DisableKeyRotationAsync ( Amazon.KeyManagementService.Model.DisableKeyRotationRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the DisableKeyRotation operation.
DisableKeyRotationAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Disables rotation of the specified key.
EnableKey ( EnableKeyRequest request ) : EnableKeyResponse	Marks a key as enabled, thereby permitting its use.
EnableKey ( string keyId ) : EnableKeyResponse	Marks a key as enabled, thereby permitting its use.
EnableKeyAsync ( EnableKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the EnableKey operation.
EnableKeyAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Marks a key as enabled, thereby permitting its use.
EnableKeyRotation ( EnableKeyRotationRequest request ) : EnableKeyRotationResponse	Enables rotation of the specified customer master key.
EnableKeyRotation ( string keyId ) : EnableKeyRotationResponse	Enables rotation of the specified customer master key.
EnableKeyRotationAsync ( EnableKeyRotationRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the EnableKeyRotation operation.
EnableKeyRotationAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Enables rotation of the specified customer master key.
Encrypt ( EncryptRequest request ) : EncryptResponse	Encrypts plaintext into ciphertext by using a customer master key. The `Encrypt` function has two primary use cases: You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information. If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data. Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling `Encrypt`. If you want to encrypt data locally in your application, you can use the `GenerateDataKey` function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.
EncryptAsync ( EncryptRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the Encrypt operation.
EndCancelKeyDeletion ( IAsyncResult asyncResult ) : CancelKeyDeletionResponse	Finishes the asynchronous execution of the CancelKeyDeletion operation.
EndCreateAlias ( IAsyncResult asyncResult ) : CreateAliasResponse	Finishes the asynchronous execution of the CreateAlias operation.
EndCreateGrant ( IAsyncResult asyncResult ) : CreateGrantResponse	Finishes the asynchronous execution of the CreateGrant operation.
EndCreateKey ( IAsyncResult asyncResult ) : CreateKeyResponse	Finishes the asynchronous execution of the CreateKey operation.
EndDecrypt ( IAsyncResult asyncResult ) : DecryptResponse	Finishes the asynchronous execution of the Decrypt operation.
EndDeleteAlias ( IAsyncResult asyncResult ) : DeleteAliasResponse	Finishes the asynchronous execution of the DeleteAlias operation.
EndDeleteImportedKeyMaterial ( IAsyncResult asyncResult ) : DeleteImportedKeyMaterialResponse	Finishes the asynchronous execution of the DeleteImportedKeyMaterial operation.
EndDescribeKey ( IAsyncResult asyncResult ) : DescribeKeyResponse	Finishes the asynchronous execution of the DescribeKey operation.
EndDisableKey ( IAsyncResult asyncResult ) : DisableKeyResponse	Finishes the asynchronous execution of the DisableKey operation.
EndDisableKeyRotation ( IAsyncResult asyncResult ) : DisableKeyRotationResponse	Finishes the asynchronous execution of the DisableKeyRotation operation.
EndEnableKey ( IAsyncResult asyncResult ) : EnableKeyResponse	Finishes the asynchronous execution of the EnableKey operation.
EndEnableKeyRotation ( IAsyncResult asyncResult ) : EnableKeyRotationResponse	Finishes the asynchronous execution of the EnableKeyRotation operation.
EndEncrypt ( IAsyncResult asyncResult ) : EncryptResponse	Finishes the asynchronous execution of the Encrypt operation.
EndGenerateDataKey ( IAsyncResult asyncResult ) : GenerateDataKeyResponse	Finishes the asynchronous execution of the GenerateDataKey operation.
EndGenerateDataKeyWithoutPlaintext ( IAsyncResult asyncResult ) : GenerateDataKeyWithoutPlaintextResponse	Finishes the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation.
EndGenerateRandom ( IAsyncResult asyncResult ) : GenerateRandomResponse	Finishes the asynchronous execution of the GenerateRandom operation.
EndGetKeyPolicy ( IAsyncResult asyncResult ) : GetKeyPolicyResponse	Finishes the asynchronous execution of the GetKeyPolicy operation.
EndGetKeyRotationStatus ( IAsyncResult asyncResult ) : GetKeyRotationStatusResponse	Finishes the asynchronous execution of the GetKeyRotationStatus operation.
EndGetParametersForImport ( IAsyncResult asyncResult ) : GetParametersForImportResponse	Finishes the asynchronous execution of the GetParametersForImport operation.
EndImportKeyMaterial ( IAsyncResult asyncResult ) : ImportKeyMaterialResponse	Finishes the asynchronous execution of the ImportKeyMaterial operation.
EndListAliases ( IAsyncResult asyncResult ) : ListAliasesResponse	Finishes the asynchronous execution of the ListAliases operation.
EndListGrants ( IAsyncResult asyncResult ) : ListGrantsResponse	Finishes the asynchronous execution of the ListGrants operation.
EndListKeyPolicies ( IAsyncResult asyncResult ) : ListKeyPoliciesResponse	Finishes the asynchronous execution of the ListKeyPolicies operation.
EndListKeys ( IAsyncResult asyncResult ) : ListKeysResponse	Finishes the asynchronous execution of the ListKeys operation.
EndListRetirableGrants ( IAsyncResult asyncResult ) : ListRetirableGrantsResponse	Finishes the asynchronous execution of the ListRetirableGrants operation.
EndPutKeyPolicy ( IAsyncResult asyncResult ) : PutKeyPolicyResponse	Finishes the asynchronous execution of the PutKeyPolicy operation.
EndReEncrypt ( IAsyncResult asyncResult ) : ReEncryptResponse	Finishes the asynchronous execution of the ReEncrypt operation.
EndRetireGrant ( IAsyncResult asyncResult ) : RetireGrantResponse	Finishes the asynchronous execution of the RetireGrant operation.
EndRevokeGrant ( IAsyncResult asyncResult ) : RevokeGrantResponse	Finishes the asynchronous execution of the RevokeGrant operation.
EndScheduleKeyDeletion ( IAsyncResult asyncResult ) : ScheduleKeyDeletionResponse	Finishes the asynchronous execution of the ScheduleKeyDeletion operation.
EndUpdateAlias ( IAsyncResult asyncResult ) : UpdateAliasResponse	Finishes the asynchronous execution of the UpdateAlias operation.
EndUpdateKeyDescription ( IAsyncResult asyncResult ) : UpdateKeyDescriptionResponse	Finishes the asynchronous execution of the UpdateKeyDescription operation.
GenerateDataKey ( GenerateDataKeyRequest request ) : GenerateDataKeyResponse	Returns a data encryption key that you can use in your application to encrypt data locally. You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the `KeySpec` or `NumberOfBytes` field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use `KeySpec`. This operation returns a plaintext copy of the data key in the `Plaintext` field of the response, and an encrypted copy of the data key in the `CiphertextBlob` field. The data key is encrypted under the CMK specified in the `KeyId` field of the request. We recommend that you use the following pattern to encrypt data locally in your application: Use this operation (`GenerateDataKey`) to retrieve a data encryption key. Use the plaintext data encryption key (returned in the `Plaintext` field of the response) to encrypt data locally, then erase the plaintext data key from memory. Store the encrypted data key (returned in the `CiphertextBlob` field of the response) alongside the locally encrypted data. To decrypt data locally: Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory. To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom. If you use the optional `EncryptionContext` field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
GenerateDataKeyAsync ( GenerateDataKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the GenerateDataKey operation.
GenerateDataKeyWithoutPlaintext ( GenerateDataKeyWithoutPlaintextRequest request ) : GenerateDataKeyWithoutPlaintextResponse	Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key. This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (`GenerateDataKeyWithoutPlaintext`) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
GenerateDataKeyWithoutPlaintextAsync ( GenerateDataKeyWithoutPlaintextRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation.
GenerateRandom ( GenerateRandomRequest request ) : GenerateRandomResponse	Generates an unpredictable byte string.
GenerateRandom ( int numberOfBytes ) : GenerateRandomResponse	Generates an unpredictable byte string.
GenerateRandomAsync ( GenerateRandomRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the GenerateRandom operation.
GenerateRandomAsync ( int numberOfBytes, System cancellationToken = default(CancellationToken) ) : Task	Generates an unpredictable byte string.
GetKeyPolicy ( GetKeyPolicyRequest request ) : GetKeyPolicyResponse	Retrieves a policy attached to the specified key.
GetKeyPolicy ( string keyId, string policyName ) : GetKeyPolicyResponse	Retrieves a policy attached to the specified key.
GetKeyPolicyAsync ( GetKeyPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the GetKeyPolicy operation.
GetKeyPolicyAsync ( string keyId, string policyName, System cancellationToken = default(CancellationToken) ) : Task	Retrieves a policy attached to the specified key.
GetKeyRotationStatus ( GetKeyRotationStatusRequest request ) : GetKeyRotationStatusResponse	Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
GetKeyRotationStatus ( string keyId ) : GetKeyRotationStatusResponse	Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
GetKeyRotationStatusAsync ( GetKeyRotationStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the GetKeyRotationStatus operation.
GetKeyRotationStatusAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
GetParametersForImport ( GetParametersForImportRequest request ) : GetParametersForImportResponse	Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's `Origin` must be `EXTERNAL`. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another `GetParametersForImport` request.
GetParametersForImportAsync ( GetParametersForImportRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the GetParametersForImport operation.
ImportKeyMaterial ( ImportKeyMaterialRequest request ) : ImportKeyMaterialResponse	Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You must specify the key ID of the CMK to import the key material into. This CMK's `Origin` must be `EXTERNAL`. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. When this operation is successful, the specified CMK's key state changes to `Enabled`, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
ImportKeyMaterialAsync ( ImportKeyMaterialRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ImportKeyMaterial operation.
ListAliases ( ListAliasesRequest request ) : ListAliasesResponse	Lists all of the key aliases in the account.
ListAliasesAsync ( ListAliasesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListAliases operation.
ListGrants ( ListGrantsRequest request ) : ListGrantsResponse	List the grants for a specified key.
ListGrantsAsync ( ListGrantsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListGrants operation.
ListKeyPolicies ( ListKeyPoliciesRequest request ) : ListKeyPoliciesResponse	Retrieves a list of policies attached to a key.
ListKeyPoliciesAsync ( ListKeyPoliciesRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListKeyPolicies operation.
ListKeys ( ListKeysRequest request ) : ListKeysResponse	Lists the customer master keys.
ListKeysAsync ( ListKeysRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListKeys operation.
ListRetirableGrants ( ) : ListRetirableGrantsResponse	Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
ListRetirableGrants ( ListRetirableGrantsRequest request ) : ListRetirableGrantsResponse	Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
ListRetirableGrants ( string retiringPrincipal ) : ListRetirableGrantsResponse	Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
ListRetirableGrantsAsync ( ListRetirableGrantsRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ListRetirableGrants operation.
ListRetirableGrantsAsync ( System cancellationToken = default(CancellationToken) ) : Task	Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
ListRetirableGrantsAsync ( string retiringPrincipal, System cancellationToken = default(CancellationToken) ) : Task	Returns a list of all grants for which the grant's `RetiringPrincipal` matches the one specified. A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
PutKeyPolicy ( PutKeyPolicyRequest request ) : PutKeyPolicyResponse	Attaches a key policy to the specified customer master key (CMK). For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
PutKeyPolicy ( string keyId, string policy, string policyName ) : PutKeyPolicyResponse	Attaches a key policy to the specified customer master key (CMK). For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
PutKeyPolicyAsync ( PutKeyPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the PutKeyPolicy operation.
PutKeyPolicyAsync ( string keyId, string policy, string policyName, System cancellationToken = default(CancellationToken) ) : Task	Attaches a key policy to the specified customer master key (CMK). For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
ReEncrypt ( ReEncryptRequest request ) : ReEncryptResponse	Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext. Unlike other operations, `ReEncrypt` is authorized twice, once as `ReEncryptFrom` on the source CMK and once as `ReEncryptTo` on the destination CMK. We recommend that you include the `"kms:ReEncrypt*"` permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.
ReEncryptAsync ( ReEncryptRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ReEncrypt operation.
RetireGrant ( RetireGrantRequest request ) : RetireGrantResponse	Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: The AWS account (root user) under which the grant was created The `RetiringPrincipal`, if present in the grant The `GranteePrincipal`, if `RetireGrant` is an operation specified in the grant You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
RetireGrant ( string grantToken ) : RetireGrantResponse	Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: The AWS account (root user) under which the grant was created The `RetiringPrincipal`, if present in the grant The `GranteePrincipal`, if `RetireGrant` is an operation specified in the grant You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
RetireGrantAsync ( RetireGrantRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the RetireGrant operation.
RetireGrantAsync ( string grantToken, System cancellationToken = default(CancellationToken) ) : Task	Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: The AWS account (root user) under which the grant was created The `RetiringPrincipal`, if present in the grant The `GranteePrincipal`, if `RetireGrant` is an operation specified in the grant You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
RevokeGrant ( RevokeGrantRequest request ) : RevokeGrantResponse	Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
RevokeGrant ( string grantId, string keyId ) : RevokeGrantResponse	Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
RevokeGrantAsync ( RevokeGrantRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the RevokeGrant operation.
RevokeGrantAsync ( string grantId, string keyId, System cancellationToken = default(CancellationToken) ) : Task	Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
ScheduleKeyDeletion ( ScheduleKeyDeletionRequest request ) : ScheduleKeyDeletionResponse	Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to `PendingDeletion`. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
ScheduleKeyDeletion ( string keyId ) : ScheduleKeyDeletionResponse	Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to `PendingDeletion`. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
ScheduleKeyDeletion ( string keyId, int pendingWindowInDays ) : ScheduleKeyDeletionResponse	Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to `PendingDeletion`. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
ScheduleKeyDeletionAsync ( ScheduleKeyDeletionRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the ScheduleKeyDeletion operation.
ScheduleKeyDeletionAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task	Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to `PendingDeletion`. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
ScheduleKeyDeletionAsync ( string keyId, int pendingWindowInDays, System cancellationToken = default(CancellationToken) ) : Task	Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to `PendingDeletion`. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it. Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey. For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
UpdateAlias ( UpdateAliasRequest request ) : UpdateAliasResponse	Updates an alias to map it to a different key. An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). The alias and the key it is mapped to must be in the same AWS account and the same region.
UpdateAlias ( string aliasName, string targetKeyId ) : UpdateAliasResponse	Updates an alias to map it to a different key. An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). The alias and the key it is mapped to must be in the same AWS account and the same region.
UpdateAliasAsync ( UpdateAliasRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the UpdateAlias operation.
UpdateAliasAsync ( string aliasName, string targetKeyId, System cancellationToken = default(CancellationToken) ) : Task	Updates an alias to map it to a different key. An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). The alias and the key it is mapped to must be in the same AWS account and the same region.
UpdateKeyDescription ( UpdateKeyDescriptionRequest request ) : UpdateKeyDescriptionResponse	Updates the description of a customer master key (CMK).
UpdateKeyDescription ( string keyId, string description ) : UpdateKeyDescriptionResponse	Updates the description of a customer master key (CMK).
UpdateKeyDescriptionAsync ( UpdateKeyDescriptionRequest request, System cancellationToken = default(CancellationToken) ) : Task	Initiates the asynchronous execution of the UpdateKeyDescription operation.
UpdateKeyDescriptionAsync ( string keyId, string description, System cancellationToken = default(CancellationToken) ) : Task	Updates the description of a customer master key (CMK).

Protected Methods

Method	Description
CreateSigner ( ) : AbstractAWSSigner	Creates the signer for the service.
Dispose ( bool disposing ) : void	Disposes the service client.

Method Details

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonKeyManagementServiceClient ( ) : System
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Credentials

public AmazonKeyManagementServiceClient ( AWSCredentials credentials ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Credentials and an AmazonKeyManagementServiceClient Configuration object.

public AmazonKeyManagementServiceClient ( AWSCredentials credentials, AmazonKeyManagementServiceConfig clientConfig ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
clientConfig	AmazonKeyManagementServiceConfig	The AmazonKeyManagementServiceClient Configuration Object
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Credentials

public AmazonKeyManagementServiceClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
region	RegionEndpoint	The region to connect.
return	System

AmazonKeyManagementServiceClient() public method

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonKeyManagementServiceClient ( AmazonKeyManagementServiceConfig config ) : System
config	AmazonKeyManagementServiceConfig	The AmazonKeyManagementServiceClient Configuration Object
return	System

AmazonKeyManagementServiceClient() public method

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public AmazonKeyManagementServiceClient ( RegionEndpoint region ) : System
region	RegionEndpoint	The region to connect.
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key

public AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonKeyManagementServiceClient Configuration object.

public AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonKeyManagementServiceConfig clientConfig ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
clientConfig	AmazonKeyManagementServiceConfig	The AmazonKeyManagementServiceClient Configuration Object
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key

public AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
region	RegionEndpoint	The region to connect.
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key

public AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonKeyManagementServiceClient Configuration object.

public AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonKeyManagementServiceConfig clientConfig ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
clientConfig	AmazonKeyManagementServiceConfig	The AmazonKeyManagementServiceClient Configuration Object
return	System

AmazonKeyManagementServiceClient() public method

Constructs AmazonKeyManagementServiceClient with AWS Access Key ID and AWS Secret Key

public AmazonKeyManagementServiceClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
awsSessionToken	string	AWS Session Token
region	RegionEndpoint	The region to connect.
return	System

BeginCancelKeyDeletion() public method

Initiates the asynchronous execution of the CancelKeyDeletion operation.

public BeginCancelKeyDeletion ( CancelKeyDeletionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.CancelKeyDeletionRequest	Container for the necessary parameters to execute the CancelKeyDeletion operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginCreateAlias() public method

Initiates the asynchronous execution of the CreateAlias operation.

public BeginCreateAlias ( CreateAliasRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.CreateAliasRequest	Container for the necessary parameters to execute the CreateAlias operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginCreateGrant() public method

Initiates the asynchronous execution of the CreateGrant operation.

public BeginCreateGrant ( CreateGrantRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.CreateGrantRequest	Container for the necessary parameters to execute the CreateGrant operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginCreateKey() public method

Initiates the asynchronous execution of the CreateKey operation.

public BeginCreateKey ( CreateKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.CreateKeyRequest	Container for the necessary parameters to execute the CreateKey operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDecrypt() public method

Initiates the asynchronous execution of the Decrypt operation.

public BeginDecrypt ( DecryptRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.DecryptRequest	Container for the necessary parameters to execute the Decrypt operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDeleteAlias() public method

Initiates the asynchronous execution of the DeleteAlias operation.

public BeginDeleteAlias ( Amazon.KeyManagementService.Model.DeleteAliasRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.DeleteAliasRequest	Container for the necessary parameters to execute the DeleteAlias operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDeleteImportedKeyMaterial() public method

Initiates the asynchronous execution of the DeleteImportedKeyMaterial operation.

public BeginDeleteImportedKeyMaterial ( DeleteImportedKeyMaterialRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.DeleteImportedKeyMaterialRequest	Container for the necessary parameters to execute the DeleteImportedKeyMaterial operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDescribeKey() public method

Initiates the asynchronous execution of the DescribeKey operation.

public BeginDescribeKey ( DescribeKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.DescribeKeyRequest	Container for the necessary parameters to execute the DescribeKey operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDisableKey() public method

Initiates the asynchronous execution of the DisableKey operation.

public BeginDisableKey ( DisableKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.DisableKeyRequest	Container for the necessary parameters to execute the DisableKey operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginDisableKeyRotation() public method

Initiates the asynchronous execution of the DisableKeyRotation operation.

public BeginDisableKeyRotation ( Amazon.KeyManagementService.Model.DisableKeyRotationRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.DisableKeyRotationRequest	Container for the necessary parameters to execute the DisableKeyRotation operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginEnableKey() public method

Initiates the asynchronous execution of the EnableKey operation.

public BeginEnableKey ( EnableKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.EnableKeyRequest	Container for the necessary parameters to execute the EnableKey operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginEnableKeyRotation() public method

Initiates the asynchronous execution of the EnableKeyRotation operation.

public BeginEnableKeyRotation ( EnableKeyRotationRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.EnableKeyRotationRequest	Container for the necessary parameters to execute the EnableKeyRotation operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginEncrypt() public method

Initiates the asynchronous execution of the Encrypt operation.

public BeginEncrypt ( EncryptRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.EncryptRequest	Container for the necessary parameters to execute the Encrypt operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginGenerateDataKey() public method

Initiates the asynchronous execution of the GenerateDataKey operation.

public BeginGenerateDataKey ( GenerateDataKeyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.GenerateDataKeyRequest	Container for the necessary parameters to execute the GenerateDataKey operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginGenerateDataKeyWithoutPlaintext() public method

Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation.

public BeginGenerateDataKeyWithoutPlaintext ( GenerateDataKeyWithoutPlaintextRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.GenerateDataKeyWithoutPlaintextRequest	Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginGenerateRandom() public method

Initiates the asynchronous execution of the GenerateRandom operation.

public BeginGenerateRandom ( GenerateRandomRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.GenerateRandomRequest	Container for the necessary parameters to execute the GenerateRandom operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginGetKeyPolicy() public method

Initiates the asynchronous execution of the GetKeyPolicy operation.

public BeginGetKeyPolicy ( GetKeyPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.GetKeyPolicyRequest	Container for the necessary parameters to execute the GetKeyPolicy operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginGetKeyRotationStatus() public method

Initiates the asynchronous execution of the GetKeyRotationStatus operation.

public BeginGetKeyRotationStatus ( GetKeyRotationStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.GetKeyRotationStatusRequest	Container for the necessary parameters to execute the GetKeyRotationStatus operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginGetParametersForImport() public method

Initiates the asynchronous execution of the GetParametersForImport operation.

public BeginGetParametersForImport ( GetParametersForImportRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.GetParametersForImportRequest	Container for the necessary parameters to execute the GetParametersForImport operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginImportKeyMaterial() public method

Initiates the asynchronous execution of the ImportKeyMaterial operation.

public BeginImportKeyMaterial ( ImportKeyMaterialRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ImportKeyMaterialRequest	Container for the necessary parameters to execute the ImportKeyMaterial operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListAliases() public method

Initiates the asynchronous execution of the ListAliases operation.

public BeginListAliases ( ListAliasesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ListAliasesRequest	Container for the necessary parameters to execute the ListAliases operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListGrants() public method

Initiates the asynchronous execution of the ListGrants operation.

public BeginListGrants ( ListGrantsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ListGrantsRequest	Container for the necessary parameters to execute the ListGrants operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListKeyPolicies() public method

Initiates the asynchronous execution of the ListKeyPolicies operation.

public BeginListKeyPolicies ( ListKeyPoliciesRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ListKeyPoliciesRequest	Container for the necessary parameters to execute the ListKeyPolicies operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListKeys() public method

Initiates the asynchronous execution of the ListKeys operation.

public BeginListKeys ( ListKeysRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ListKeysRequest	Container for the necessary parameters to execute the ListKeys operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginListRetirableGrants() public method

Initiates the asynchronous execution of the ListRetirableGrants operation.

public BeginListRetirableGrants ( ListRetirableGrantsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ListRetirableGrantsRequest	Container for the necessary parameters to execute the ListRetirableGrants operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginPutKeyPolicy() public method

Initiates the asynchronous execution of the PutKeyPolicy operation.

public BeginPutKeyPolicy ( PutKeyPolicyRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.PutKeyPolicyRequest	Container for the necessary parameters to execute the PutKeyPolicy operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginReEncrypt() public method

Initiates the asynchronous execution of the ReEncrypt operation.

public BeginReEncrypt ( ReEncryptRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ReEncryptRequest	Container for the necessary parameters to execute the ReEncrypt operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginRetireGrant() public method

Initiates the asynchronous execution of the RetireGrant operation.

public BeginRetireGrant ( RetireGrantRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.RetireGrantRequest	Container for the necessary parameters to execute the RetireGrant operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginRevokeGrant() public method

Initiates the asynchronous execution of the RevokeGrant operation.

public BeginRevokeGrant ( RevokeGrantRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.RevokeGrantRequest	Container for the necessary parameters to execute the RevokeGrant operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginScheduleKeyDeletion() public method

Initiates the asynchronous execution of the ScheduleKeyDeletion operation.

public BeginScheduleKeyDeletion ( ScheduleKeyDeletionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest	Container for the necessary parameters to execute the ScheduleKeyDeletion operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginUpdateAlias() public method

Initiates the asynchronous execution of the UpdateAlias operation.

public BeginUpdateAlias ( UpdateAliasRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.UpdateAliasRequest	Container for the necessary parameters to execute the UpdateAlias operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

BeginUpdateKeyDescription() public method

Initiates the asynchronous execution of the UpdateKeyDescription operation.

public BeginUpdateKeyDescription ( UpdateKeyDescriptionRequest request, AsyncCallback callback, object state ) : IAsyncResult
request	Amazon.KeyManagementService.Model.UpdateKeyDescriptionRequest	Container for the necessary parameters to execute the UpdateKeyDescription operation on AmazonKeyManagementServiceClient.
callback	AsyncCallback	An AsyncCallback delegate that is invoked when the operation completes.
state	object	A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return	IAsyncResult

CancelKeyDeletion() public method

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public CancelKeyDeletion ( CancelKeyDeletionRequest request ) : CancelKeyDeletionResponse
request	Amazon.KeyManagementService.Model.CancelKeyDeletionRequest	Container for the necessary parameters to execute the CancelKeyDeletion service method.
return	Amazon.KeyManagementService.Model.CancelKeyDeletionResponse

CancelKeyDeletion() public method

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public CancelKeyDeletion ( string keyId ) : CancelKeyDeletionResponse
keyId	string	The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
return	Amazon.KeyManagementService.Model.CancelKeyDeletionResponse

CancelKeyDeletionAsync() public method

Initiates the asynchronous execution of the CancelKeyDeletion operation.

public CancelKeyDeletionAsync ( CancelKeyDeletionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.CancelKeyDeletionRequest	Container for the necessary parameters to execute the CancelKeyDeletion operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CancelKeyDeletionAsync() public method

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public CancelKeyDeletionAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateAlias() public method

Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

/// The request was rejected because it attempted to create a resource that already exists. /// /// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified alias name is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified entity or resource could not be found. ///

public CreateAlias ( CreateAliasRequest request ) : CreateAliasResponse
request	Amazon.KeyManagementService.Model.CreateAliasRequest	Container for the necessary parameters to execute the CreateAlias service method.
return	CreateAliasResponse

CreateAlias() public method

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

public CreateAlias ( string aliasName, string targetKeyId ) : CreateAliasResponse
aliasName	string	String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
targetKeyId	string	An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
return	CreateAliasResponse

CreateAliasAsync() public method

Initiates the asynchronous execution of the CreateAlias operation.

public CreateAliasAsync ( CreateAliasRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.CreateAliasRequest	Container for the necessary parameters to execute the CreateAlias operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateAliasAsync() public method

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

public CreateAliasAsync ( string aliasName, string targetKeyId, System cancellationToken = default(CancellationToken) ) : Task
aliasName	string	String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
targetKeyId	string	An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateGrant() public method

Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified entity or resource could not be found. ///

public CreateGrant ( CreateGrantRequest request ) : CreateGrantResponse
request	Amazon.KeyManagementService.Model.CreateGrantRequest	Container for the necessary parameters to execute the CreateGrant service method.
return	Amazon.KeyManagementService.Model.CreateGrantResponse

CreateGrantAsync() public method

Initiates the asynchronous execution of the CreateGrant operation.

public CreateGrantAsync ( CreateGrantRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.CreateGrantRequest	Container for the necessary parameters to execute the CreateGrant operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateKey() public method

Creates a customer master key (CMK).

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide

public CreateKey ( CreateKeyRequest request ) : CreateKeyResponse
request	Amazon.KeyManagementService.Model.CreateKeyRequest	Container for the necessary parameters to execute the CreateKey service method.
return	Amazon.KeyManagementService.Model.CreateKeyResponse

CreateKeyAsync() public method

Initiates the asynchronous execution of the CreateKey operation.

public CreateKeyAsync ( CreateKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.CreateKeyRequest	Container for the necessary parameters to execute the CreateKey operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

CreateSigner() protected method

Creates the signer for the service.

protected CreateSigner ( ) : AbstractAWSSigner
return	Amazon.Runtime.Internal.Auth.AbstractAWSSigner

Decrypt() public method

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

GenerateDataKey
GenerateDataKeyWithoutPlaintext
Encrypt

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because the specified ciphertext has been corrupted or is /// otherwise invalid. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because the specified CMK was not available. The request /// can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public Decrypt ( DecryptRequest request ) : DecryptResponse
request	Amazon.KeyManagementService.Model.DecryptRequest	Container for the necessary parameters to execute the Decrypt service method.
return	Amazon.KeyManagementService.Model.DecryptResponse

DecryptAsync() public method

Initiates the asynchronous execution of the Decrypt operation.

public DecryptAsync ( DecryptRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.DecryptRequest	Container for the necessary parameters to execute the Decrypt operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DeleteAlias() public method

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public DeleteAlias ( Amazon.KeyManagementService.Model.DeleteAliasRequest request ) : DeleteAliasResponse
request	Amazon.KeyManagementService.Model.DeleteAliasRequest	Container for the necessary parameters to execute the DeleteAlias service method.
return	DeleteAliasResponse

DeleteAlias() public method

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

public DeleteAlias ( string aliasName ) : DeleteAliasResponse
aliasName	string	The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
return	DeleteAliasResponse

DeleteAliasAsync() public method

Initiates the asynchronous execution of the DeleteAlias operation.

public DeleteAliasAsync ( Amazon.KeyManagementService.Model.DeleteAliasRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.DeleteAliasRequest	Container for the necessary parameters to execute the DeleteAlias operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DeleteAliasAsync() public method

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

public DeleteAliasAsync ( string aliasName, System cancellationToken = default(CancellationToken) ) : Task
aliasName	string	The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DeleteImportedKeyMaterial() public method

Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public DeleteImportedKeyMaterial ( DeleteImportedKeyMaterialRequest request ) : DeleteImportedKeyMaterialResponse
request	Amazon.KeyManagementService.Model.DeleteImportedKeyMaterialRequest	Container for the necessary parameters to execute the DeleteImportedKeyMaterial service method.
return	DeleteImportedKeyMaterialResponse

DeleteImportedKeyMaterialAsync() public method

Initiates the asynchronous execution of the DeleteImportedKeyMaterial operation.

public DeleteImportedKeyMaterialAsync ( DeleteImportedKeyMaterialRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.DeleteImportedKeyMaterialRequest	Container for the necessary parameters to execute the DeleteImportedKeyMaterial operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DescribeKey() public method

Provides detailed information about the specified customer master key.

public DescribeKey ( DescribeKeyRequest request ) : DescribeKeyResponse
request	Amazon.KeyManagementService.Model.DescribeKeyRequest	Container for the necessary parameters to execute the DescribeKey service method.
return	Amazon.KeyManagementService.Model.DescribeKeyResponse

DescribeKey() public method

Provides detailed information about the specified customer master key.

public DescribeKey ( string keyId ) : DescribeKeyResponse
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias Name Example - alias/MyAliasName
return	Amazon.KeyManagementService.Model.DescribeKeyResponse

DescribeKeyAsync() public method

Initiates the asynchronous execution of the DescribeKey operation.

public DescribeKeyAsync ( DescribeKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.DescribeKeyRequest	Container for the necessary parameters to execute the DescribeKey operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DescribeKeyAsync() public method

Provides detailed information about the specified customer master key.

public DescribeKeyAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/". Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias Name Example - alias/MyAliasName
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DisableKey() public method

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

public DisableKey ( DisableKeyRequest request ) : DisableKeyResponse
request	Amazon.KeyManagementService.Model.DisableKeyRequest	Container for the necessary parameters to execute the DisableKey service method.
return	DisableKeyResponse

DisableKey() public method

public DisableKey ( string keyId ) : DisableKeyResponse
keyId	string	A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
return	DisableKeyResponse

DisableKeyAsync() public method

Initiates the asynchronous execution of the DisableKey operation.

public DisableKeyAsync ( DisableKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.DisableKeyRequest	Container for the necessary parameters to execute the DisableKey operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DisableKeyAsync() public method

public DisableKeyAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DisableKeyRotation() public method

Disables rotation of the specified key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public DisableKeyRotation ( Amazon.KeyManagementService.Model.DisableKeyRotationRequest request ) : DisableKeyRotationResponse
request	Amazon.KeyManagementService.Model.DisableKeyRotationRequest	Container for the necessary parameters to execute the DisableKeyRotation service method.
return	DisableKeyRotationResponse

DisableKeyRotation() public method

Disables rotation of the specified key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public DisableKeyRotation ( string keyId ) : DisableKeyRotationResponse
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
return	DisableKeyRotationResponse

DisableKeyRotationAsync() public method

Initiates the asynchronous execution of the DisableKeyRotation operation.

public DisableKeyRotationAsync ( Amazon.KeyManagementService.Model.DisableKeyRotationRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.DisableKeyRotationRequest	Container for the necessary parameters to execute the DisableKeyRotation operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

DisableKeyRotationAsync() public method

Disables rotation of the specified key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public DisableKeyRotationAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

Dispose() protected method

Disposes the service client.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

EnableKey() public method

Marks a key as enabled, thereby permitting its use.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified entity or resource could not be found. ///

public EnableKey ( EnableKeyRequest request ) : EnableKeyResponse
request	Amazon.KeyManagementService.Model.EnableKeyRequest	Container for the necessary parameters to execute the EnableKey service method.
return	EnableKeyResponse

EnableKey() public method

Marks a key as enabled, thereby permitting its use.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified entity or resource could not be found. ///

public EnableKey ( string keyId ) : EnableKeyResponse
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
return	EnableKeyResponse

EnableKeyAsync() public method

Initiates the asynchronous execution of the EnableKey operation.

public EnableKeyAsync ( EnableKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.EnableKeyRequest	Container for the necessary parameters to execute the EnableKey operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

EnableKeyAsync() public method

Marks a key as enabled, thereby permitting its use.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified entity or resource could not be found. ///

public EnableKeyAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

EnableKeyRotation() public method

Enables rotation of the specified customer master key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public EnableKeyRotation ( EnableKeyRotationRequest request ) : EnableKeyRotationResponse
request	Amazon.KeyManagementService.Model.EnableKeyRotationRequest	Container for the necessary parameters to execute the EnableKeyRotation service method.
return	EnableKeyRotationResponse

EnableKeyRotation() public method

Enables rotation of the specified customer master key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public EnableKeyRotation ( string keyId ) : EnableKeyRotationResponse
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
return	EnableKeyRotationResponse

EnableKeyRotationAsync() public method

Initiates the asynchronous execution of the EnableKeyRotation operation.

public EnableKeyRotationAsync ( EnableKeyRotationRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	Amazon.KeyManagementService.Model.EnableKeyRotationRequest	Container for the necessary parameters to execute the EnableKeyRotation operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

EnableKeyRotationAsync() public method

Enables rotation of the specified customer master key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public EnableKeyRotationAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

Encrypt() public method

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.

If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because the specified KeySpec value is not valid. /// /// The request was rejected because the specified CMK was not available. The request /// can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public Encrypt ( EncryptRequest request ) : EncryptResponse
request	EncryptRequest	Container for the necessary parameters to execute the Encrypt service method.
return	EncryptResponse

EncryptAsync() public method

Initiates the asynchronous execution of the Encrypt operation.

public EncryptAsync ( EncryptRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	EncryptRequest	Container for the necessary parameters to execute the Encrypt operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

EndCancelKeyDeletion() public method

Finishes the asynchronous execution of the CancelKeyDeletion operation.

public EndCancelKeyDeletion ( IAsyncResult asyncResult ) : CancelKeyDeletionResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginCancelKeyDeletion.
return	CancelKeyDeletionResponse

EndCreateAlias() public method

Finishes the asynchronous execution of the CreateAlias operation.

public EndCreateAlias ( IAsyncResult asyncResult ) : CreateAliasResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginCreateAlias.
return	CreateAliasResponse

EndCreateGrant() public method

Finishes the asynchronous execution of the CreateGrant operation.

public EndCreateGrant ( IAsyncResult asyncResult ) : CreateGrantResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginCreateGrant.
return	CreateGrantResponse

EndCreateKey() public method

Finishes the asynchronous execution of the CreateKey operation.

public EndCreateKey ( IAsyncResult asyncResult ) : CreateKeyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginCreateKey.
return	CreateKeyResponse

EndDecrypt() public method

Finishes the asynchronous execution of the Decrypt operation.

public EndDecrypt ( IAsyncResult asyncResult ) : DecryptResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDecrypt.
return	DecryptResponse

EndDeleteAlias() public method

Finishes the asynchronous execution of the DeleteAlias operation.

public EndDeleteAlias ( IAsyncResult asyncResult ) : DeleteAliasResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDeleteAlias.
return	DeleteAliasResponse

EndDeleteImportedKeyMaterial() public method

Finishes the asynchronous execution of the DeleteImportedKeyMaterial operation.

public EndDeleteImportedKeyMaterial ( IAsyncResult asyncResult ) : DeleteImportedKeyMaterialResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDeleteImportedKeyMaterial.
return	DeleteImportedKeyMaterialResponse

EndDescribeKey() public method

Finishes the asynchronous execution of the DescribeKey operation.

public EndDescribeKey ( IAsyncResult asyncResult ) : DescribeKeyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDescribeKey.
return	DescribeKeyResponse

EndDisableKey() public method

Finishes the asynchronous execution of the DisableKey operation.

public EndDisableKey ( IAsyncResult asyncResult ) : DisableKeyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDisableKey.
return	DisableKeyResponse

EndDisableKeyRotation() public method

Finishes the asynchronous execution of the DisableKeyRotation operation.

public EndDisableKeyRotation ( IAsyncResult asyncResult ) : DisableKeyRotationResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginDisableKeyRotation.
return	DisableKeyRotationResponse

EndEnableKey() public method

Finishes the asynchronous execution of the EnableKey operation.

public EndEnableKey ( IAsyncResult asyncResult ) : EnableKeyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginEnableKey.
return	EnableKeyResponse

EndEnableKeyRotation() public method

Finishes the asynchronous execution of the EnableKeyRotation operation.

public EndEnableKeyRotation ( IAsyncResult asyncResult ) : EnableKeyRotationResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginEnableKeyRotation.
return	EnableKeyRotationResponse

EndEncrypt() public method

Finishes the asynchronous execution of the Encrypt operation.

public EndEncrypt ( IAsyncResult asyncResult ) : EncryptResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginEncrypt.
return	EncryptResponse

EndGenerateDataKey() public method

Finishes the asynchronous execution of the GenerateDataKey operation.

public EndGenerateDataKey ( IAsyncResult asyncResult ) : GenerateDataKeyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginGenerateDataKey.
return	GenerateDataKeyResponse

EndGenerateDataKeyWithoutPlaintext() public method

Finishes the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation.

public EndGenerateDataKeyWithoutPlaintext ( IAsyncResult asyncResult ) : GenerateDataKeyWithoutPlaintextResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginGenerateDataKeyWithoutPlaintext.
return	GenerateDataKeyWithoutPlaintextResponse

EndGenerateRandom() public method

Finishes the asynchronous execution of the GenerateRandom operation.

public EndGenerateRandom ( IAsyncResult asyncResult ) : GenerateRandomResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginGenerateRandom.
return	GenerateRandomResponse

EndGetKeyPolicy() public method

Finishes the asynchronous execution of the GetKeyPolicy operation.

public EndGetKeyPolicy ( IAsyncResult asyncResult ) : GetKeyPolicyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginGetKeyPolicy.
return	GetKeyPolicyResponse

EndGetKeyRotationStatus() public method

Finishes the asynchronous execution of the GetKeyRotationStatus operation.

public EndGetKeyRotationStatus ( IAsyncResult asyncResult ) : GetKeyRotationStatusResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginGetKeyRotationStatus.
return	GetKeyRotationStatusResponse

EndGetParametersForImport() public method

Finishes the asynchronous execution of the GetParametersForImport operation.

public EndGetParametersForImport ( IAsyncResult asyncResult ) : GetParametersForImportResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginGetParametersForImport.
return	GetParametersForImportResponse

EndImportKeyMaterial() public method

Finishes the asynchronous execution of the ImportKeyMaterial operation.

public EndImportKeyMaterial ( IAsyncResult asyncResult ) : ImportKeyMaterialResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginImportKeyMaterial.
return	ImportKeyMaterialResponse

EndListAliases() public method

Finishes the asynchronous execution of the ListAliases operation.

public EndListAliases ( IAsyncResult asyncResult ) : ListAliasesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListAliases.
return	ListAliasesResponse

EndListGrants() public method

Finishes the asynchronous execution of the ListGrants operation.

public EndListGrants ( IAsyncResult asyncResult ) : ListGrantsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListGrants.
return	ListGrantsResponse

EndListKeyPolicies() public method

Finishes the asynchronous execution of the ListKeyPolicies operation.

public EndListKeyPolicies ( IAsyncResult asyncResult ) : ListKeyPoliciesResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListKeyPolicies.
return	ListKeyPoliciesResponse

EndListKeys() public method

Finishes the asynchronous execution of the ListKeys operation.

public EndListKeys ( IAsyncResult asyncResult ) : ListKeysResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListKeys.
return	ListKeysResponse

EndListRetirableGrants() public method

Finishes the asynchronous execution of the ListRetirableGrants operation.

public EndListRetirableGrants ( IAsyncResult asyncResult ) : ListRetirableGrantsResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginListRetirableGrants.
return	ListRetirableGrantsResponse

EndPutKeyPolicy() public method

Finishes the asynchronous execution of the PutKeyPolicy operation.

public EndPutKeyPolicy ( IAsyncResult asyncResult ) : PutKeyPolicyResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginPutKeyPolicy.
return	PutKeyPolicyResponse

EndReEncrypt() public method

Finishes the asynchronous execution of the ReEncrypt operation.

public EndReEncrypt ( IAsyncResult asyncResult ) : ReEncryptResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginReEncrypt.
return	ReEncryptResponse

EndRetireGrant() public method

Finishes the asynchronous execution of the RetireGrant operation.

public EndRetireGrant ( IAsyncResult asyncResult ) : RetireGrantResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginRetireGrant.
return	RetireGrantResponse

EndRevokeGrant() public method

Finishes the asynchronous execution of the RevokeGrant operation.

public EndRevokeGrant ( IAsyncResult asyncResult ) : RevokeGrantResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginRevokeGrant.
return	RevokeGrantResponse

EndScheduleKeyDeletion() public method

Finishes the asynchronous execution of the ScheduleKeyDeletion operation.

public EndScheduleKeyDeletion ( IAsyncResult asyncResult ) : ScheduleKeyDeletionResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginScheduleKeyDeletion.
return	ScheduleKeyDeletionResponse

EndUpdateAlias() public method

Finishes the asynchronous execution of the UpdateAlias operation.

public EndUpdateAlias ( IAsyncResult asyncResult ) : UpdateAliasResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginUpdateAlias.
return	UpdateAliasResponse

EndUpdateKeyDescription() public method

Finishes the asynchronous execution of the UpdateKeyDescription operation.

public EndUpdateKeyDescription ( IAsyncResult asyncResult ) : UpdateKeyDescriptionResponse
asyncResult	IAsyncResult	The IAsyncResult returned by the call to BeginUpdateKeyDescription.
return	UpdateKeyDescriptionResponse

GenerateDataKey() public method

Returns a data encryption key that you can use in your application to encrypt data locally.

You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.

This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.

We recommend that you use the following pattern to encrypt data locally in your application:

Use this operation (GenerateDataKey) to retrieve a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom.

If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because the specified KeySpec value is not valid. /// /// The request was rejected because the specified CMK was not available. The request /// can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public GenerateDataKey ( GenerateDataKeyRequest request ) : GenerateDataKeyResponse
request	GenerateDataKeyRequest	Container for the necessary parameters to execute the GenerateDataKey service method.
return	GenerateDataKeyResponse

GenerateDataKeyAsync() public method

Initiates the asynchronous execution of the GenerateDataKey operation.

public GenerateDataKeyAsync ( GenerateDataKeyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	GenerateDataKeyRequest	Container for the necessary parameters to execute the GenerateDataKey operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GenerateDataKeyWithoutPlaintext() public method

Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.

This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because the specified KeySpec value is not valid. /// /// The request was rejected because the specified CMK was not available. The request /// can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public GenerateDataKeyWithoutPlaintext ( GenerateDataKeyWithoutPlaintextRequest request ) : GenerateDataKeyWithoutPlaintextResponse
request	GenerateDataKeyWithoutPlaintextRequest	Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext service method.
return	GenerateDataKeyWithoutPlaintextResponse

GenerateDataKeyWithoutPlaintextAsync() public method

Initiates the asynchronous execution of the GenerateDataKeyWithoutPlaintext operation.

public GenerateDataKeyWithoutPlaintextAsync ( GenerateDataKeyWithoutPlaintextRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	GenerateDataKeyWithoutPlaintextRequest	Container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GenerateRandom() public method

Generates an unpredictable byte string.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. ///

public GenerateRandom ( GenerateRandomRequest request ) : GenerateRandomResponse
request	GenerateRandomRequest	Container for the necessary parameters to execute the GenerateRandom service method.
return	GenerateRandomResponse

GenerateRandom() public method

Generates an unpredictable byte string.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. ///

public GenerateRandom ( int numberOfBytes ) : GenerateRandomResponse
numberOfBytes	int	The length of the byte string.
return	GenerateRandomResponse

GenerateRandomAsync() public method

Initiates the asynchronous execution of the GenerateRandom operation.

public GenerateRandomAsync ( GenerateRandomRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	GenerateRandomRequest	Container for the necessary parameters to execute the GenerateRandom operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GenerateRandomAsync() public method

Generates an unpredictable byte string.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. ///

public GenerateRandomAsync ( int numberOfBytes, System cancellationToken = default(CancellationToken) ) : Task
numberOfBytes	int	The length of the byte string.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GetKeyPolicy() public method

Retrieves a policy attached to the specified key.

public GetKeyPolicy ( GetKeyPolicyRequest request ) : GetKeyPolicyResponse
request	GetKeyPolicyRequest	Container for the necessary parameters to execute the GetKeyPolicy service method.
return	GetKeyPolicyResponse

GetKeyPolicy() public method

Retrieves a policy attached to the specified key.

public GetKeyPolicy ( string keyId, string policyName ) : GetKeyPolicyResponse
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
policyName	string	String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.
return	GetKeyPolicyResponse

GetKeyPolicyAsync() public method

Initiates the asynchronous execution of the GetKeyPolicy operation.

public GetKeyPolicyAsync ( GetKeyPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	GetKeyPolicyRequest	Container for the necessary parameters to execute the GetKeyPolicy operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GetKeyPolicyAsync() public method

Retrieves a policy attached to the specified key.

public GetKeyPolicyAsync ( string keyId, string policyName, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
policyName	string	String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GetKeyRotationStatus() public method

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

public GetKeyRotationStatus ( GetKeyRotationStatusRequest request ) : GetKeyRotationStatusResponse
request	GetKeyRotationStatusRequest	Container for the necessary parameters to execute the GetKeyRotationStatus service method.
return	GetKeyRotationStatusResponse

GetKeyRotationStatus() public method

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

public GetKeyRotationStatus ( string keyId ) : GetKeyRotationStatusResponse
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
return	GetKeyRotationStatusResponse

GetKeyRotationStatusAsync() public method

Initiates the asynchronous execution of the GetKeyRotationStatus operation.

public GetKeyRotationStatusAsync ( GetKeyRotationStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	GetKeyRotationStatusRequest	Container for the necessary parameters to execute the GetKeyRotationStatus operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GetKeyRotationStatusAsync() public method

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

public GetKeyRotationStatusAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

GetParametersForImport() public method

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

public GetParametersForImport ( GetParametersForImportRequest request ) : GetParametersForImportResponse
request	GetParametersForImportRequest	Container for the necessary parameters to execute the GetParametersForImport service method.
return	GetParametersForImportResponse

GetParametersForImportAsync() public method

Initiates the asynchronous execution of the GetParametersForImport operation.

public GetParametersForImportAsync ( GetParametersForImportRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	GetParametersForImportRequest	Container for the necessary parameters to execute the GetParametersForImport operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ImportKeyMaterial() public method

Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.

After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the provided import token is expired. Use GetParametersForImport /// to retrieve a new import token and public key, use the new public key to encrypt the /// key material, and then try the request again. /// /// The request was rejected because the provided key material is invalid or is not the /// same key material that was previously imported into this customer master key (CMK). /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the specified ciphertext has been corrupted or is /// otherwise invalid. /// /// The request was rejected because the provided import token is invalid or is associated /// with a different customer master key (CMK). /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public ImportKeyMaterial ( ImportKeyMaterialRequest request ) : ImportKeyMaterialResponse
request	ImportKeyMaterialRequest	Container for the necessary parameters to execute the ImportKeyMaterial service method.
return	ImportKeyMaterialResponse

ImportKeyMaterialAsync() public method

Initiates the asynchronous execution of the ImportKeyMaterial operation.

public ImportKeyMaterialAsync ( ImportKeyMaterialRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ImportKeyMaterialRequest	Container for the necessary parameters to execute the ImportKeyMaterial operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListAliases() public method

Lists all of the key aliases in the account.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. ///

public ListAliases ( ListAliasesRequest request ) : ListAliasesResponse
request	ListAliasesRequest	Container for the necessary parameters to execute the ListAliases service method.
return	ListAliasesResponse

ListAliasesAsync() public method

Initiates the asynchronous execution of the ListAliases operation.

public ListAliasesAsync ( ListAliasesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ListAliasesRequest	Container for the necessary parameters to execute the ListAliases operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListGrants() public method

List the grants for a specified key.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public ListGrants ( ListGrantsRequest request ) : ListGrantsResponse
request	ListGrantsRequest	Container for the necessary parameters to execute the ListGrants service method.
return	ListGrantsResponse

ListGrantsAsync() public method

Initiates the asynchronous execution of the ListGrants operation.

public ListGrantsAsync ( ListGrantsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ListGrantsRequest	Container for the necessary parameters to execute the ListGrants operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListKeyPolicies() public method

Retrieves a list of policies attached to a key.

public ListKeyPolicies ( ListKeyPoliciesRequest request ) : ListKeyPoliciesResponse
request	ListKeyPoliciesRequest	Container for the necessary parameters to execute the ListKeyPolicies service method.
return	ListKeyPoliciesResponse

ListKeyPoliciesAsync() public method

Initiates the asynchronous execution of the ListKeyPolicies operation.

public ListKeyPoliciesAsync ( ListKeyPoliciesRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ListKeyPoliciesRequest	Container for the necessary parameters to execute the ListKeyPolicies operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListKeys() public method

Lists the customer master keys.

public ListKeys ( ListKeysRequest request ) : ListKeysResponse
request	ListKeysRequest	Container for the necessary parameters to execute the ListKeys service method.
return	ListKeysResponse

ListKeysAsync() public method

Initiates the asynchronous execution of the ListKeys operation.

public ListKeysAsync ( ListKeysRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ListKeysRequest	Container for the necessary parameters to execute the ListKeys operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListRetirableGrants() public method

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the specified entity or resource could not be found. ///

public ListRetirableGrants ( ) : ListRetirableGrantsResponse
return	ListRetirableGrantsResponse

ListRetirableGrants() public method

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the specified entity or resource could not be found. ///

public ListRetirableGrants ( ListRetirableGrantsRequest request ) : ListRetirableGrantsResponse
request	ListRetirableGrantsRequest	Container for the necessary parameters to execute the ListRetirableGrants service method.
return	ListRetirableGrantsResponse

ListRetirableGrants() public method

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the specified entity or resource could not be found. ///

public ListRetirableGrants ( string retiringPrincipal ) : ListRetirableGrantsResponse
retiringPrincipal	string	The retiring principal for which to list grants. To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
return	ListRetirableGrantsResponse

ListRetirableGrantsAsync() public method

Initiates the asynchronous execution of the ListRetirableGrants operation.

public ListRetirableGrantsAsync ( ListRetirableGrantsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ListRetirableGrantsRequest	Container for the necessary parameters to execute the ListRetirableGrants operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListRetirableGrantsAsync() public method

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the specified entity or resource could not be found. ///

public ListRetirableGrantsAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ListRetirableGrantsAsync() public method

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the marker that specifies where pagination should /// next begin is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the specified entity or resource could not be found. ///

public ListRetirableGrantsAsync ( string retiringPrincipal, System cancellationToken = default(CancellationToken) ) : Task
retiringPrincipal	string	The retiring principal for which to list grants. To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

PutKeyPolicy() public method

Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified policy is not syntactically or semantically /// correct. /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public PutKeyPolicy ( PutKeyPolicyRequest request ) : PutKeyPolicyResponse
request	PutKeyPolicyRequest	Container for the necessary parameters to execute the PutKeyPolicy service method.
return	PutKeyPolicyResponse

PutKeyPolicy() public method

Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified policy is not syntactically or semantically /// correct. /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public PutKeyPolicy ( string keyId, string policy, string policyName ) : PutKeyPolicyResponse
keyId	string	A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
policy	string	The key policy to attach to the CMK. If you do not set `BypassPolicyLockoutSafetyCheck` to true, the policy must meet the following criteria: It must allow the principal making the `PutKeyPolicy` request to make a subsequent `PutKeyPolicy` request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide. The policy size limit is 32 KiB (32768 bytes).
policyName	string	The name of the key policy. This value must be `default`.
return	PutKeyPolicyResponse

PutKeyPolicyAsync() public method

Initiates the asynchronous execution of the PutKeyPolicy operation.

public PutKeyPolicyAsync ( PutKeyPolicyRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	PutKeyPolicyRequest	Container for the necessary parameters to execute the PutKeyPolicy operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

PutKeyPolicyAsync() public method

Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because a limit was exceeded. For more information, see Limits /// in the AWS Key Management Service Developer Guide. /// /// The request was rejected because the specified policy is not syntactically or semantically /// correct. /// /// The request was rejected because the specified entity or resource could not be found. /// /// The request was rejected because a specified parameter is not supported or a specified /// resource is not valid for this operation. ///

public PutKeyPolicyAsync ( string keyId, string policy, string policyName, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
policy	string	The key policy to attach to the CMK. If you do not set `BypassPolicyLockoutSafetyCheck` to true, the policy must meet the following criteria: It must allow the principal making the `PutKeyPolicy` request to make a subsequent `PutKeyPolicy` request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide. The policy size limit is 32 KiB (32768 bytes).
policyName	string	The name of the key policy. This value must be `default`.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ReEncrypt() public method

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified CMK is not enabled. /// /// The request was rejected because the specified ciphertext has been corrupted or is /// otherwise invalid. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because the specified KeySpec value is not valid. /// /// The request was rejected because the specified CMK was not available. The request /// can be retried. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public ReEncrypt ( ReEncryptRequest request ) : ReEncryptResponse
request	ReEncryptRequest	Container for the necessary parameters to execute the ReEncrypt service method.
return	ReEncryptResponse

ReEncryptAsync() public method

Initiates the asynchronous execution of the ReEncrypt operation.

public ReEncryptAsync ( ReEncryptRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ReEncryptRequest	Container for the necessary parameters to execute the ReEncrypt operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

RetireGrant() public method

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

The AWS account (root user) under which the grant was created
The RetiringPrincipal, if present in the grant
The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because the specified GrantId is not valid. /// /// The request was rejected because the specified grant token is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public RetireGrant ( RetireGrantRequest request ) : RetireGrantResponse
request	RetireGrantRequest	Container for the necessary parameters to execute the RetireGrant service method.
return	RetireGrantResponse

RetireGrant() public method

The AWS account (root user) under which the grant was created
The RetiringPrincipal, if present in the grant
The GranteePrincipal, if RetireGrant is an operation specified in the grant

public RetireGrant ( string grantToken ) : RetireGrantResponse
grantToken	string	Token that identifies the grant to be retired.
return	RetireGrantResponse

RetireGrantAsync() public method

Initiates the asynchronous execution of the RetireGrant operation.

public RetireGrantAsync ( RetireGrantRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	RetireGrantRequest	Container for the necessary parameters to execute the RetireGrant operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

RetireGrantAsync() public method

The AWS account (root user) under which the grant was created
The RetiringPrincipal, if present in the grant
The GranteePrincipal, if RetireGrant is an operation specified in the grant

public RetireGrantAsync ( string grantToken, System cancellationToken = default(CancellationToken) ) : Task
grantToken	string	Token that identifies the grant to be retired.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

RevokeGrant() public method

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the specified GrantId is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public RevokeGrant ( RevokeGrantRequest request ) : RevokeGrantResponse
request	RevokeGrantRequest	Container for the necessary parameters to execute the RevokeGrant service method.
return	RevokeGrantResponse

RevokeGrant() public method

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the specified GrantId is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public RevokeGrant ( string grantId, string keyId ) : RevokeGrantResponse
grantId	string	Identifier of the grant to be revoked.
keyId	string	A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
return	RevokeGrantResponse

RevokeGrantAsync() public method

Initiates the asynchronous execution of the RevokeGrant operation.

public RevokeGrantAsync ( RevokeGrantRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	RevokeGrantRequest	Container for the necessary parameters to execute the RevokeGrant operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

RevokeGrantAsync() public method

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because the specified GrantId is not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public RevokeGrantAsync ( string grantId, string keyId, System cancellationToken = default(CancellationToken) ) : Task
grantId	string	Identifier of the grant to be revoked.
keyId	string	A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ScheduleKeyDeletion() public method

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public ScheduleKeyDeletion ( ScheduleKeyDeletionRequest request ) : ScheduleKeyDeletionResponse
request	ScheduleKeyDeletionRequest	Container for the necessary parameters to execute the ScheduleKeyDeletion service method.
return	ScheduleKeyDeletionResponse

ScheduleKeyDeletion() public method

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public ScheduleKeyDeletion ( string keyId ) : ScheduleKeyDeletionResponse
keyId	string	The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
return	ScheduleKeyDeletionResponse

ScheduleKeyDeletion() public method

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public ScheduleKeyDeletion ( string keyId, int pendingWindowInDays ) : ScheduleKeyDeletionResponse
keyId	string	The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
pendingWindowInDays	int	The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
return	ScheduleKeyDeletionResponse

ScheduleKeyDeletionAsync() public method

Initiates the asynchronous execution of the ScheduleKeyDeletion operation.

public ScheduleKeyDeletionAsync ( ScheduleKeyDeletionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	ScheduleKeyDeletionRequest	Container for the necessary parameters to execute the ScheduleKeyDeletion operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ScheduleKeyDeletionAsync() public method

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public ScheduleKeyDeletionAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

ScheduleKeyDeletionAsync() public method

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

public ScheduleKeyDeletionAsync ( string keyId, int pendingWindowInDays, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
pendingWindowInDays	int	The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

UpdateAlias() public method

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

public UpdateAlias ( UpdateAliasRequest request ) : UpdateAliasResponse
request	UpdateAliasRequest	Container for the necessary parameters to execute the UpdateAlias service method.
return	UpdateAliasResponse

UpdateAlias() public method

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

The alias and the key it is mapped to must be in the same AWS account and the same region.

public UpdateAlias ( string aliasName, string targetKeyId ) : UpdateAliasResponse
aliasName	string	String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
targetKeyId	string	Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 You can call ListAliases to verify that the alias is mapped to the correct `TargetKeyId`.
return	UpdateAliasResponse

UpdateAliasAsync() public method

Initiates the asynchronous execution of the UpdateAlias operation.

public UpdateAliasAsync ( UpdateAliasRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	UpdateAliasRequest	Container for the necessary parameters to execute the UpdateAlias operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

UpdateAliasAsync() public method

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

The alias and the key it is mapped to must be in the same AWS account and the same region.

public UpdateAliasAsync ( string aliasName, string targetKeyId, System cancellationToken = default(CancellationToken) ) : Task
aliasName	string	String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
targetKeyId	string	Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 You can call ListAliases to verify that the alias is mapped to the correct `TargetKeyId`.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

UpdateKeyDescription() public method

Updates the description of a customer master key (CMK).

public UpdateKeyDescription ( UpdateKeyDescriptionRequest request ) : UpdateKeyDescriptionResponse
request	UpdateKeyDescriptionRequest	Container for the necessary parameters to execute the UpdateKeyDescription service method.
return	UpdateKeyDescriptionResponse

UpdateKeyDescription() public method

Updates the description of a customer master key (CMK).

public UpdateKeyDescription ( string keyId, string description ) : UpdateKeyDescriptionResponse
keyId	string	A unique identifier for the CMK. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
description	string	New description for the CMK.
return	UpdateKeyDescriptionResponse

UpdateKeyDescriptionAsync() public method

Initiates the asynchronous execution of the UpdateKeyDescription operation.

public UpdateKeyDescriptionAsync ( UpdateKeyDescriptionRequest request, System cancellationToken = default(CancellationToken) ) : Task
request	UpdateKeyDescriptionRequest	Container for the necessary parameters to execute the UpdateKeyDescription operation.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

UpdateKeyDescriptionAsync() public method

Updates the description of a customer master key (CMK).

public UpdateKeyDescriptionAsync ( string keyId, string description, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	A unique identifier for the CMK. This value can be a globally unique identifier or the fully specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
description	string	New description for the CMK.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task