Interface ListEntitiesForPolicyRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListEntitiesForPolicyRequest.Builder,
,ListEntitiesForPolicyRequest> IamRequest.Builder
,SdkBuilder<ListEntitiesForPolicyRequest.Builder,
,ListEntitiesForPolicyRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListEntitiesForPolicyRequest
-
Method Summary
Modifier and TypeMethodDescriptionentityFilter
(String entityFilter) The entity type to use for filtering the results.entityFilter
(EntityType entityFilter) The entity type to use for filtering the results.Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.Use this only when paginating results to indicate the maximum number of items you want in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.pathPrefix
(String pathPrefix) The path prefix for filtering the results.The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.policyUsageFilter
(String policyUsageFilter) The policy usage method to use for filtering the results.policyUsageFilter
(PolicyUsageType policyUsageFilter) The policy usage method to use for filtering the results.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iam.model.IamRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The entity type to use for filtering the results.
For example, when
EntityFilter
isRole
, 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
isRole
, 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:
-
entityFilter
The entity type to use for filtering the results.
For example, when
EntityFilter
isRole
, 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
isRole
, 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:
-
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
The policy usage method to use for filtering the results.
To list only permissions policies, set
PolicyUsageFilter
toPermissionsPolicy
. To list only the policies used to set permissions boundaries, set the value toPermissionsBoundary
.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
toPermissionsPolicy
. To list only the policies used to set permissions boundaries, set the value toPermissionsBoundary
.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
The policy usage method to use for filtering the results.
To list only permissions policies, set
PolicyUsageFilter
toPermissionsPolicy
. To list only the policies used to set permissions boundaries, set the value toPermissionsBoundary
.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
toPermissionsPolicy
. To list only the policies used to set permissions boundaries, set the value toPermissionsBoundary
.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
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 theMarker
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
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 istrue
.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 returnstrue
, andMarker
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, theIsTruncated
response element istrue
.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 returnstrue
, andMarker
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
ListEntitiesForPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListEntitiesForPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-