@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
ListPoliciesRequest() |
| Modifier and Type | Method and Description |
|---|---|
ListPoliciesRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
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.
|
Boolean |
getOnlyAttached()
A flag to filter the results to only the attached policies.
|
String |
getPathPrefix()
The path prefix for filtering the results.
|
String |
getPolicyUsageFilter()
The policy usage method to use for filtering the results.
|
String |
getScope()
The scope to use for filtering the results.
|
int |
hashCode() |
Boolean |
isOnlyAttached()
A flag to filter the results to only the attached policies.
|
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 |
setOnlyAttached(Boolean onlyAttached)
A flag to filter the results to only the attached policies.
|
void |
setPathPrefix(String pathPrefix)
The path prefix for filtering the results.
|
void |
setPolicyUsageFilter(PolicyUsageType policyUsageFilter)
The policy usage method to use for filtering the results.
|
void |
setPolicyUsageFilter(String policyUsageFilter)
The policy usage method to use for filtering the results.
|
void |
setScope(PolicyScopeType scope)
The scope to use for filtering the results.
|
void |
setScope(String scope)
The scope to use for filtering the results.
|
String |
toString()
Returns a string representation of this object.
|
ListPoliciesRequest |
withMarker(String marker)
Use this parameter only when paginating results and only after you receive a response indicating that the results
are truncated.
|
ListPoliciesRequest |
withMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number of items you want in the response.
|
ListPoliciesRequest |
withOnlyAttached(Boolean onlyAttached)
A flag to filter the results to only the attached policies.
|
ListPoliciesRequest |
withPathPrefix(String pathPrefix)
The path prefix for filtering the results.
|
ListPoliciesRequest |
withPolicyUsageFilter(PolicyUsageType policyUsageFilter)
The policy usage method to use for filtering the results.
|
ListPoliciesRequest |
withPolicyUsageFilter(String policyUsageFilter)
The policy usage method to use for filtering the results.
|
ListPoliciesRequest |
withScope(PolicyScopeType scope)
The scope to use for filtering the results.
|
ListPoliciesRequest |
withScope(String scope)
The scope to use for filtering the results.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setScope(String scope)
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
customer managed policies in your Amazon Web Services 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.
scope - The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list
only the customer managed policies in your Amazon Web Services 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.
PolicyScopeTypepublic String getScope()
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
customer managed policies in your Amazon Web Services 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.
To list only Amazon Web Services managed policies, set Scope to AWS. To list
only the customer managed policies in your Amazon Web Services 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.
PolicyScopeTypepublic ListPoliciesRequest withScope(String scope)
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
customer managed policies in your Amazon Web Services 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.
scope - The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list
only the customer managed policies in your Amazon Web Services 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.
PolicyScopeTypepublic void setScope(PolicyScopeType scope)
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
customer managed policies in your Amazon Web Services 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.
scope - The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list
only the customer managed policies in your Amazon Web Services 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.
PolicyScopeTypepublic ListPoliciesRequest withScope(PolicyScopeType scope)
The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list only the
customer managed policies in your Amazon Web Services 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.
scope - The scope to use for filtering the results.
To list only Amazon Web Services managed policies, set Scope to AWS. To list
only the customer managed policies in your Amazon Web Services 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.
PolicyScopeTypepublic void setOnlyAttached(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.
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.
public Boolean getOnlyAttached()
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.
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.
public ListPoliciesRequest withOnlyAttached(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.
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.
public Boolean isOnlyAttached()
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.
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.
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 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.
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.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 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.
!) through the DEL character (
), including most punctuation characters, digits, and upper and lowercased letters.public ListPoliciesRequest 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 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.
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.public void setPolicyUsageFilter(String 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.
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.
PolicyUsageTypepublic String getPolicyUsageFilter()
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.
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.
PolicyUsageTypepublic ListPoliciesRequest withPolicyUsageFilter(String 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.
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.
PolicyUsageTypepublic void setPolicyUsageFilter(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.
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.
PolicyUsageTypepublic ListPoliciesRequest withPolicyUsageFilter(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.
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.
PolicyUsageTypepublic 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.
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 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 ListPoliciesRequest 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.
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(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.
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.
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 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.
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.
public ListPoliciesRequest 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 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.
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.
public String toString()
toString in class ObjectObject.toString()public ListPoliciesRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()