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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

Note:

When making an API call, you may pass DescribeCustomKeyStoresRequest data as a 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) 


813
814
815
816
817
818
819
 
# File 'lib/aws-sdk-kms/types.rb', line 813

class DescribeCustomKeyStoresRequest < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :limit,
  :marker)
  include Aws::Structure
end

#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) 


813
814
815
816
817
818
819
 
# File 'lib/aws-sdk-kms/types.rb', line 813

class DescribeCustomKeyStoresRequest < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :limit,
  :marker)
  include Aws::Structure
end

#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) 


813
814
815
816
817
818
819
 
# File 'lib/aws-sdk-kms/types.rb', line 813

class DescribeCustomKeyStoresRequest < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :limit,
  :marker)
  include Aws::Structure
end

#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) 


813
814
815
816
817
818
819
 
# File 'lib/aws-sdk-kms/types.rb', line 813

class DescribeCustomKeyStoresRequest < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :limit,
  :marker)
  include Aws::Structure
end