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

Class ListPoliciesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iam.model.IamRequest
software.amazon.awssdk.services.iam.model.ListPoliciesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListPoliciesRequest extends IamRequest implements ToCopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>

  • Method Details

    • scope

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, scope will return PolicyScopeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

      See Also:

    • scopeAsString

      public final String scopeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, scope will return PolicyScopeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

      See Also:

    • onlyAttached

      public final 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.

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

    • pathPrefix

      public final 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.

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

    • policyUsageFilter

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, policyUsageFilter will return PolicyUsageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyUsageFilterAsString().

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

      See Also:

    • policyUsageFilterAsString

      public final String policyUsageFilterAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, policyUsageFilter will return PolicyUsageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyUsageFilterAsString().

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

      See Also:

    • marker

      public final 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.

      Returns:
      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

      public final 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.

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

    • toBuilder

      public ListPoliciesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>
      Specified by:
      toBuilder in class IamRequest
      Returns:
      a builder for type T

    • builder

      public static ListPoliciesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListPoliciesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.