DescribeCustomKeyStores
Gets information about custom key stores in the account and Region.
This operation is part of the custom key stores feature in Amazon KMS, which combines the convenience and extensive integration of Amazon 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 Amazon 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 Amazon CloudHSM key store, verify that the associated
Amazon 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 Amazon CloudHSM key store, see the Troubleshooting Amazon CloudHSM key stores. For help repairing your external key store, see the Troubleshooting external key stores. Both topics are in the Amazon 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 Amazon KMS API follows an eventual consistency model. For more information, see Amazon KMS eventual consistency.
Request Syntax
{
"CustomKeyStoreId": "string
",
"CustomKeyStoreName": "string
",
"Limit": number
,
"Marker": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- CustomKeyStoreId
-
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the
CustomKeyStoreId
orCustomKeyStoreName
parameter, but not both.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- CustomKeyStoreName
-
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the
CustomKeyStoreId
orCustomKeyStoreName
parameter, but not both.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Limit
-
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon KMS does not return more than the specified number of items, but it might return fewer.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- Marker
-
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of
NextMarker
from the truncated response you just received.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\u00FF]*
Required: No
Response Syntax
{
"CustomKeyStores": [
{
"CloudHsmClusterId": "string",
"ConnectionErrorCode": "string",
"ConnectionState": "string",
"CreationDate": number,
"CustomKeyStoreId": "string",
"CustomKeyStoreName": "string",
"CustomKeyStoreType": "string",
"TrustAnchorCertificate": "string",
"XksProxyConfiguration": {
"AccessKeyId": "string",
"Connectivity": "string",
"UriEndpoint": "string",
"UriPath": "string",
"VpcEndpointServiceName": "string"
}
}
],
"NextMarker": "string",
"Truncated": boolean
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CustomKeyStores
-
Contains metadata about each custom key store.
Type: Array of CustomKeyStoresListEntry objects
- NextMarker
-
When
Truncated
is true, this element is present and contains the value to use for theMarker
parameter in a subsequent request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\u00FF]*
- Truncated
-
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 theMarker
parameter in a subsequent request.Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- CustomKeyStoreNotFoundException
-
The request was rejected because Amazon KMS cannot find a custom key store with the specified key store name or ID.
HTTP Status Code: 400
- InvalidMarkerException
-
The request was rejected because the marker that specifies where pagination should next begin is not valid.
HTTP Status Code: 400
- KMSInternalException
-
The request was rejected because an internal exception occurred. The request can be retried.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: