Class Account

java.lang.Object
software.amazon.awssdk.services.organizations.model.Account
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Account.Builder,Account>
@Generated("software.amazon.awssdk:codegen") public final class Account extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Account.Builder,Account>

Contains information about an Amazon Web Services account that is a member of an organization.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier (ID) of the account.

      The regex pattern for an account ID string requires exactly 12 digits.

      Returns:
      The unique identifier (ID) of the account.

      The regex pattern for an account ID string requires exactly 12 digits.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the account.

      For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

      Returns:
      The Amazon Resource Name (ARN) of the account.

      For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

    • email

      public final String email()

      The email address associated with the Amazon Web Services account.

      The regex pattern for this parameter is a string of characters that represents a standard internet email address.

      Returns:
      The email address associated with the Amazon Web Services account.

      The regex pattern for this parameter is a string of characters that represents a standard internet email address.

    • name

      public final String name()

      The friendly name of the account.

      The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

      Returns:
      The friendly name of the account.

      The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    • status

      public final AccountStatus status()

      The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

      If the service returns an enum value that is not available in the current SDK version, status will return AccountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

      If the service returns an enum value that is not available in the current SDK version, status will return AccountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the account in the organization.

      The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

      See Also:

    • state

      public final AccountState state()

      Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      If the service returns an enum value that is not available in the current SDK version, state will return AccountState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      See Also:

    • stateAsString

      public final String stateAsString()

      Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      If the service returns an enum value that is not available in the current SDK version, state will return AccountState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

      For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      See Also:

    • joinedMethod

      public final AccountJoinedMethod joinedMethod()

      The method by which the account joined the organization.

      If the service returns an enum value that is not available in the current SDK version, joinedMethod will return AccountJoinedMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from joinedMethodAsString().

      Returns:
      The method by which the account joined the organization.
      See Also:

    • joinedMethodAsString

      public final String joinedMethodAsString()

      The method by which the account joined the organization.

      If the service returns an enum value that is not available in the current SDK version, joinedMethod will return AccountJoinedMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from joinedMethodAsString().

      Returns:
      The method by which the account joined the organization.
      See Also:

    • joinedTimestamp

      public final Instant joinedTimestamp()

      The date the account became a part of the organization.

      Returns:
      The date the account became a part of the organization.

    • toBuilder

      public Account.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Account.Builder,Account>
      Returns:
      a builder for type T

    • builder

      public static Account.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Account.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.