NAME

Paws::IAM::ListEntitiesForPolicy - Arguments for method ListEntitiesForPolicy on Paws::IAM

DESCRIPTION

This class represents the parameters used for calling the method ListEntitiesForPolicy on the AWS Identity and Access Management service. Use the attributes of this class as arguments to method ListEntitiesForPolicy.

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

SYNOPSIS

    my $iam = Paws->service('IAM');
    my $ListEntitiesForPolicyResponse = $iam->ListEntitiesForPolicy(
      PolicyArn         => 'MyarnType',
      EntityFilter      => 'User',                 # OPTIONAL
      Marker            => 'MymarkerType',         # OPTIONAL
      MaxItems          => 1,                      # OPTIONAL
      PathPrefix        => 'MypathType',           # OPTIONAL
      PolicyUsageFilter => 'PermissionsPolicy',    # OPTIONAL
    );
    # Results:
    my $IsTruncated  = $ListEntitiesForPolicyResponse->IsTruncated;
    my $Marker       = $ListEntitiesForPolicyResponse->Marker;
    my $PolicyGroups = $ListEntitiesForPolicyResponse->PolicyGroups;
    my $PolicyRoles  = $ListEntitiesForPolicyResponse->PolicyRoles;
    my $PolicyUsers  = $ListEntitiesForPolicyResponse->PolicyUsers;
    # Returns a L<Paws::IAM::ListEntitiesForPolicyResponse> 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/iam/ListEntitiesForPolicy>

ATTRIBUTES

EntityFilter => Str

The entity type to use for filtering the results.

For example, when "EntityFilter" is "Role", only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

Valid values are: "User", "Role", "Group", "LocalManagedPolicy", "AWSManagedPolicy"

Marker => Str

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the "Marker" element in the response that you received to indicate where the next call should start.

MaxItems => Int

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the "IsTruncated" response element is "true".

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the "IsTruncated" response element returns "true", and "Marker" contains a value to include in the subsequent call that tells the service where to continue from.

PathPrefix => Str

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ("\u0021") through the DEL character ("\u007F"), including most punctuation characters, digits, and upper and lowercased letters.

REQUIRED PolicyArn => Str

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the AWS General Reference.

PolicyUsageFilter => Str

The policy usage method to use for filtering the results.

To list only permissions policies, set "PolicyUsageFilter" to "PermissionsPolicy". To list only the policies used to set permissions boundaries, set the value to "PermissionsBoundary".

This parameter is optional. If it is not included, all policies are returned.

Valid values are: "PermissionsPolicy", "PermissionsBoundary"

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>