AWS SDK for C++  1.8.28
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::IAM::Model::ListPoliciesRequest Class Reference

#include <ListPoliciesRequest.h>

+ Inheritance diagram for Aws::IAM::Model::ListPoliciesRequest:

Public Member Functions

 ListPoliciesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const PolicyScopeTypeGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const PolicyScopeType &value)
 
void SetScope (PolicyScopeType &&value)
 
ListPoliciesRequestWithScope (const PolicyScopeType &value)
 
ListPoliciesRequestWithScope (PolicyScopeType &&value)
 
bool GetOnlyAttached () const
 
bool OnlyAttachedHasBeenSet () const
 
void SetOnlyAttached (bool value)
 
ListPoliciesRequestWithOnlyAttached (bool value)
 
const Aws::StringGetPathPrefix () const
 
bool PathPrefixHasBeenSet () const
 
void SetPathPrefix (const Aws::String &value)
 
void SetPathPrefix (Aws::String &&value)
 
void SetPathPrefix (const char *value)
 
ListPoliciesRequestWithPathPrefix (const Aws::String &value)
 
ListPoliciesRequestWithPathPrefix (Aws::String &&value)
 
ListPoliciesRequestWithPathPrefix (const char *value)
 
const PolicyUsageTypeGetPolicyUsageFilter () const
 
bool PolicyUsageFilterHasBeenSet () const
 
void SetPolicyUsageFilter (const PolicyUsageType &value)
 
void SetPolicyUsageFilter (PolicyUsageType &&value)
 
ListPoliciesRequestWithPolicyUsageFilter (const PolicyUsageType &value)
 
