ListEntitiesForPolicyRequest (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.ListEntitiesForPolicyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListEntitiesForPolicyRequest.Builder,ListEntitiesForPolicyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListEntitiesForPolicyRequest
extends IamRequest
implements ToCopyableBuilder<ListEntitiesForPolicyRequest.Builder,ListEntitiesForPolicyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListEntitiesForPolicyRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListEntitiesForPolicyRequest.Builder`	`builder()`
`EntityType`	`entityFilter()` The entity type to use for filtering the results.
`String`	`entityFilterAsString()` The entity type to use for filtering the results.
`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.
`String`	`pathPrefix()` The path prefix for filtering the results.
`String`	`policyArn()` The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.
`PolicyUsageType`	`policyUsageFilter()` The policy usage method to use for filtering the results.
`String`	`policyUsageFilterAsString()` The policy usage method to use for filtering the results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListEntitiesForPolicyRequest.Builder>`	`serializableBuilderClass()`
`ListEntitiesForPolicyRequest.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
  - policyArn
```
public final 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.
    
    Returns:
    
    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.
  - entityFilter
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, entityFilter will return EntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from entityFilterAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    EntityType
  - entityFilterAsString
```
public final String entityFilterAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, entityFilter will return EntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from entityFilterAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    EntityType
  - 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 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:
    
    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.
  - 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:
    
    PolicyUsageType
  - 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:
    
    PolicyUsageType
  - 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 ListEntitiesForPolicyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListEntitiesForPolicyRequest.Builder,ListEntitiesForPolicyRequest>
    
    Specified by:
    
    toBuilder in class IamRequest
  - builder
```
public static ListEntitiesForPolicyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListEntitiesForPolicyRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListEntitiesForPolicyRequest

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

policyArn

entityFilter

entityFilterAsString

pathPrefix

policyUsageFilter

policyUsageFilterAsString

marker

maxItems

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields