Amazonka.KMS.DescribeCustomKeyStores

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

This operation returns paginated results.

Creating a Request

data DescribeCustomKeyStores

See: newDescribeCustomKeyStores smart constructor.

Constructors

DescribeCustomKeyStores'

Fields

• customKeyStoreId :: Maybe Text

  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.

• customKeyStoreName :: Maybe Text

  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.

• limit :: Maybe Natural

  Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

• marker :: Maybe Text

  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.

Instances

ToJSON DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toJSON :: DescribeCustomKeyStores -> Value

toEncoding :: DescribeCustomKeyStores -> Encoding

toJSONList :: [DescribeCustomKeyStores] -> Value

toEncodingList :: [DescribeCustomKeyStores] -> Encoding

ToHeaders DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toHeaders :: DescribeCustomKeyStores -> [Header]

ToPath DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toPath :: DescribeCustomKeyStores -> ByteString

ToQuery DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toQuery :: DescribeCustomKeyStores -> QueryString

AWSPager DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

page :: DescribeCustomKeyStores -> AWSResponse DescribeCustomKeyStores -> Maybe DescribeCustomKeyStores

AWSRequest DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Associated Types

type AWSResponse DescribeCustomKeyStores

Methods

request :: (Service -> Service) -> DescribeCustomKeyStores -> Request DescribeCustomKeyStores

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCustomKeyStores -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCustomKeyStores)))

Generic DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Associated Types

type Rep DescribeCustomKeyStores :: Type -> Type

Methods

from :: DescribeCustomKeyStores -> Rep DescribeCustomKeyStores x

to :: Rep DescribeCustomKeyStores x -> DescribeCustomKeyStores

Read DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

readsPrec :: Int -> ReadS DescribeCustomKeyStores

readList :: ReadS [DescribeCustomKeyStores]

readPrec :: ReadPrec DescribeCustomKeyStores

readListPrec :: ReadPrec [DescribeCustomKeyStores]

Show DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

showsPrec :: Int -> DescribeCustomKeyStores -> ShowS

show :: DescribeCustomKeyStores -> String

showList :: [DescribeCustomKeyStores] -> ShowS

NFData DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

rnf :: DescribeCustomKeyStores -> ()

Eq DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

(==) :: DescribeCustomKeyStores -> DescribeCustomKeyStores -> Bool

(/=) :: DescribeCustomKeyStores -> DescribeCustomKeyStores -> Bool

Hashable DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

hashWithSalt :: Int -> DescribeCustomKeyStores -> Int

hash :: DescribeCustomKeyStores -> Int

type AWSResponse DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

type AWSResponse DescribeCustomKeyStores = DescribeCustomKeyStoresResponse

type Rep DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

type Rep DescribeCustomKeyStores = D1 ('MetaData "DescribeCustomKeyStores" "Amazonka.KMS.DescribeCustomKeyStores" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DescribeCustomKeyStores'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeCustomKeyStores :: DescribeCustomKeyStores

Create a value of DescribeCustomKeyStores with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeCustomKeyStores, describeCustomKeyStores_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 or CustomKeyStoreName parameter, but not both.

DescribeCustomKeyStores, describeCustomKeyStores_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 or CustomKeyStoreName parameter, but not both.

$sel:limit:DescribeCustomKeyStores', describeCustomKeyStores_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

$sel:marker:DescribeCustomKeyStores', describeCustomKeyStores_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.

Request Lenses

describeCustomKeyStores_customKeyStoreId :: Lens' DescribeCustomKeyStores (Maybe Text)

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.

describeCustomKeyStores_customKeyStoreName :: Lens' DescribeCustomKeyStores (Maybe Text)

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.

describeCustomKeyStores_limit :: Lens' DescribeCustomKeyStores (Maybe Natural)

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

describeCustomKeyStores_marker :: Lens' DescribeCustomKeyStores (Maybe Text)

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.

Destructuring the Response

data DescribeCustomKeyStoresResponse

See: newDescribeCustomKeyStoresResponse smart constructor.

Constructors

DescribeCustomKeyStoresResponse'

Fields

• customKeyStores :: Maybe [CustomKeyStoresListEntry]

  Contains metadata about each custom key store.

• nextMarker :: Maybe Text

  When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

• truncated :: Maybe 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 thisresponse to the Marker parameter in a subsequent request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Associated Types

type Rep DescribeCustomKeyStoresResponse :: Type -> Type

Methods

from :: DescribeCustomKeyStoresResponse -> Rep DescribeCustomKeyStoresResponse x

to :: Rep DescribeCustomKeyStoresResponse x -> DescribeCustomKeyStoresResponse

Show DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

showsPrec :: Int -> DescribeCustomKeyStoresResponse -> ShowS

show :: DescribeCustomKeyStoresResponse -> String

showList :: [DescribeCustomKeyStoresResponse] -> ShowS

NFData DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

rnf :: DescribeCustomKeyStoresResponse -> ()

Eq DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

(==) :: DescribeCustomKeyStoresResponse -> DescribeCustomKeyStoresResponse -> Bool

(/=) :: DescribeCustomKeyStoresResponse -> DescribeCustomKeyStoresResponse -> Bool

type Rep DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

type Rep DescribeCustomKeyStoresResponse = D1 ('MetaData "DescribeCustomKeyStoresResponse" "Amazonka.KMS.DescribeCustomKeyStores" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DescribeCustomKeyStoresResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customKeyStores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CustomKeyStoresListEntry])) :*: S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCustomKeyStoresResponse

Arguments

:: Int

$sel:httpStatus:DescribeCustomKeyStoresResponse'

-> DescribeCustomKeyStoresResponse

Create a value of DescribeCustomKeyStoresResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customKeyStores:DescribeCustomKeyStoresResponse', describeCustomKeyStoresResponse_customKeyStores - Contains metadata about each custom key store.

DescribeCustomKeyStoresResponse, describeCustomKeyStoresResponse_nextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

DescribeCustomKeyStoresResponse, describeCustomKeyStoresResponse_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 thisresponse to the Marker parameter in a subsequent request.

$sel:httpStatus:DescribeCustomKeyStoresResponse', describeCustomKeyStoresResponse_httpStatus - The response's http status code.

Response Lenses

describeCustomKeyStoresResponse_customKeyStores :: Lens' DescribeCustomKeyStoresResponse (Maybe [CustomKeyStoresListEntry])

Contains metadata about each custom key store.

describeCustomKeyStoresResponse_nextMarker :: Lens' DescribeCustomKeyStoresResponse (Maybe Text)

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

describeCustomKeyStoresResponse_truncated :: Lens' DescribeCustomKeyStoresResponse (Maybe 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 thisresponse to the Marker parameter in a subsequent request.

describeCustomKeyStoresResponse_httpStatus :: Lens' DescribeCustomKeyStoresResponse Int

The response's http status code.