com.amazonaws.services.identitymanagement.model.ListPoliciesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2020-2025 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;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListPoliciesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
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 an IAM 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. 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 ! (\u0021) through the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*
*/
private String pathPrefix;
/**
*
* 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.
*
*/
private String policyUsageFilter;
/**
*
* 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 String marker;
/**
*
* 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.
*
*/
private Integer maxItems;
/**
*
* 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.
*
*
* @param 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.
* @see PolicyScopeType
*/
public void setScope(String scope) {
this.scope = 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.
*
*
* @return 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.
* @see PolicyScopeType
*/
public String getScope() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyScopeType
*/
public ListPoliciesRequest withScope(String scope) {
setScope(scope);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see PolicyScopeType
*/
public void setScope(PolicyScopeType scope) {
withScope(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyScopeType
*/
public ListPoliciesRequest withScope(PolicyScopeType scope) {
this.scope = 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 an IAM user, group, or role. When OnlyAttached is false, or when the
* parameter is not included, all policies are returned.
*
*
* @param 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 void setOnlyAttached(Boolean onlyAttached) {
this.onlyAttached = 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.
*
*
* @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 an IAM user, group, or role. When OnlyAttached is false, or
* when the parameter is not included, all policies are returned.
*/
public Boolean getOnlyAttached() {
return 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 an IAM user, group, or role. When OnlyAttached is false, or when the
* parameter is not included, all policies are returned.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPoliciesRequest withOnlyAttached(Boolean onlyAttached) {
setOnlyAttached(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 an IAM user, group, or role. When OnlyAttached is false, or when the
* parameter is not included, all policies are returned.
*
*
* @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 an IAM user, group, or role. When OnlyAttached is false, or
* when the parameter is not included, all policies are returned.
*/
public Boolean isOnlyAttached() {
return this.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. 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 ! (\u0021) through the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*
*
* @param 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 ! (\u0021) through the DEL character (
* \u007F), including most punctuation characters, digits, and upper and lowercased letters.
*/
public void setPathPrefix(String pathPrefix) {
this.pathPrefix = 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 ! (\u0021) through the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*
*
* @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. 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 ! (\u0021) through the DEL character (
* \u007F), including most punctuation characters, digits, and upper and lowercased letters.
*/
public String getPathPrefix() {
return 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. 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 ! (\u0021) through the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*
*
* @param 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 ! (\u0021) through the DEL character (
* \u007F), including most punctuation characters, digits, and upper and lowercased letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPoliciesRequest withPathPrefix(String pathPrefix) {
setPathPrefix(pathPrefix);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see PolicyUsageType
*/
public void setPolicyUsageFilter(String policyUsageFilter) {
this.policyUsageFilter = 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.
*
*
* @return 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.
* @see PolicyUsageType
*/
public String getPolicyUsageFilter() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyUsageType
*/
public ListPoliciesRequest withPolicyUsageFilter(String policyUsageFilter) {
setPolicyUsageFilter(policyUsageFilter);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see PolicyUsageType
*/
public void setPolicyUsageFilter(PolicyUsageType policyUsageFilter) {
withPolicyUsageFilter(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyUsageType
*/
public ListPoliciesRequest withPolicyUsageFilter(PolicyUsageType policyUsageFilter) {
this.policyUsageFilter = policyUsageFilter.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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 setMarker(String marker) {
this.marker = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPoliciesRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setMaxItems(Integer maxItems) {
this.maxItems = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPoliciesRequest withMaxItems(Integer maxItems) {
setMaxItems(maxItems);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getScope() != null)
sb.append("Scope: ").append(getScope()).append(",");
if (getOnlyAttached() != null)
sb.append("OnlyAttached: ").append(getOnlyAttached()).append(",");
if (getPathPrefix() != null)
sb.append("PathPrefix: ").append(getPathPrefix()).append(",");
if (getPolicyUsageFilter() != null)
sb.append("PolicyUsageFilter: ").append(getPolicyUsageFilter()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getMaxItems() != null)
sb.append("MaxItems: ").append(getMaxItems());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListPoliciesRequest == false)
return false;
ListPoliciesRequest other = (ListPoliciesRequest) obj;
if (other.getScope() == null ^ this.getScope() == null)
return false;
if (other.getScope() != null && other.getScope().equals(this.getScope()) == false)
return false;
if (other.getOnlyAttached() == null ^ this.getOnlyAttached() == null)
return false;
if (other.getOnlyAttached() != null && other.getOnlyAttached().equals(this.getOnlyAttached()) == false)
return false;
if (other.getPathPrefix() == null ^ this.getPathPrefix() == null)
return false;
if (other.getPathPrefix() != null && other.getPathPrefix().equals(this.getPathPrefix()) == false)
return false;
if (other.getPolicyUsageFilter() == null ^ this.getPolicyUsageFilter() == null)
return false;
if (other.getPolicyUsageFilter() != null && other.getPolicyUsageFilter().equals(this.getPolicyUsageFilter()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getMaxItems() == null ^ this.getMaxItems() == null)
return false;
if (other.getMaxItems() != null && other.getMaxItems().equals(this.getMaxItems()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode());
hashCode = prime * hashCode + ((getOnlyAttached() == null) ? 0 : getOnlyAttached().hashCode());
hashCode = prime * hashCode + ((getPathPrefix() == null) ? 0 : getPathPrefix().hashCode());
hashCode = prime * hashCode + ((getPolicyUsageFilter() == null) ? 0 : getPolicyUsageFilter().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
return hashCode;
}
@Override
public ListPoliciesRequest clone() {
return (ListPoliciesRequest) super.clone();
}
}