Class AIDetails

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

Contains information about self-hosted AI resources and their host resources. The fields that are present depend on the role of the resource.

On a self-hosted AI resource (a resource with a SelfHosted::AI:: resource type, such as SelfHosted::AI::Model or SelfHosted::AI::Agent), the HostResourceGuid and HostResourceType fields link the resource to its host. The CanonicalId field identifies what the resource is, enabling aggregation of identical resources across multiple hosts.

On a host resource (such as an Amazon EC2 instance), the SelfHostedAI*ResourceCount fields contain the count for each ResourceSubCategory and the total count of self-hosted AI resources detected on the host.

See Also:

  • Method Details

    • hostResourceGuid

      public final String hostResourceGuid()

      The identifier of the host resource that hosts the self-hosted AI resource. Present only on self-hosted AI resources.

      Returns:
      The identifier of the host resource that hosts the self-hosted AI resource. Present only on self-hosted AI resources.

    • hostResourceType

      public final String hostResourceType()

      The ResourceType of the host resource that hosts the self-hosted AI resource, such as AWS::EC2::Instance. Present only on self-hosted AI resources.

      Returns:
      The ResourceType of the host resource that hosts the self-hosted AI resource, such as AWS::EC2::Instance. Present only on self-hosted AI resources.

    • canonicalId

      public final String canonicalId()

      The canonical identifier for the AI resource, independent of where it is deployed. Multiple occurrences of the same resource on different hosts share the same CanonicalId. For model resources, the value follows the format model/<purl>, such as model/pkg:huggingface/meta-llama/llama-3-8b. Present only on self-hosted AI resources.

      Returns:
      The canonical identifier for the AI resource, independent of where it is deployed. Multiple occurrences of the same resource on different hosts share the same CanonicalId. For model resources, the value follows the format model/<purl>, such as model/pkg:huggingface/meta-llama/llama-3-8b. Present only on self-hosted AI resources.

    • selfHostedAIModelResourceCount

      public final Integer selfHostedAIModelResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory Model detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory Model detected on the host resource. Present only on host resources.

    • selfHostedAIAgentResourceCount

      public final Integer selfHostedAIAgentResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory Agent detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory Agent detected on the host resource. Present only on host resources.

    • selfHostedAIModelServingResourceCount

      public final Integer selfHostedAIModelServingResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory ModelServing detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory ModelServing detected on the host resource. Present only on host resources.

    • selfHostedAIExternalEndpointResourceCount

      public final Integer selfHostedAIExternalEndpointResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory ExternalEndpoint detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory ExternalEndpoint detected on the host resource. Present only on host resources.

    • selfHostedAIDevelopmentResourceCount

      public final Integer selfHostedAIDevelopmentResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory Development detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory Development detected on the host resource. Present only on host resources.

    • selfHostedAIAgentFrameworkResourceCount

      public final Integer selfHostedAIAgentFrameworkResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory AgentFramework detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory AgentFramework detected on the host resource. Present only on host resources.

    • selfHostedAIAgentToolsAndIdentityResourceCount

      public final Integer selfHostedAIAgentToolsAndIdentityResourceCount()

      The number of self-hosted AI resources of ResourceSubCategory AgentToolsAndIdentity detected on the host resource. Present only on host resources.

      Returns:
      The number of self-hosted AI resources of ResourceSubCategory AgentToolsAndIdentity detected on the host resource. Present only on host resources.

    • selfHostedTotalAIResourceCount

      public final Integer selfHostedTotalAIResourceCount()

      The total number of all self-hosted AI resources detected on the host resource. Present only on host resources.

      Returns:
      The total number of all self-hosted AI resources detected on the host resource. Present only on host resources.

    • toBuilder

      public AIDetails.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<AIDetails.Builder,AIDetails>
      Returns:
      a builder for type T

    • builder

      public static AIDetails.Builder builder()

    • serializableBuilderClass

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