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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::ListAliasesRequest

Defined in:

gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_id ⇒ String

  Lists only aliases that are associated with the specified KMS key.

• #limit ⇒ 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.

Instance Attribute Details

#key_id ⇒ String

Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

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

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4267

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

#limit ⇒ Integer

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.

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)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4267

class ListAliasesRequest < Struct.new(
  :key_id,
  :limit,
  :marker)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4267

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