Package software.amazon.awssdk.services.iam.model

Interface ListEntitiesForPolicyRequest.Builder

    • Method Detail

      • policyArn

        ListEntitiesForPolicyRequest.Builder policyArn​(String policyArn)

        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) in the Amazon Web Services General Reference.

        Parameters:
        policyArn - 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) in the Amazon Web Services General Reference.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entityFilter

        ListEntitiesForPolicyRequest.Builder entityFilter​(String entityFilter)

        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.

        Parameters:
        entityFilter - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EntityType, EntityType

      • entityFilter

        ListEntitiesForPolicyRequest.Builder entityFilter​(EntityType entityFilter)

        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.

        Parameters:
        entityFilter - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EntityType, EntityType

      • pathPrefix

        ListEntitiesForPolicyRequest.Builder pathPrefix​(String pathPrefix)

        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) 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 ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

        Parameters:
        pathPrefix - 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) 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 ! ( !) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • policyUsageFilter

        ListEntitiesForPolicyRequest.Builder policyUsageFilter​(String policyUsageFilter)

        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.

        Parameters:
        policyUsageFilter - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PolicyUsageType, PolicyUsageType

      • policyUsageFilter

        ListEntitiesForPolicyRequest.Builder policyUsageFilter​(PolicyUsageType policyUsageFilter)

        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.

        Parameters:
        policyUsageFilter - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PolicyUsageType, PolicyUsageType

      • marker

        ListEntitiesForPolicyRequest.Builder marker​(String marker)

        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.

        Parameters:
        marker - 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:
        Returns a reference to this object so that method calls can be chained together.

      • maxItems

        ListEntitiesForPolicyRequest.Builder maxItems​(Integer maxItems)

        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.

        Parameters:
        maxItems - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.