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

#include <InviteAccountToOrganizationRequest.h>

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

Public Member Functions

 InviteAccountToOrganizationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const HandshakePartyGetTarget () const
 
bool TargetHasBeenSet () const
 
void SetTarget (const HandshakeParty &value)
 
void SetTarget (HandshakeParty &&value)
 
InviteAccountToOrganizationRequestWithTarget (const HandshakeParty &value)
 
InviteAccountToOrganizationRequestWithTarget (HandshakeParty &&value)
 
const Aws::StringGetNotes () const
 
bool NotesHasBeenSet () const
 
void SetNotes (const Aws::String &value)
 
void SetNotes (Aws::String &&value)
 
void SetNotes (const char *value)
 
InviteAccountToOrganizationRequestWithNotes (const Aws::String &value)
 
InviteAccountToOrganizationRequestWithNotes (Aws::String &&value)
 
InviteAccountToOrganizationRequestWithNotes (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
InviteAccountToOrganizationRequestWithTags (const Aws::Vector< Tag > &value)
 
InviteAccountToOrganizationRequestWithTags (Aws::Vector< Tag > &&value)
 
InviteAccountToOrganizationRequestAddTags (const Tag &value)
 
InviteAccountToOrganizationRequestAddTags (Tag &&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 24 of file InviteAccountToOrganizationRequest.h.

Constructor & Destructor Documentation

◆ InviteAccountToOrganizationRequest()

Aws::Organizations::Model::InviteAccountToOrganizationRequest::InviteAccountToOrganizationRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::AddTags ( const Tag value)
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 305 of file InviteAccountToOrganizationRequest.h.

◆ AddTags() [2/2]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::AddTags ( Tag &&  value)
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 324 of file InviteAccountToOrganizationRequest.h.

◆ GetNotes()

const Aws::String& Aws::Organizations::Model::InviteAccountToOrganizationRequest::GetNotes ( ) const
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 129 of file InviteAccountToOrganizationRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file InviteAccountToOrganizationRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Organizations::Model::InviteAccountToOrganizationRequest::GetTags ( ) const
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 191 of file InviteAccountToOrganizationRequest.h.

◆ GetTarget()

const HandshakeParty& Aws::Organizations::Model::InviteAccountToOrganizationRequest::GetTarget ( ) const
inline

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

–target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

–target Id=diego.nosp@m.@exa.nosp@m.mple..nosp@m.com,Type=EMAIL

Definition at line 52 of file InviteAccountToOrganizationRequest.h.

◆ NotesHasBeenSet()

bool Aws::Organizations::Model::InviteAccountToOrganizationRequest::NotesHasBeenSet ( ) const
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 135 of file InviteAccountToOrganizationRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetNotes() [1/3]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetNotes ( Aws::String &&  value)
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 147 of file InviteAccountToOrganizationRequest.h.

◆ SetNotes() [2/3]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetNotes ( const Aws::String value)
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 141 of file InviteAccountToOrganizationRequest.h.

◆ SetNotes() [3/3]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetNotes ( const char *  value)
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 153 of file InviteAccountToOrganizationRequest.h.

◆ SetTags() [1/2]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 248 of file InviteAccountToOrganizationRequest.h.

◆ SetTags() [2/2]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 229 of file InviteAccountToOrganizationRequest.h.

◆ SetTarget() [1/2]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetTarget ( const HandshakeParty value)
inline

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

–target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

–target Id=diego.nosp@m.@exa.nosp@m.mple..nosp@m.com,Type=EMAIL

Definition at line 80 of file InviteAccountToOrganizationRequest.h.

◆ SetTarget() [2/2]

void Aws::Organizations::Model::InviteAccountToOrganizationRequest::SetTarget ( HandshakeParty &&  value)
inline

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

–target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

–target Id=diego.nosp@m.@exa.nosp@m.mple..nosp@m.com,Type=EMAIL

Definition at line 94 of file InviteAccountToOrganizationRequest.h.

◆ TagsHasBeenSet()

bool Aws::Organizations::Model::InviteAccountToOrganizationRequest::TagsHasBeenSet ( ) const
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 210 of file InviteAccountToOrganizationRequest.h.

◆ TargetHasBeenSet()

bool Aws::Organizations::Model::InviteAccountToOrganizationRequest::TargetHasBeenSet ( ) const
inline

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

–target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

–target Id=diego.nosp@m.@exa.nosp@m.mple..nosp@m.com,Type=EMAIL

Definition at line 66 of file InviteAccountToOrganizationRequest.h.

◆ WithNotes() [1/3]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithNotes ( Aws::String &&  value)
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 165 of file InviteAccountToOrganizationRequest.h.

◆ WithNotes() [2/3]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithNotes ( const Aws::String value)
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 159 of file InviteAccountToOrganizationRequest.h.

◆ WithNotes() [3/3]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithNotes ( const char *  value)
inline

Additional information that you want to include in the generated email to the recipient account owner.

Definition at line 171 of file InviteAccountToOrganizationRequest.h.

◆ WithTags() [1/2]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 286 of file InviteAccountToOrganizationRequest.h.

◆ WithTags() [2/2]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.

If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.

Definition at line 267 of file InviteAccountToOrganizationRequest.h.

◆ WithTarget() [1/2]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithTarget ( const HandshakeParty value)
inline

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

–target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

–target Id=diego.nosp@m.@exa.nosp@m.mple..nosp@m.com,Type=EMAIL

Definition at line 108 of file InviteAccountToOrganizationRequest.h.

◆ WithTarget() [2/2]

InviteAccountToOrganizationRequest& Aws::Organizations::Model::InviteAccountToOrganizationRequest::WithTarget ( HandshakeParty &&  value)
inline

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "&lt;<i> <b>account id number</b> </i>&gt;" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

–target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", you must specify the email address that is associated with the account.

–target Id=diego.nosp@m.@exa.nosp@m.mple..nosp@m.com,Type=EMAIL

Definition at line 122 of file InviteAccountToOrganizationRequest.h.


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