Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.identitymanagement.model;
 
 
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.

 
 public class ListPoliciesRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
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

 
     private String scope;

    
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.

 
     private Boolean onlyAttached;

    
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\.,\+@=_-]+)*)/

 
     private String pathPrefix;

    
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]*

 
     private String marker;

    
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

    private Integer maxItems;

    
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
    public String getScope() {
        return ;
    }
    
    
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
    public void setScope(String scope) {
        this. = 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
    public ListPoliciesRequest withScope(String scope) {
        this. = scope;
        return this;
    }

    
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
    public void setScope(PolicyScopeType scope) {
        this. = scope.toString();
    }
    
    
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
        this. = scope.toString();
        return this;
    }

    
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.

    public Boolean isOnlyAttached() {
        return ;
    }
    
    
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.

    public void setOnlyAttached(Boolean onlyAttached) {
        this. = 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.
    public ListPoliciesRequest withOnlyAttached(Boolean onlyAttached) {
        this. = onlyAttached;
        return this;
    }

    
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.

    public Boolean getOnlyAttached() {
        return ;
    }

    
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.
    public String getPathPrefix() {
        return ;
    }
    
    
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.
    public void setPathPrefix(String pathPrefix) {
        this. = 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.
    public ListPoliciesRequest withPathPrefix(String pathPrefix) {
        this. = pathPrefix;
        return this;
    }

    
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.
    public String getMarker() {
        return ;
    }
    
    
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.
    public void setMarker(String marker) {
        this. = 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.
    public ListPoliciesRequest withMarker(String marker) {
        this. = marker;
        return this;
    }

    
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.
    public Integer getMaxItems() {
        return ;
    }
    
    
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.
    public void setMaxItems(Integer maxItems) {
        this. = 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.
    public ListPoliciesRequest withMaxItems(Integer maxItems) {
        this. = maxItems;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getScope() != nullsb.append("Scope: " + getScope() + ",");
        if (isOnlyAttached() != nullsb.append("OnlyAttached: " + isOnlyAttached() + ",");
        if (getPathPrefix() != nullsb.append("PathPrefix: " + getPathPrefix() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() + ",");
        if (getMaxItems() != nullsb.append("MaxItems: " + getMaxItems() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode()); 
        hashCode = prime * hashCode + ((isOnlyAttached() == null) ? 0 : isOnlyAttached().hashCode()); 
        hashCode = prime * hashCode + ((getPathPrefix() == null) ? 0 : getPathPrefix().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof ListPoliciesRequest == falsereturn false;
        ListPoliciesRequest other = (ListPoliciesRequest)obj;
        
        if (other.getScope() == null ^ this.getScope() == nullreturn false;
        if (other.getScope() != null && other.getScope().equals(this.getScope()) == falsereturn false
        if (other.isOnlyAttached() == null ^ this.isOnlyAttached() == nullreturn false;
        if (other.isOnlyAttached() != null && other.isOnlyAttached().equals(this.isOnlyAttached()) == falsereturn false
        if (other.getPathPrefix() == null ^ this.getPathPrefix() == nullreturn false;
        if (other.getPathPrefix() != null && other.getPathPrefix().equals(this.getPathPrefix()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        if (other.getMaxItems() == null ^ this.getMaxItems() == nullreturn false;
        if (other.getMaxItems() != null && other.getMaxItems().equals(this.getMaxItems()) == falsereturn false
        return true;
    }
    
    @Override
    public ListPoliciesRequest clone() {
        
            return (ListPoliciesRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X