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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_key_store_idString

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.

Returns:

  • (String)


1988
1989
1990
1991
1992
1993
1994
1995
# File 'lib/aws-sdk-kms/types.rb', line 1988

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

#custom_key_store_nameString

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.

Returns:

  • (String)


1988
1989
1990
1991
1992
1993
1994
1995
# File 'lib/aws-sdk-kms/types.rb', line 1988

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

#limitInteger

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.

Returns:

  • (Integer)


1988
1989
1990
1991
1992
1993
1994
1995
# File 'lib/aws-sdk-kms/types.rb', line 1988

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

#markerString

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)


1988
1989
1990
1991
1992
1993
1994
1995
# File 'lib/aws-sdk-kms/types.rb', line 1988

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