describe_custom_key_stores¶
Operation¶
describe_custom_key_stores
async
¶
describe_custom_key_stores(request: DescribeCustomKeyStoresInput | DescribeCustomKeyStoresInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCustomKeyStoresOutput
describe_custom_key_stores(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCustomKeyStoresInputDict]) -> DescribeCustomKeyStoresOutput
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:
-
ConnectCustomKeyStore
-
CreateCustomKeyStore
-
DeleteCustomKeyStore
-
DisconnectCustomKeyStore
-
UpdateCustomKeyStore
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeCustomKeyStoresOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeCustomKeyStoresInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCustomKeyStoresInput structure.
Attributes¶
custom_key_store_id
class-attribute
instance-attribute
¶
custom_key_store_id: str | None = ...
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 or CustomKeyStoreName
parameter, but not both.
custom_key_store_name
class-attribute
instance-attribute
¶
custom_key_store_name: str | None = ...
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 or CustomKeyStoreName
parameter, but not both.
Dictionaries¶
DescribeCustomKeyStoresInputDict
¶
Bases: TypedDict
Dictionary form of DescribeCustomKeyStoresInput.
Attributes¶
custom_key_store_id
instance-attribute
¶
custom_key_store_id: str | None
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 or CustomKeyStoreName
parameter, but not both.
custom_key_store_name
instance-attribute
¶
custom_key_store_name: str | None
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 or CustomKeyStoreName
parameter, but not both.
Output¶
DescribeCustomKeyStoresOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCustomKeyStoresOutput structure.
Attributes¶
custom_key_stores
class-attribute
instance-attribute
¶
custom_key_stores: list[CustomKeyStoresListEntry] | None = ...
Contains metadata about each custom key store.
next_marker
class-attribute
instance-attribute
¶
next_marker: str | None = ...
When Truncated is true, this element is present and contains the value
to use for the Marker parameter in a subsequent request.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
truncated
class-attribute
instance-attribute
¶
truncated: bool = ...
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.