@Generated(value="software.amazon.awssdk:codegen") public final class InviteAccountToOrganizationRequest extends OrganizationsRequest implements ToCopyableBuilder<InviteAccountToOrganizationRequest.Builder,InviteAccountToOrganizationRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
InviteAccountToOrganizationRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static InviteAccountToOrganizationRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
notes()
Additional information that you want to include in the generated email to the recipient account owner.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends InviteAccountToOrganizationRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of tags that you want to attach to the account when it becomes a member of the organization.
|
HandshakeParty |
target()
The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
|
InviteAccountToOrganizationRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final HandshakeParty target()
The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:
{ "Type": "ACCOUNT", "Id": "< account id number >" }
If you use the 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 Amazon Web Services 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@example.com,Type=EMAIL
{ "Type": "ACCOUNT", "Id": "< account id number >" }
If you use the 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 Amazon Web Services 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@example.com,Type=EMAIL
public final String notes()
Additional information that you want to include in the generated email to the recipient account owner.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
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 Organizations
resources in the 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 not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
null. For more information about tagging, see Tagging Organizations
resources in the 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 not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
public InviteAccountToOrganizationRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<InviteAccountToOrganizationRequest.Builder,InviteAccountToOrganizationRequest>toBuilder in class OrganizationsRequestpublic static InviteAccountToOrganizationRequest.Builder builder()
public static Class<? extends InviteAccountToOrganizationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.