New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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.
Base exception class for all service exceptions from KMS service.
Example
To get detailed information about custom key stores in the account and Region
// This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID. constinput = {}; constcommand = newDescribeCustomKeyStoresCommand(input); constresponse = awaitclient.send(command); /* response == { "CustomKeyStores": [] } */ // example id: to-get-detailed-information-about-custom-key-stores-in-the-account-and-region-1
Example
To get detailed information about an AWS CloudHSM key store by specifying its friendly name
// This example gets detailed information about a particular AWS CloudHSM key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. constinput = { "CustomKeyStoreName":"ExampleKeyStore" }; constcommand = newDescribeCustomKeyStoresCommand(input); constresponse = awaitclient.send(command); /* response == { "CustomKeyStores": [ { "CloudHsmClusterId": "cluster-234abcdefABC", "ConnectionState": "CONNECTED", "CreationDate": "1.499288695918E9", "CustomKeyStoreId": "cks-1234567890abcdef0", "CustomKeyStoreName": "ExampleKeyStore", "CustomKeyStoreType": "AWS_CLOUDHSM", "TrustAnchorCertificate": "<certificate appears here>" } ] } */ // example id: to-get-detailed-information-about-a-cloudhsm-custom-key-store-by-name-2
Example
To get detailed information about an external key store by specifying its ID
// This example gets detailed information about an external key store by specifying its ID. The example external key store proxy uses public endpoint connectivity. constinput = { "CustomKeyStoreId":"cks-9876543210fedcba9" }; constcommand = newDescribeCustomKeyStoresCommand(input); constresponse = awaitclient.send(command); /* response == { "CustomKeyStores": [ { "ConnectionState": "CONNECTED", "CreationDate": "1.599288695918E9", "CustomKeyStoreId": "cks-9876543210fedcba9", "CustomKeyStoreName": "ExampleExternalKeyStore", "CustomKeyStoreType": "EXTERNAL_KEY_STORE", "XksProxyConfiguration": { "AccessKeyId": "ABCDE12345670EXAMPLE", "Connectivity": "PUBLIC_ENDPOINT", "UriEndpoint": "https://myproxy.xks.example.com", "UriPath": "/kms/xks/v1" } } ] } */ // example id: to-get-detailed-information-about-an-external-key-store--3
Example
To get detailed information about an external key store VPC endpoint connectivity by specifying its friendly name
// This example gets detailed information about a particular external key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. The proxy URI path for this external key store includes an optional prefix. Also, because this example external key store uses VPC endpoint connectivity, the response includes the associated VPC endpoint service name. constinput = { "CustomKeyStoreName":"VPCExternalKeystore" }; constcommand = newDescribeCustomKeyStoresCommand(input); constresponse = awaitclient.send(command); /* response == { "CustomKeyStores": [ { "ConnectionState": "CONNECTED", "CreationDate": "1.643057863.842", "CustomKeyStoreId": "cks-876543210fedcba98", "CustomKeyStoreName": "ExampleVPCExternalKeyStore", "CustomKeyStoreType": "EXTERNAL_KEY_STORE", "XksProxyConfiguration": { "AccessKeyId": "ABCDE12345670EXAMPLE", "Connectivity": "VPC_ENDPOINT_SERVICE", "UriEndpoint": "https://myproxy-private.xks.example.com", "UriPath": "/example-prefix/kms/xks/v1", "VpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example1" } } ] } */ // example id: to-get-detailed-information-about-an-external-custom-key-store-by-name-4
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
orCustomKeyStoreId
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, theConnectionState
value isFAILED
and theConnectionErrorCode
element in the response indicates the cause of the failure. For help interpreting theConnectionErrorCode
, 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 isCONNECTED
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
Example
Use a bare-bones client and the command you need to make an API call.
Param
DescribeCustomKeyStoresCommandInput
Returns
DescribeCustomKeyStoresCommandOutput
See
input
shape.response
shape.config
shape.Throws
CustomKeyStoreNotFoundException (client fault)
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
Throws
InvalidMarkerException (client fault)
The request was rejected because the marker that specifies where pagination should next begin is not valid.
Throws
KMSInternalException (server fault)
The request was rejected because an internal exception occurred. The request can be retried.
Throws
KMSServiceException
Base exception class for all service exceptions from KMS service.
Example
To get detailed information about custom key stores in the account and Region
Example
To get detailed information about an AWS CloudHSM key store by specifying its friendly name
Example
To get detailed information about an external key store by specifying its ID
Example
To get detailed information about an external key store VPC endpoint connectivity by specifying its friendly name