list_entities_for_policy ¶

def list_entities_for_policy(
    self,
    policy_arn: "capo_iam.types.arn_type.arnType",
    *,
    config_overrides: Optional[IAMClientConfig] = None,
    entity_filter: Optional["capo_iam.types.entity_type.EntityType"] = None,
    path_prefix: Optional["capo_iam.types.path_type.pathType"] = None,
    policy_usage_filter: Optional[
        "capo_iam.types.policy_usage_type.PolicyUsageType"
    ] = None,
    marker: Optional["capo_iam.types.marker_type.markerType"] = None,
    max_items: Optional["capo_iam.types.max_items_type.maxItemsType"] = None,
) -> (
    "capo_iam.types.list_entities_for_policy_response.ListEntitiesForPolicyResponse"
):
    r"""<p>Lists all IAM users, groups, and roles that the specified managed policy is attached to.</p> <p>You can use the optional <code>EntityFilter</code> parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set <code>EntityFilter</code> to <code>Role</code>.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>

    Args:
        policy_arn: <p>The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>
        entity_filter: <p>The entity type to use for filtering the results.</p> <p>For example, when <code>EntityFilter</code> is <code>Role</code>, 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.</p>
        path_prefix: <p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) 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 ! (<code>\u0021</code>) through the DEL character (<code>\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>
        policy_usage_filter: <p>The policy usage method to use for filtering the results.</p> <p>To list only permissions policies, set <code>PolicyUsageFilter</code> to <code>PermissionsPolicy</code>. To list only the policies used to set permissions boundaries, set the value to <code>PermissionsBoundary</code>.</p> <p>This parameter is optional. If it is not included, all policies are returned. </p>
        marker: <p>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 <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>
        max_items: <p>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 <code>IsTruncated</code> response element is <code>true</code>.</p> <p>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 <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>

    Raises:
        capo_iam.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iam.types.list_entities_for_policy_request.ListEntitiesForPolicyRequest]",
    ) -> OperationResponse[
        "capo_iam.types.list_entities_for_policy_response.ListEntitiesForPolicyResponse"
    ]:
        import capo_iam._operations.aws_identity_management_v20100508.list_entities_for_policy

        output, http_response = (
            capo_iam._operations.aws_identity_management_v20100508.list_entities_for_policy.list_entities_for_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEntitiesForPolicy")
    )
    input_: capo_iam.types.list_entities_for_policy_request.ListEntitiesForPolicyRequest = {
        "policy_arn": policy_arn
    }
    if entity_filter is not None:
        input_["entity_filter"] = entity_filter
    if path_prefix is not None:
        input_["path_prefix"] = path_prefix
    if policy_usage_filter is not None:
        input_["policy_usage_filter"] = policy_usage_filter
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output