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

#include <ListRolesRequest.h>

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

Public Member Functions

 ListRolesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetPathPrefix () const
 
bool PathPrefixHasBeenSet () const
 
void SetPathPrefix (const Aws::String &value)
 
void SetPathPrefix (Aws::String &&value)
 
void SetPathPrefix (const char *value)
 
ListRolesRequestWithPathPrefix (const Aws::String &value)
 
ListRolesRequestWithPathPrefix (Aws::String &&value)
 
ListRolesRequestWithPathPrefix (const char *value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
ListRolesRequestWithMarker (const Aws::String &value)
 
ListRolesRequestWithMarker (Aws::String &&value)
 
ListRolesRequestWithMarker (const char *value)
 
int GetMaxItems () const
 
bool MaxItemsHasBeenSet () const
 
void SetMaxItems (int value)
 
ListRolesRequestWithMaxItems (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 21 of file ListRolesRequest.h.

Constructor & Destructor Documentation

◆ ListRolesRequest()

Aws::IAM::Model::ListRolesRequest::ListRolesRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::IAM::Model::ListRolesRequest::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::ListRolesRequest::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 166 of file ListRolesRequest.h.

◆ GetMaxItems()

int Aws::IAM::Model::ListRolesRequest::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 235 of file ListRolesRequest.h.

◆ GetPathPrefix()

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 52 of file ListRolesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListRolesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::IAM::Model::ListRolesRequest::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 174 of file ListRolesRequest.h.

◆ MaxItemsHasBeenSet()

bool Aws::IAM::Model::ListRolesRequest::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 247 of file ListRolesRequest.h.

◆ PathPrefixHasBeenSet()

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 67 of file ListRolesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMarker() [1/3]

void Aws::IAM::Model::ListRolesRequest::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 182 of file ListRolesRequest.h.

◆ SetMarker() [2/3]

void Aws::IAM::Model::ListRolesRequest::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 190 of file ListRolesRequest.h.

◆ SetMarker() [3/3]

void Aws::IAM::Model::ListRolesRequest::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 198 of file ListRolesRequest.h.

◆ SetMaxItems()

void Aws::IAM::Model::ListRolesRequest::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 259 of file ListRolesRequest.h.

◆ SetPathPrefix() [1/3]

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 82 of file ListRolesRequest.h.

◆ SetPathPrefix() [2/3]

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 97 of file ListRolesRequest.h.

◆ SetPathPrefix() [3/3]

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 112 of file ListRolesRequest.h.

◆ WithMarker() [1/3]

ListRolesRequest& Aws::IAM::Model::ListRolesRequest::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 206 of file ListRolesRequest.h.

◆ WithMarker() [2/3]

ListRolesRequest& Aws::IAM::Model::ListRolesRequest::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 214 of file ListRolesRequest.h.

◆ WithMarker() [3/3]

ListRolesRequest& Aws::IAM::Model::ListRolesRequest::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 222 of file ListRolesRequest.h.

◆ WithMaxItems()

ListRolesRequest& Aws::IAM::Model::ListRolesRequest::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 271 of file ListRolesRequest.h.

◆ WithPathPrefix() [1/3]

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 127 of file ListRolesRequest.h.

◆ WithPathPrefix() [2/3]

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 142 of file ListRolesRequest.h.

◆ WithPathPrefix() [3/3]

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

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. 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 157 of file ListRolesRequest.h.


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