public class ListEntitiesForPolicyRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
entityFilter
The entity type to use for filtering the results.
|
private java.lang.String |
marker
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
private java.lang.Integer |
maxItems
Use this only when paginating results to indicate the maximum number of
items you want in the response.
|
private java.lang.String |
pathPrefix
The path prefix for filtering the results.
|
private java.lang.String |
policyArn
The Amazon Resource Name (ARN) of the IAM policy for which you want the
versions.
|
NOOP
Constructor and Description |
---|
ListEntitiesForPolicyRequest() |
Modifier and Type | Method and Description |
---|---|
ListEntitiesForPolicyRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getEntityFilter()
The entity type to use for filtering the results.
|
java.lang.String |
getMarker()
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
java.lang.Integer |
getMaxItems()
Use this only when paginating results to indicate the maximum number of
items you want in the response.
|
java.lang.String |
getPathPrefix()
The path prefix for filtering the results.
|
java.lang.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(java.lang.String entityFilter)
The entity type to use for filtering the results.
|
void |
setMarker(java.lang.String marker)
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
void |
setMaxItems(java.lang.Integer maxItems)
Use this only when paginating results to indicate the maximum number of
items you want in the response.
|
void |
setPathPrefix(java.lang.String pathPrefix)
The path prefix for filtering the results.
|
void |
setPolicyArn(java.lang.String policyArn)
The Amazon Resource Name (ARN) of the IAM policy for which you want the
versions.
|
java.lang.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(java.lang.String entityFilter)
The entity type to use for filtering the results.
|
ListEntitiesForPolicyRequest |
withMarker(java.lang.String marker)
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
ListEntitiesForPolicyRequest |
withMaxItems(java.lang.Integer maxItems)
Use this only when paginating results to indicate the maximum number of
items you want in the response.
|
ListEntitiesForPolicyRequest |
withPathPrefix(java.lang.String pathPrefix)
The path prefix for filtering the results.
|
ListEntitiesForPolicyRequest |
withPolicyArn(java.lang.String policyArn)
The Amazon Resource Name (ARN) of the IAM policy for which you want the
versions.
|
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
private java.lang.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.
private java.lang.String 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.
private java.lang.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.
private java.lang.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.
private java.lang.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
.
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 returns true
and Marker
contains a
value to include in the subsequent call that tells the service where to
continue from.
public void setPolicyArn(java.lang.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.
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.
public java.lang.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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
public ListEntitiesForPolicyRequest withPolicyArn(java.lang.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.
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.
public void setEntityFilter(java.lang.String 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.
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.
EntityType
public java.lang.String getEntityFilter()
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.
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.
EntityType
public ListEntitiesForPolicyRequest withEntityFilter(java.lang.String 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.
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.
EntityType
public void setEntityFilter(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.
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.
EntityType
public ListEntitiesForPolicyRequest withEntityFilter(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.
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.
EntityType
public void setPathPrefix(java.lang.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.
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.
public java.lang.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.
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.
public ListEntitiesForPolicyRequest withPathPrefix(java.lang.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.
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.
public void setMarker(java.lang.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.
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.public java.lang.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.
Marker
element in the
response that you received to indicate where the next call should
start.public ListEntitiesForPolicyRequest withMarker(java.lang.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.
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.public void setMaxItems(java.lang.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
.
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 returns true
and Marker
contains a
value to include in the subsequent call that tells the service where to
continue from.
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
.
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 returns
true
and Marker
contains a value to
include in the subsequent call that tells the service where to
continue from.
public java.lang.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 is
true
.
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 returns true
and Marker
contains a
value to include in the subsequent call that tells the service where to
continue from.
IsTruncated
response element is true
.
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 returns
true
and Marker
contains a value to
include in the subsequent call that tells the service where to
continue from.
public ListEntitiesForPolicyRequest withMaxItems(java.lang.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
.
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 returns true
and Marker
contains a
value to include in the subsequent call that tells the service where to
continue from.
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
.
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 returns
true
and Marker
contains a value to
include in the subsequent call that tells the service where to
continue from.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ListEntitiesForPolicyRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()