com.amazonaws.services.identitymanagement.model

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

Container for the parameters to the ListPolicies operation.

Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached , Scope , and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local . To list only AWS managed policies, set Scope to AWS .

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

See Also:

AmazonIdentityManagement.listPolicies(ListPoliciesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListPoliciesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListPoliciesRequest	clone()
boolean	equals(Object obj)
String	getMarker() Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Integer	getMaxItems() Use this parameter only when paginating results to indicate the maximum number of policies 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 in a subsequent request after you've received a response where the results are truncated.
void	setMaxItems(Integer maxItems) Use this parameter only when paginating results to indicate the maximum number of policies 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 in a subsequent request after you've received a response where the results are truncated.
ListPoliciesRequest	withMaxItems(Integer maxItems) Use this parameter only when paginating results to indicate the maximum number of policies 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, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListPoliciesRequest

public ListPoliciesRequest()

Method Detail

getScope

public String getScope()

The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

Constraints:
Allowed Values: All, AWS, Local

Returns:

The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

See Also:

PolicyScopeType

setScope

public void setScope(String scope)

The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

Constraints:
Allowed Values: All, AWS, Local

Parameters:

scope - The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

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 to AWS. To list only the customer managed policies in your AWS 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: All, AWS, Local

Parameters:

scope - The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

Returns:

A reference to this updated 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 to AWS. To list only the customer managed policies in your AWS 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.

Constraints:
Allowed Values: All, AWS, Local

Parameters:

scope - The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

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 to AWS. To list only the customer managed policies in your AWS 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: All, AWS, Local

Parameters:

scope - The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PolicyScopeType

isOnlyAttached

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 a user, group, or role. When OnlyAttached is false, 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 is true, the returned list contains only the policies that are attached to a user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

setOnlyAttached

public 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 a user, group, or role. When OnlyAttached is false, 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 is true, the returned list contains only the policies that are attached to a user, group, or role. When OnlyAttached is false, 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 is true, the returned list contains only the policies that are attached to a user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 a user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getOnlyAttached

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 a user, group, or role. When OnlyAttached is false, 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 is true, the returned list contains only the policies that are attached to a user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

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.

Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/

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.

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.

Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/

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.

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Returns:

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

setMarker

public void setMarker(String marker)

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Parameters:

marker - Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

withMarker

public ListPoliciesRequest withMarker(String marker)

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Parameters:

marker - Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxItems

public Integer getMaxItems()

Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies 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.

Constraints:
Range: 1 - 1000

Returns:

Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies 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.

setMaxItems

public void setMaxItems(Integer maxItems)

Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies 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.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies 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.

withMaxItems

public ListPoliciesRequest withMaxItems(Integer maxItems)

Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this parameter only when paginating results to indicate the maximum number of policies you want in the response. If there are additional policies 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.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ListPoliciesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest