You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IAM::Types::ListEntitiesForPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListEntitiesForPolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  policy_arn: "arnType", # required
  entity_filter: "User", # accepts User, Role, Group, LocalManagedPolicy, AWSManagedPolicy
  path_prefix: "pathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
  marker: "markerType",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#entity_filterString

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.

Possible values:

  • User
  • Role
  • Group
  • LocalManagedPolicy
  • AWSManagedPolicy

Returns:

  • (String)

    The entity type to use for filtering the results.

#markerString

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.

Returns:

  • (String)

    Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.

#max_itemsInteger

(Optional) 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, it 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.

Returns:

  • (Integer)

    (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response.

#path_prefixString

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 (per its regex pattern) 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.

Returns:

  • (String)

    The path prefix for filtering the results.

#policy_arnString

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) and AWS Service Namespaces in the AWS General Reference.

Returns:

  • (String)

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

#policy_usage_filterString

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.

Possible values:

  • PermissionsPolicy
  • PermissionsBoundary

Returns:

  • (String)

    The policy usage method to use for filtering the results.