Skip to content

List Keys

kms_list_keys R Documentation

Gets a list of all KMS keys in the caller's Amazon Web Services account and Region

Description

Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListKeys (IAM policy)

Related operations:

  • create_key

  • describe_key

  • list_aliases

  • list_resource_tags

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Usage

kms_list_keys(Limit, Marker)

Arguments

Limit

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 1000, inclusive. If you do not include a value, it defaults to 100.

Marker

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.

Value

A list with the following syntax: 

list(
  Keys = list(
    list(
      KeyId = "string",
      KeyArn = "string"
    )
  ),
  NextMarker = "string",
  Truncated = TRUE|FALSE
)

Request syntax

svc$list_keys(
  Limit = 123,
  Marker = "string"
)

Examples

## Not run: 
# The following example lists KMS keys.
svc$list_keys()

## End(Not run)