Package software.amazon.awssdk.services.securityhub.model

Class AwsOrganizationScope

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

Specifies an Organizations scope. Data from the specified organization or organizational unit is included in the response.

To scope to a specific organizational unit, provide OrganizationalUnitId. You can optionally include OrganizationId. If you omit OrganizationId, Security Hub uses the caller's organization ID. To scope to the delegated administrator's entire organization, provide only OrganizationId.

The organization ID and organizational unit must belong to the delegated administrator's own organization. Each request must use one scoping approach: either scope to the entire organization by providing an AwsOrganizationScope entry with only OrganizationId, or scope to specific organizational units by providing AwsOrganizationScope entries with OrganizationalUnitId. You can't combine both approaches in the same request.

See Also:

  • Method Details

    • organizationId

      public final String organizationId()

      The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security Hub uses the caller's organization ID.

      Returns:
      The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security Hub uses the caller's organization ID.

    • organizationalUnitId

      public final String organizationalUnitId()

      The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU must exist within the delegated administrator's own organization. When specified, the results include only data from accounts in this OU.

      Returns:
      The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU must exist within the delegated administrator's own organization. When specified, the results include only data from accounts in this OU.

    • toBuilder

      public AwsOrganizationScope.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsOrganizationScope.Builder,AwsOrganizationScope>

    • builder

      public static AwsOrganizationScope.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo