« blib/lib/Paws/IAM/ListAttachedUserPoliciesResponse.pm
↑ Summary
blib/lib/Paws/IAM/ListEntitiesForPolicyResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::ListEntitiesForPolicy; | ||
| 3 | use Moose; | ||
| 4 | has EntityFilter => (is => 'ro', isa => 'Str'); | ||
| 5 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxItems => (is => 'ro', isa => 'Int'); | ||
| 7 | has PathPrefix => (is => 'ro', isa => 'Str'); | ||
| 8 | has PolicyArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has PolicyUsageFilter => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListEntitiesForPolicy'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::ListEntitiesForPolicyResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListEntitiesForPolicyResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IAM::ListEntitiesForPolicy - Arguments for method ListEntitiesForPolicy on L<Paws::IAM> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListEntitiesForPolicy on the | ||
| 27 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 28 | as arguments to method ListEntitiesForPolicy. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListEntitiesForPolicy. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iam = Paws->service('IAM'); | ||
| 35 | my $ListEntitiesForPolicyResponse = $iam->ListEntitiesForPolicy( | ||
| 36 | PolicyArn => 'MyarnType', | ||
| 37 | EntityFilter => 'User', # OPTIONAL | ||
| 38 | Marker => 'MymarkerType', # OPTIONAL | ||
| 39 | MaxItems => 1, # OPTIONAL | ||
| 40 | PathPrefix => 'MypathType', # OPTIONAL | ||
| 41 | PolicyUsageFilter => 'PermissionsPolicy', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $IsTruncated = $ListEntitiesForPolicyResponse->IsTruncated; | ||
| 46 | my $Marker = $ListEntitiesForPolicyResponse->Marker; | ||
| 47 | my $PolicyGroups = $ListEntitiesForPolicyResponse->PolicyGroups; | ||
| 48 | my $PolicyRoles = $ListEntitiesForPolicyResponse->PolicyRoles; | ||
| 49 | my $PolicyUsers = $ListEntitiesForPolicyResponse->PolicyUsers; | ||
| 50 | |||
| 51 | # Returns a L<Paws::IAM::ListEntitiesForPolicyResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/ListEntitiesForPolicy> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 EntityFilter => Str | ||
| 60 | |||
| 61 | The entity type to use for filtering the results. | ||
| 62 | |||
| 63 | For example, when C<EntityFilter> is C<Role>, only the roles that are | ||
| 64 | attached to the specified policy are returned. This parameter is | ||
| 65 | optional. If it is not included, all attached entities (users, groups, | ||
| 66 | and roles) are returned. The argument for this parameter must be one of | ||
| 67 | the valid values listed below. | ||
| 68 | |||
| 69 | Valid values are: C<"User">, C<"Role">, C<"Group">, C<"LocalManagedPolicy">, C<"AWSManagedPolicy"> | ||
| 70 | |||
| 71 | =head2 Marker => Str | ||
| 72 | |||
| 73 | Use this parameter only when paginating results and only after you | ||
| 74 | receive a response indicating that the results are truncated. Set it to | ||
| 75 | the value of the C<Marker> element in the response that you received to | ||
| 76 | indicate where the next call should start. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxItems => Int | ||
| 81 | |||
| 82 | Use this only when paginating results to indicate the maximum number of | ||
| 83 | items you want in the response. If additional items exist beyond the | ||
| 84 | maximum you specify, the C<IsTruncated> response element is C<true>. | ||
| 85 | |||
| 86 | If you do not include this parameter, the number of items defaults to | ||
| 87 | 100. Note that IAM might return fewer results, even when there are more | ||
| 88 | results available. In that case, the C<IsTruncated> response element | ||
| 89 | returns C<true>, and C<Marker> contains a value to include in the | ||
| 90 | subsequent call that tells the service where to continue from. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 PathPrefix => Str | ||
| 95 | |||
| 96 | The path prefix for filtering the results. This parameter is optional. | ||
| 97 | If it is not included, it defaults to a slash (/), listing all | ||
| 98 | entities. | ||
| 99 | |||
| 100 | This parameter allows (through its regex pattern | ||
| 101 | (http://wikipedia.org/wiki/regex)) a string of characters consisting of | ||
| 102 | either a forward slash (/) by itself or a string that must begin and | ||
| 103 | end with forward slashes. In addition, it can contain any ASCII | ||
| 104 | character from the ! (C<\u0021>) through the DEL character (C<\u007F>), | ||
| 105 | including most punctuation characters, digits, and upper and lowercased | ||
| 106 | letters. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> PolicyArn => Str | ||
| 111 | |||
| 112 | The Amazon Resource Name (ARN) of the IAM policy for which you want the | ||
| 113 | versions. | ||
| 114 | |||
| 115 | For more information about ARNs, see Amazon Resource Names (ARNs) | ||
| 116 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 117 | in the I<AWS General Reference>. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 PolicyUsageFilter => Str | ||
| 122 | |||
| 123 | The policy usage method to use for filtering the results. | ||
| 124 | |||
| 125 | To list only permissions policies, set C<PolicyUsageFilter> to | ||
| 126 | C<PermissionsPolicy>. To list only the policies used to set permissions | ||
| 127 | boundaries, set the value to C<PermissionsBoundary>. | ||
| 128 | |||
| 129 | This parameter is optional. If it is not included, all policies are | ||
| 130 | returned. | ||
| 131 | |||
| 132 | Valid values are: C<"PermissionsPolicy">, C<"PermissionsBoundary"> | ||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method ListEntitiesForPolicy in L<Paws::IAM> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |