Class ListPoliciesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.identitymanagement.model.ListPoliciesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListPoliciesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListPoliciesRequest
clone()
Creates a shallow clone of this request.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
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
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; useful for testing and debugging.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
withScope(PolicyScopeType scope)
The scope to use for filtering the results.ListPoliciesRequest
withScope(String scope)
The scope to use for filtering the results.-
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
-
setScope
public void setScope(String scope)
The scope to use for filtering the results.
To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Parameters:
scope
- The scope to use for filtering the results.To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- See Also:
PolicyScopeType
-
getScope
public String getScope()
The scope to use for filtering the results.
To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Returns:
- The scope to use for filtering the results.
To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned. - See Also:
PolicyScopeType
-
withScope
public ListPoliciesRequest withScope(String scope)
The scope to use for filtering the results.
To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Parameters:
scope
- The scope to use for filtering the results.To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PolicyScopeType
-
setScope
public void setScope(PolicyScopeType scope)
The scope to use for filtering the results.
To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Parameters:
scope
- The scope to use for filtering the results.To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- See Also:
PolicyScopeType
-
withScope
public ListPoliciesRequest withScope(PolicyScopeType scope)
The scope to use for filtering the results.
To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Parameters:
scope
- The scope to use for filtering the results.To list only AWS managed policies, set
Scope
toAWS
. To list only the customer managed policies in your AWS account, setScope
toLocal
.This parameter is optional. If it is not included, or if it is set to
All
, all policies are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PolicyScopeType
-
setOnlyAttached
public void setOnlyAttached(Boolean onlyAttached)
A flag to filter the results to only the attached policies.
When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.- Parameters:
onlyAttached
- A flag to filter the results to only the attached policies.When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.
-
getOnlyAttached
public Boolean getOnlyAttached()
A flag to filter the results to only the attached policies.
When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.- Returns:
- A flag to filter the results to only the attached policies.
When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.
-
withOnlyAttached
public ListPoliciesRequest withOnlyAttached(Boolean onlyAttached)
A flag to filter the results to only the attached policies.
When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.- Parameters:
onlyAttached
- A flag to filter the results to only the attached policies.When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isOnlyAttached
public Boolean isOnlyAttached()
A flag to filter the results to only the attached policies.
When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.- Returns:
- A flag to filter the results to only the attached policies.
When
OnlyAttached
istrue
, the returned list contains only the policies that are attached to an IAM user, group, or role. WhenOnlyAttached
isfalse
, or when the parameter is not included, all policies are returned.
-
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 policies. 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 policies. 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 policies. 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 policies. 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 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. 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 policies. 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 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.- 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 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 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 ListPoliciesRequest 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()
-
-