ListPoliciesRequestWithPolicyUsageFilter (PolicyUsageType &&value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
ListPoliciesRequestWithMarker (const Aws::String &value)
 
ListPoliciesRequestWithMarker (Aws::String &&value)
 
ListPoliciesRequestWithMarker (const char *value)
 
int GetMaxItems () const
 
bool MaxItemsHasBeenSet () const
 
void SetMaxItems (int value)
 
ListPoliciesRequestWithMaxItems (int value)
 
- Public Member Functions inherited from Aws::IAM::IAMRequest
virtual ~IAMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::IAM::IAMRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file ListPoliciesRequest.h.

Constructor & Destructor Documentation

◆ ListPoliciesRequest()

Aws::IAM::Model::ListPoliciesRequest::ListPoliciesRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::IAM::Model::ListPoliciesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetMarker()

const Aws::String& Aws::IAM::Model::ListPoliciesRequest::GetMarker ( ) const
inline

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.

Definition at line 297 of file ListPoliciesRequest.h.

◆ GetMaxItems()

int Aws::IAM::Model::ListPoliciesRequest::GetMaxItems ( ) const
inline

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.

Definition at line 366 of file ListPoliciesRequest.h.

◆ GetOnlyAttached()

bool Aws::IAM::Model::ListPoliciesRequest::GetOnlyAttached ( ) const
inline

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.

Definition at line 103 of file ListPoliciesRequest.h.

◆ GetPathPrefix()

const Aws::String& Aws::IAM::Model::ListPoliciesRequest::GetPathPrefix ( ) const
inline

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.

Definition at line 143 of file ListPoliciesRequest.h.

◆ GetPolicyUsageFilter()

const PolicyUsageType& Aws::IAM::Model::ListPoliciesRequest::GetPolicyUsageFilter ( ) const
inline

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.

Definition at line 238 of file ListPoliciesRequest.h.

◆ GetScope()

const PolicyScopeType& Aws::IAM::Model::ListPoliciesRequest::GetScope ( ) const
inline

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.

Definition at line 48 of file ListPoliciesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IAM::Model::ListPoliciesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListPoliciesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::IAM::Model::ListPoliciesRequest::MarkerHasBeenSet ( ) const
inline

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.

Definition at line 305 of file ListPoliciesRequest.h.

◆ MaxItemsHasBeenSet()

bool Aws::IAM::Model::ListPoliciesRequest::MaxItemsHasBeenSet ( ) const
inline

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.

Definition at line 378 of file ListPoliciesRequest.h.

◆ OnlyAttachedHasBeenSet()

bool Aws::IAM::Model::ListPoliciesRequest::OnlyAttachedHasBeenSet ( ) const
inline

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.

Definition at line 112 of file ListPoliciesRequest.h.

◆ PathPrefixHasBeenSet()

bool Aws::IAM::Model::ListPoliciesRequest::PathPrefixHasBeenSet ( ) const
inline

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.

Definition at line 155 of file ListPoliciesRequest.h.

◆ PolicyUsageFilterHasBeenSet()

bool Aws::IAM::Model::ListPoliciesRequest::PolicyUsageFilterHasBeenSet ( ) const
inline

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.

Definition at line 248 of file ListPoliciesRequest.h.

◆ ScopeHasBeenSet()

bool Aws::IAM::Model::ListPoliciesRequest::ScopeHasBeenSet ( ) const
inline

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.

Definition at line 57 of file ListPoliciesRequest.h.

◆ SerializePayload()

Aws::String Aws::IAM::Model::ListPoliciesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMarker() [1/3]

void Aws::IAM::Model::ListPoliciesRequest::SetMarker ( const Aws::String value)
inline

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.

Definition at line 313 of file ListPoliciesRequest.h.

◆ SetMarker() [2/3]

void Aws::IAM::Model::ListPoliciesRequest::SetMarker ( Aws::String &&  value)
inline

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.

Definition at line 321 of file ListPoliciesRequest.h.

◆ SetMarker() [3/3]

void Aws::IAM::Model::ListPoliciesRequest::SetMarker ( const char *  value)
inline

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.

Definition at line 329 of file ListPoliciesRequest.h.

◆ SetMaxItems()

void Aws::IAM::Model::ListPoliciesRequest::SetMaxItems ( int  value)
inline

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.

Definition at line 390 of file ListPoliciesRequest.h.

◆ SetOnlyAttached()

void Aws::IAM::Model::ListPoliciesRequest::SetOnlyAttached ( bool  value)
inline

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.

Definition at line 121 of file ListPoliciesRequest.h.

◆ SetPathPrefix() [1/3]

void Aws::IAM::Model::ListPoliciesRequest::SetPathPrefix ( const Aws::String value)
inline

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.

Definition at line 167 of file ListPoliciesRequest.h.

◆ SetPathPrefix() [2/3]

void Aws::IAM::Model::ListPoliciesRequest::SetPathPrefix ( Aws::String &&  value)
inline

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.

Definition at line 179 of file ListPoliciesRequest.h.

◆ SetPathPrefix() [3/3]

void Aws::IAM::Model::ListPoliciesRequest::SetPathPrefix ( const char *  value)
inline

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.

Definition at line 191 of file ListPoliciesRequest.h.

◆ SetPolicyUsageFilter() [1/2]

void Aws::IAM::Model::ListPoliciesRequest::SetPolicyUsageFilter ( const PolicyUsageType value)
inline

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.

Definition at line 258 of file ListPoliciesRequest.h.

◆ SetPolicyUsageFilter() [2/2]

void Aws::IAM::Model::ListPoliciesRequest::SetPolicyUsageFilter ( PolicyUsageType &&  value)
inline

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.

Definition at line 268 of file ListPoliciesRequest.h.

◆ SetScope() [1/2]

void Aws::IAM::Model::ListPoliciesRequest::SetScope ( const PolicyScopeType value)
inline

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.

Definition at line 66 of file ListPoliciesRequest.h.

◆ SetScope() [2/2]

void Aws::IAM::Model::ListPoliciesRequest::SetScope ( PolicyScopeType &&  value)
inline

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.

Definition at line 75 of file ListPoliciesRequest.h.

◆ WithMarker() [1/3]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithMarker ( const Aws::String value)
inline

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.

Definition at line 337 of file ListPoliciesRequest.h.

◆ WithMarker() [2/3]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithMarker ( Aws::String &&  value)
inline

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.

Definition at line 345 of file ListPoliciesRequest.h.

◆ WithMarker() [3/3]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithMarker ( const char *  value)
inline

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.

Definition at line 353 of file ListPoliciesRequest.h.

◆ WithMaxItems()

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithMaxItems ( int  value)
inline

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.

Definition at line 402 of file ListPoliciesRequest.h.

◆ WithOnlyAttached()

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithOnlyAttached ( bool  value)
inline

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.

Definition at line 130 of file ListPoliciesRequest.h.

◆ WithPathPrefix() [1/3]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithPathPrefix ( const Aws::String value)
inline

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.

Definition at line 203 of file ListPoliciesRequest.h.

◆ WithPathPrefix() [2/3]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithPathPrefix ( Aws::String &&  value)
inline

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.

Definition at line 215 of file ListPoliciesRequest.h.

◆ WithPathPrefix() [3/3]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithPathPrefix ( const char *  value)
inline

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.

Definition at line 227 of file ListPoliciesRequest.h.

◆ WithPolicyUsageFilter() [1/2]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithPolicyUsageFilter ( const PolicyUsageType value)
inline

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.

Definition at line 278 of file ListPoliciesRequest.h.

◆ WithPolicyUsageFilter() [2/2]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithPolicyUsageFilter ( PolicyUsageType &&  value)
inline

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.

Definition at line 288 of file ListPoliciesRequest.h.

◆ WithScope() [1/2]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithScope ( const PolicyScopeType value)
inline

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.

Definition at line 84 of file ListPoliciesRequest.h.

◆ WithScope() [2/2]

ListPoliciesRequest& Aws::IAM::Model::ListPoliciesRequest::WithScope ( PolicyScopeType &&  value)
inline

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.

Definition at line 93 of file ListPoliciesRequest.h.


The documentation for this class was generated from the following file: