AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Gets information about custom key stores in the account and Region.
This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.
By default, this operation returns information about all custom key stores in the
account and Region. To get only information about a particular custom key store, use
either the CustomKeyStoreName or CustomKeyStoreId parameter (but not
both).
To determine whether the custom key store is connected to its CloudHSM cluster or
external key store proxy, use the ConnectionState element in the response.
If an attempt to connect the custom key store failed, the ConnectionState value
is FAILED and the ConnectionErrorCode element in the response indicates
the cause of the failure. For help interpreting the ConnectionErrorCode, see
CustomKeyStoresListEntry.
Custom key stores have a DISCONNECTED connection state if the key store has
never been connected or you used the DisconnectCustomKeyStore operation to
disconnect it. Otherwise, the connection state is CONNECTED. If your custom key store
connection state is CONNECTED but you are having trouble using it, verify that
the backing store is active and available. For an CloudHSM key store, verify that
the associated CloudHSM cluster is active and contains the minimum number of HSMs
required for the operation, if any. For an external key store, verify that the external
key store proxy and its associated external key manager are reachable and enabled.
For help repairing your CloudHSM key store, see the Troubleshooting CloudHSM key stores. For help repairing your external key store, see the Troubleshooting external key stores. Both topics are in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.
Required permissions: kms:DescribeCustomKeyStores (IAM policy)
Related operations:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeCustomKeyStores and EndDescribeCustomKeyStores.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public virtual Task<DescribeCustomKeyStoresResponse> DescribeCustomKeyStoresAsync( DescribeCustomKeyStoresRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DescribeCustomKeyStores service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| CustomKeyStoreNotFoundException | The request was rejected because KMS cannot find a custom key store with the specified key store name or ID. |
| InvalidMarkerException | The request was rejected because the marker that specifies where pagination should next begin is not valid. |
| KMSInternalException | The request was rejected because an internal exception occurred. The request can be retried. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer