Class ListEntitiesForPolicyRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.identitymanagement.model.ListEntitiesForPolicyRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListEntitiesForPolicyRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListEntitiesForPolicyRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListEntitiesForPolicyRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getEntityFilter()
The entity type to use for filtering the results.String
getMarker()
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.Integer
getMaxItems()
Use this only when paginating results to indicate the maximum number of items you want in the response.String
getPathPrefix()
The path prefix for filtering the results.String
getPolicyArn()
The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.int
hashCode()
void
setEntityFilter(EntityType entityFilter)
The entity type to use for filtering the results.void
setEntityFilter(String entityFilter)
The entity type to use for filtering the results.void
setMarker(String marker)
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.void
setMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number of items you want in the response.void
setPathPrefix(String pathPrefix)
The path prefix for filtering the results.void
setPolicyArn(String policyArn)
The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.String
toString()
Returns a string representation of this object; useful for testing and debugging.ListEntitiesForPolicyRequest
withEntityFilter(EntityType entityFilter)
The entity type to use for filtering the results.ListEntitiesForPolicyRequest
withEntityFilter(String entityFilter)
The entity type to use for filtering the results.ListEntitiesForPolicyRequest
withMarker(String marker)
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.ListEntitiesForPolicyRequest
withMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number of items you want in the response.ListEntitiesForPolicyRequest
withPathPrefix(String pathPrefix)
The path prefix for filtering the results.ListEntitiesForPolicyRequest
withPolicyArn(String policyArn)
The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setPolicyArn
public void setPolicyArn(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) and AWS Service Namespaces in the AWS 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) and AWS Service Namespaces in the AWS General Reference.
-
getPolicyArn
public String getPolicyArn()
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) and AWS Service Namespaces in the AWS 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) and AWS Service Namespaces in the AWS General Reference.
-
withPolicyArn
public ListEntitiesForPolicyRequest withPolicyArn(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) and AWS Service Namespaces in the AWS 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) and AWS Service Namespaces in the AWS General Reference.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEntityFilter
public void setEntityFilter(String 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.- See Also:
EntityType
-
getEntityFilter
public String getEntityFilter()
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:
- 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. - See Also:
EntityType
-
withEntityFilter
public ListEntitiesForPolicyRequest withEntityFilter(String 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:
EntityType
-
setEntityFilter
public void setEntityFilter(EntityType 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.- See Also:
EntityType
-
withEntityFilter
public ListEntitiesForPolicyRequest withEntityFilter(EntityType 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:
EntityType
-
setPathPrefix
public void setPathPrefix(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.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru 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.The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.
-
getPathPrefix
public String getPathPrefix()
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru 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.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.
-
withPathPrefix
public ListEntitiesForPolicyRequest withPathPrefix(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.
The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru 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.The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru 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.
-
setMarker
public void setMarker(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 theMarker
element in the response that you received to indicate where the next call should start.
-
getMarker
public String getMarker()
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.
-
withMarker
public ListEntitiesForPolicyRequest withMarker(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 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.
-
setMaxItems
public void setMaxItems(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 istrue
.This parameter is optional. If you do not include it, it 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
.This parameter is optional. If you do not include it, it 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.
-
getMaxItems
public Integer getMaxItems()
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
.This parameter is optional. If you do not include it, it 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:
- 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
.This parameter is optional. If you do not include it, it 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.
-
withMaxItems
public ListEntitiesForPolicyRequest withMaxItems(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 istrue
.This parameter is optional. If you do not include it, it 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
.This parameter is optional. If you do not include it, it 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.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ListEntitiesForPolicyRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-