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

Interface ListPoliciesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>, IamRequest.Builder, SdkBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListPoliciesRequest
public static interface ListPoliciesRequest.Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>

  • Method Details

    • scope

      ListPoliciesRequest.Builder scope(String scope)

      The scope to use for filtering the results.

      To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

      This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

      Parameters:
      scope - The scope to use for filtering the results.

      To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

      This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

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

    • scope

      ListPoliciesRequest.Builder scope(PolicyScopeType scope)

      The scope to use for filtering the results.

      To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

      This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

      Parameters:
      scope - The scope to use for filtering the results.

      To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

      This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

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

    • onlyAttached

      ListPoliciesRequest.Builder onlyAttached(Boolean onlyAttached)

      A flag to filter the results to only the attached policies.

      When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

      Parameters:
      onlyAttached - A flag to filter the results to only the attached policies.

      When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

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

    • pathPrefix

      ListPoliciesRequest.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 policies. 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 policies. 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

      ListPoliciesRequest.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:

    • policyUsageFilter

      ListPoliciesRequest.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:

    • marker

      ListPoliciesRequest.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

      ListPoliciesRequest.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.

    • overrideConfiguration

      ListPoliciesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListPoliciesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.