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

#include <ListParentsRequest.h>

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

Public Member Functions

 ListParentsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetChildId () const
 
bool ChildIdHasBeenSet () const
 
void SetChildId (const Aws::String &value)
 
void SetChildId (Aws::String &&value)
 
void SetChildId (const char *value)
 
ListParentsRequestWithChildId (const Aws::String &value)
 
ListParentsRequestWithChildId (Aws::String &&value)
 
ListParentsRequestWithChildId (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListParentsRequestWithNextToken (const Aws::String &value)
 
ListParentsRequestWithNextToken (Aws::String &&value)
 
ListParentsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListParentsRequestWithMaxResults (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 21 of file ListParentsRequest.h.

Constructor & Destructor Documentation

◆ ListParentsRequest()

Aws::Organizations::Model::ListParentsRequest::ListParentsRequest ( )

Member Function Documentation

◆ ChildIdHasBeenSet()

bool Aws::Organizations::Model::ListParentsRequest::ChildIdHasBeenSet ( ) const
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 61 of file ListParentsRequest.h.

◆ GetChildId()

const Aws::String& Aws::Organizations::Model::ListParentsRequest::GetChildId ( ) const
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 48 of file ListParentsRequest.h.

◆ GetMaxResults()

int Aws::Organizations::Model::ListParentsRequest::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 226 of file ListParentsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Organizations::Model::ListParentsRequest::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 149 of file ListParentsRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListParentsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Organizations::Model::ListParentsRequest::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 239 of file ListParentsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Organizations::Model::ListParentsRequest::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 158 of file ListParentsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChildId() [1/3]

void Aws::Organizations::Model::ListParentsRequest::SetChildId ( Aws::String &&  value)
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 87 of file ListParentsRequest.h.

◆ SetChildId() [2/3]

void Aws::Organizations::Model::ListParentsRequest::SetChildId ( const Aws::String value)
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 74 of file ListParentsRequest.h.

◆ SetChildId() [3/3]

void Aws::Organizations::Model::ListParentsRequest::SetChildId ( const char *  value)
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 100 of file ListParentsRequest.h.

◆ SetMaxResults()

void Aws::Organizations::Model::ListParentsRequest::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 252 of file ListParentsRequest.h.

◆ SetNextToken() [1/3]

void Aws::Organizations::Model::ListParentsRequest::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 176 of file ListParentsRequest.h.

◆ SetNextToken() [2/3]

void Aws::Organizations::Model::ListParentsRequest::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 167 of file ListParentsRequest.h.

◆ SetNextToken() [3/3]

void Aws::Organizations::Model::ListParentsRequest::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 185 of file ListParentsRequest.h.

◆ WithChildId() [1/3]

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::WithChildId ( Aws::String &&  value)
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 126 of file ListParentsRequest.h.

◆ WithChildId() [2/3]

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::WithChildId ( const Aws::String value)
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 113 of file ListParentsRequest.h.

◆ WithChildId() [3/3]

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::WithChildId ( const char *  value)
inline

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 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 contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Definition at line 139 of file ListParentsRequest.h.

◆ WithMaxResults()

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::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 265 of file ListParentsRequest.h.

◆ WithNextToken() [1/3]

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::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 203 of file ListParentsRequest.h.

◆ WithNextToken() [2/3]

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::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 194 of file ListParentsRequest.h.

◆ WithNextToken() [3/3]

ListParentsRequest& Aws::Organizations::Model::ListParentsRequest::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 212 of file ListParentsRequest.h.


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