You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KMS::Types::DescribeCustomKeyStoresRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeCustomKeyStoresRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  custom_key_store_id: "CustomKeyStoreIdType",
  custom_key_store_name: "CustomKeyStoreNameType",
  limit: 1,
  marker: "MarkerType",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_key_store_id ⇒ String

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, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

  • (String) —

    Gets only information about the specified custom key store.

#custom_key_store_name ⇒ String

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, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

  • (String) —

    Gets only information about the specified custom key store.

#limit ⇒ Integer

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

Returns:

  • (Integer) —

    Use this parameter to specify the maximum number of items to return.

#marker ⇒ String

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.

Returns:

  • (String) —

    Use this parameter in a subsequent request after you receive a response with truncated results.