Values.DescribeCustomKeyStoresResponseSourceGets 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: ConnectCustomKeyStore CreateCustomKeyStore DeleteCustomKeyStore DisconnectCustomKeyStore UpdateCustomKeyStore Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
type nonrec t = {customKeyStores : CustomKeyStoresList.t option;Contains metadata about each custom key store.
*)nextMarker : MarkerType.t option;When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.
*)truncated : BooleanType.t option;A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
*)}type nonrec error = [ | `CustomKeyStoreNotFoundException of CustomKeyStoreNotFoundException.t| `InvalidMarkerException of InvalidMarkerException.t| `KMSInternalException of KMSInternalException.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `CustomKeyStoreNotFoundException of CustomKeyStoreNotFoundException.t
| `InvalidMarkerException of InvalidMarkerException.t
| `KMSInternalException of KMSInternalException.t
| `Unknown_operation_error of string * string option ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `CustomKeyStoreNotFoundException of CustomKeyStoreNotFoundException.t
| `InvalidMarkerException of InvalidMarkerException.t
| `KMSInternalException of KMSInternalException.t
| `Unknown_operation_error of string * string option ]val to_value :
t ->
[> `Structure of
(string
* [> `Boolean of BooleanType.t
| `List of
[> `Structure of
(string
* [> `Enum of string
| `String of CustomKeyStoreIdType.t
| `Structure of
(string
* [> `Enum of string
| `String of XksProxyAuthenticationAccessKeyIdType.t ])
list
| `Timestamp of DateType.t ])
list ]
list
| `String of MarkerType.t ])
list ]