| 1 | |||
| 2 | package Paws::KMS::ListGrants; | ||
| 3 | use Moose; | ||
| 4 | has GranteePrincipal => (is => 'ro', isa => 'Str'); | ||
| 5 | has GrantId => (is => 'ro', isa => 'Str'); | ||
| 6 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 8 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGrants'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::ListGrantsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::KMS::ListGrants - Arguments for method ListGrants on L<Paws::KMS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListGrants on the | ||
| 26 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 27 | as arguments to method ListGrants. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGrants. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $kms = Paws->service('KMS'); | ||
| 34 | # To list grants for a customer master key (CMK) | ||
| 35 | # The following example lists grants for the specified CMK. | ||
| 36 | my $ListGrantsResponse = | ||
| 37 | $kms->ListGrants( 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Grants = $ListGrantsResponse->Grants; | ||
| 41 | my $Truncated = $ListGrantsResponse->Truncated; | ||
| 42 | |||
| 43 | # Returns a L<Paws::KMS::ListGrantsResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/ListGrants> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 GranteePrincipal => Str | ||
| 52 | |||
| 53 | Returns only grants where the specified principal is the grantee | ||
| 54 | principal for the grant. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 GrantId => Str | ||
| 59 | |||
| 60 | Returns only the grant with the specified grant ID. The grant ID | ||
| 61 | uniquely identifies the grant. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> KeyId => Str | ||
| 66 | |||
| 67 | Returns only grants for the specified customer master key (CMK). This | ||
| 68 | parameter is required. | ||
| 69 | |||
| 70 | Specify the key ID or key ARN of the CMK. To specify a CMK in a | ||
| 71 | different AWS account, you must use the key ARN. | ||
| 72 | |||
| 73 | For example: | ||
| 74 | |||
| 75 | =over | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | Key ARN: | ||
| 84 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Limit => Int | ||
| 93 | |||
| 94 | Use this parameter to specify the maximum number of items to return. | ||
| 95 | When this value is present, AWS KMS does not return more than the | ||
| 96 | specified number of items, but it might return fewer. | ||
| 97 | |||
| 98 | This value is optional. If you include a value, it must be between 1 | ||
| 99 | and 100, inclusive. If you do not include a value, it defaults to 50. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 Marker => Str | ||
| 104 | |||
| 105 | Use this parameter in a subsequent request after you receive a response | ||
| 106 | with truncated results. Set it to the value of C<NextMarker> from the | ||
| 107 | truncated response you just received. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method ListGrants in L<Paws::KMS> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |