Class: Aws::KMS::Types::ListAliasesRequest

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 ListAliasesRequest data as a hash:

{
  key_id: "KeyIdType",
  limit: 1,
  marker: "MarkerType",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#key_id ⇒ String

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller’s account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ‘ListAliases` returns all aliases in the account and region.

Returns:

  • (String) 


1949
1950
1951
1952
1953
1954
 
# File 'lib/aws-sdk-kms/types.rb', line 1949

class ListAliasesRequest < Struct.new(
  :key_id,
  :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.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Returns:

  • (Integer) 


1949
1950
1951
1952
1953
1954
 
# File 'lib/aws-sdk-kms/types.rb', line 1949

class ListAliasesRequest < Struct.new(
  :key_id,
  :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) 


1949
1950
1951
1952
1953
1954
 
# File 'lib/aws-sdk-kms/types.rb', line 1949

class ListAliasesRequest < Struct.new(
  :key_id,
  :limit,
  :marker)
  include Aws::Structure
end