ListPoliciesRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class ListPoliciesRequest
extends IamRequest
implements ToCopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListPoliciesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListPoliciesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListPoliciesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`marker()` Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
`Integer`	`maxItems()` Use this only when paginating results to indicate the maximum number of items you want in the response.
`Boolean`	`onlyAttached()` A flag to filter the results to only the attached policies.
`String`	`pathPrefix()` The path prefix for filtering the results.
`PolicyUsageType`	`policyUsageFilter()` The policy usage method to use for filtering the results.
`String`	`policyUsageFilterAsString()` The policy usage method to use for filtering the results.
`PolicyScopeType`	`scope()` The scope to use for filtering the results.
`String`	`scopeAsString()` The scope to use for filtering the results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListPoliciesRequest.Builder>`	`serializableBuilderClass()`
`ListPoliciesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - scope
```
public PolicyScopeType scope()
```
    The scope to use for filtering the results.
    
    To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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 AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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:
    
    PolicyScopeType
  - scopeAsString
```
public String scopeAsString()
```
    The scope to use for filtering the results.
    
    To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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 AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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:
    
    PolicyScopeType
  - onlyAttached
```
public 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 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 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:
    
    PolicyUsageType
  - policyUsageFilterAsString
```
public 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:
    
    PolicyUsageType
  - marker
```
public 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 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListPoliciesRequest.Builder,ListPoliciesRequest>
    
    Specified by:
    
    toBuilder in class IamRequest
  - builder
```
public static ListPoliciesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListPoliciesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListPoliciesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

scope

scopeAsString

onlyAttached

pathPrefix

policyUsageFilter

policyUsageFilterAsString

marker

maxItems

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields