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

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

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

Overview

Note:

When passing ListAliasesRequest as input to an Aws::Client method, you can use a vanilla 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) —

    Lists only aliases that refer to the specified CMK.

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

    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.