kms_list_retirable_grants: Returns a list of all grants for which the grant's...

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Returns a list of all grants for which the grant\'s RetiringPrincipal matches the one specified.

Usage

1
kms_list_retirable_grants(Limit, Marker, RetiringPrincipal)

Arguments

Limit

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.

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.

RetiringPrincipal

[required] The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Details

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

Request syntax

1
2
3
4
5
svc$list_retirable_grants(
  Limit = 123,
  Marker = "string",
  RetiringPrincipal = "string"
)

Examples

1
2
3
4
5
# The following example lists the grants that the specified principal
# (identity) can retire.
svc$list_retirable_grants(
  RetiringPrincipal = "arn:aws:iam::111122223333:role/ExampleRole"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.