AWS SDK for C++  1.9.42
AWS SDK for C++
Public Member Functions | List of all members
Aws::Organizations::Model::ListChildrenRequest Class Reference

#include <ListChildrenRequest.h>

+ Inheritance diagram for Aws::Organizations::Model::ListChildrenRequest:

Public Member Functions

 ListChildrenRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetParentId () const
 
bool ParentIdHasBeenSet () const
 
void SetParentId (const Aws::String &value)
 
void SetParentId (Aws::String &&value)
 
void SetParentId (const char *value)
 
ListChildrenRequestWithParentId (const Aws::String &value)
 
ListChildrenRequestWithParentId (Aws::String &&value)
 
ListChildrenRequestWithParentId (const char *value)
 
const ChildTypeGetChildType () const
 
bool ChildTypeHasBeenSet () const
 
void SetChildType (const ChildType &value)
 
void SetChildType (ChildType &&value)
 
ListChildrenRequestWithChildType (const ChildType &value)
 
ListChildrenRequestWithChildType (ChildType &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListChildrenRequestWithNextToken (const Aws::String &value)
 
ListChildrenRequestWithNextToken (Aws::String &&value)
 
ListChildrenRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListChildrenRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::Organizations::OrganizationsRequest
virtual ~OrganizationsRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file ListChildrenRequest.h.

Constructor & Destructor Documentation

◆ ListChildrenRequest()

Aws::Organizations::Model::ListChildrenRequest::ListChildrenRequest ( )

Member Function Documentation

◆ ChildTypeHasBeenSet()

bool Aws::Organizations::Model::ListChildrenRequest::ChildTypeHasBeenSet ( ) const
inline

Filters the output to include only the specified child type.

Definition at line 143 of file ListChildrenRequest.h.

◆ GetChildType()

const ChildType& Aws::Organizations::Model::ListChildrenRequest::GetChildType ( ) const
inline

Filters the output to include only the specified child type.

Definition at line 138 of file ListChildrenRequest.h.

◆ GetMaxResults()

int Aws::Organizations::Model::ListChildrenRequest::GetMaxResults ( ) const
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 250 of file ListChildrenRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Organizations::Model::ListChildrenRequest::GetNextToken ( ) const
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 173 of file ListChildrenRequest.h.

◆ GetParentId()

const Aws::String& Aws::Organizations::Model::ListChildrenRequest::GetParentId ( ) const
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 48 of file ListChildrenRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Organizations::Model::ListChildrenRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Organizations::Model::ListChildrenRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListChildrenRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Organizations::Model::ListChildrenRequest::MaxResultsHasBeenSet ( ) const
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 263 of file ListChildrenRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Organizations::Model::ListChildrenRequest::NextTokenHasBeenSet ( ) const
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 182 of file ListChildrenRequest.h.

◆ ParentIdHasBeenSet()

bool Aws::Organizations::Model::ListChildrenRequest::ParentIdHasBeenSet ( ) const
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 60 of file ListChildrenRequest.h.

◆ SerializePayload()

Aws::String Aws::Organizations::Model::ListChildrenRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChildType() [1/2]

void Aws::Organizations::Model::ListChildrenRequest::SetChildType ( ChildType &&  value)
inline

Filters the output to include only the specified child type.

Definition at line 153 of file ListChildrenRequest.h.

◆ SetChildType() [2/2]

void Aws::Organizations::Model::ListChildrenRequest::SetChildType ( const ChildType value)
inline

Filters the output to include only the specified child type.

Definition at line 148 of file ListChildrenRequest.h.

◆ SetMaxResults()

void Aws::Organizations::Model::ListChildrenRequest::SetMaxResults ( int  value)
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 276 of file ListChildrenRequest.h.

◆ SetNextToken() [1/3]

void Aws::Organizations::Model::ListChildrenRequest::SetNextToken ( Aws::String &&  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 200 of file ListChildrenRequest.h.

◆ SetNextToken() [2/3]

void Aws::Organizations::Model::ListChildrenRequest::SetNextToken ( const Aws::String value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 191 of file ListChildrenRequest.h.

◆ SetNextToken() [3/3]

void Aws::Organizations::Model::ListChildrenRequest::SetNextToken ( const char *  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 209 of file ListChildrenRequest.h.

◆ SetParentId() [1/3]

void Aws::Organizations::Model::ListChildrenRequest::SetParentId ( Aws::String &&  value)
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 84 of file ListChildrenRequest.h.

◆ SetParentId() [2/3]

void Aws::Organizations::Model::ListChildrenRequest::SetParentId ( const Aws::String value)
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 72 of file ListChildrenRequest.h.

◆ SetParentId() [3/3]

void Aws::Organizations::Model::ListChildrenRequest::SetParentId ( const char *  value)
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 96 of file ListChildrenRequest.h.

◆ WithChildType() [1/2]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithChildType ( ChildType &&  value)
inline

Filters the output to include only the specified child type.

Definition at line 163 of file ListChildrenRequest.h.

◆ WithChildType() [2/2]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithChildType ( const ChildType value)
inline

Filters the output to include only the specified child type.

Definition at line 158 of file ListChildrenRequest.h.

◆ WithMaxResults()

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithMaxResults ( int  value)
inline

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 289 of file ListChildrenRequest.h.

◆ WithNextToken() [1/3]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithNextToken ( Aws::String &&  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 227 of file ListChildrenRequest.h.

◆ WithNextToken() [2/3]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithNextToken ( const Aws::String value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 218 of file ListChildrenRequest.h.

◆ WithNextToken() [3/3]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithNextToken ( const char *  value)
inline

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Definition at line 236 of file ListChildrenRequest.h.

◆ WithParentId() [1/3]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithParentId ( Aws::String &&  value)
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 120 of file ListChildrenRequest.h.

◆ WithParentId() [2/3]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithParentId ( const Aws::String value)
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 108 of file ListChildrenRequest.h.

◆ WithParentId() [3/3]

ListChildrenRequest& Aws::Organizations::Model::ListChildrenRequest::WithParentId ( const char *  value)
inline

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 132 of file ListChildrenRequest.h.


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