/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KMS::ListRetirableGrants

NAME

Paws::KMS::ListRetirableGrants - Arguments for method ListRetirableGrants on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method ListRetirableGrants on the AWS Key Management Service service. Use the attributes of this class as arguments to method ListRetirableGrants.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListRetirableGrants.

SYNOPSIS

my $kms = Paws->service('KMS');
# To list grants that the specified principal can retire
# The following example lists the grants that the specified principal (identity)
# can retire.
my $ListGrantsResponse = $kms->ListRetirableGrants(
  'RetiringPrincipal' => 'arn:aws:iam::111122223333:role/ExampleRole' );

# Results:
my $Grants    = $ListGrantsResponse->Grants;
my $Truncated = $ListGrantsResponse->Truncated;

# Returns a L<Paws::KMS::ListGrantsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kms/ListRetirableGrants

ATTRIBUTES

Limit => Int

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 => Str

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.

REQUIRED RetiringPrincipal => Str

The retiring principal for which to list grants. Enter a principal in your AWS account.

To specify the retiring principal, use the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) 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) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) in the Example ARNs section of the Amazon Web Services General Reference.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListRetirableGrants in Paws::KMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues