software.amazon.awssdk.services.organizations.model

Class Organization

java.lang.Object

software.amazon.awssdk.services.organizations.model.Organization

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Organization.Builder,Organization>

@Generated(value="software.amazon.awssdk:codegen")
public final class Organization
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Organization.Builder,Organization>

Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Organization.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of an organization.
List<PolicyTypeSummary>	availablePolicyTypes()
static Organization.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
OrganizationFeatureSet	featureSet() Specifies the functionality that currently is available to the organization.
String	featureSetAsString() Specifies the functionality that currently is available to the organization.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAvailablePolicyTypes() For responses, this returns true if the service returned a value for the AvailablePolicyTypes property.
int	hashCode()
String	id() The unique identifier (ID) of an organization.
String	masterAccountArn() The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.
String	masterAccountEmail() The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.
String	masterAccountId() The unique identifier (ID) of the management account of an organization.
List<SdkField<?>>	sdkFields()
static Class<? extends Organization.Builder>	serializableBuilderClass()
Organization.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The unique identifier (ID) of an organization.

The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits.

Returns:

The unique identifier (ID) of an organization.

The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits.

arn

public final String arn()

The Amazon Resource Name (ARN) of an organization.

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 an organization.

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

featureSet

public final OrganizationFeatureSet featureSet()

Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling all features in your organization in the Organizations User Guide.

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

Returns:

Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling all features in your organization in the Organizations User Guide.

See Also:

OrganizationFeatureSet

featureSetAsString

public final String featureSetAsString()

Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling all features in your organization in the Organizations User Guide.

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

Returns:

Specifies the functionality that currently is available to the organization. If set to "ALL", then all features are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then only consolidated billing functionality is available. For more information, see Enabling all features in your organization in the Organizations User Guide.

See Also:

OrganizationFeatureSet

masterAccountArn

public final String masterAccountArn()

The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.

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 that is designated as the management account for the organization.

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

masterAccountId

public final String masterAccountId()

The unique identifier (ID) of the management account of an organization.

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

Returns:

The unique identifier (ID) of the management account of an organization.

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

masterAccountEmail

public final String masterAccountEmail()

The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.

Returns:

The email address that is associated with the Amazon Web Services account that is designated as the management account for the organization.

hasAvailablePolicyTypes

public final boolean hasAvailablePolicyTypes()

For responses, this returns true if the service returned a value for the AvailablePolicyTypes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

availablePolicyTypes

public final List<PolicyTypeSummary> availablePolicyTypes()

Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.

To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.

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 hasAvailablePolicyTypes() method.

Returns:

Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.

To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.

toBuilder

public Organization.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Organization.Builder,Organization>

builder

public static Organization.Builder builder()

serializableBuilderClass

public static Class<? extends Organization.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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