Class SageMaker

All Implemented Interfaces:
IAI, IAsset, IAWS, ICatalog, ICloud, IReferenceable, ISageMaker, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SageMaker extends Asset implements ISageMaker, IAI, IAWS, ICatalog, IAsset, IReferenceable, ICloud
Base class for AWS SageMaker assets.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public SageMaker trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a SageMaker, from a potentially more-complete SageMaker object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the SageMaker
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a SageMaker relationship are not found in the initial object
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all SageMaker assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) SageMaker assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all SageMaker assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all SageMaker assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) SageMakers will be included
      Returns:
      a fluent search that includes all SageMaker assets
    • refByGuid

      public static SageMaker refByGuid(String guid)
      Reference to a SageMaker by GUID. Use this to create a relationship to this SageMaker, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the SageMaker to reference
      Returns:
      reference to a SageMaker that can be used for defining a relationship to a SageMaker
    • refByGuid

      public static SageMaker refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a SageMaker by GUID. Use this to create a relationship to this SageMaker, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the SageMaker to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a SageMaker that can be used for defining a relationship to a SageMaker
    • refByQualifiedName

      public static SageMaker refByQualifiedName(String qualifiedName)
      Reference to a SageMaker by qualifiedName. Use this to create a relationship to this SageMaker, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the SageMaker to reference
      Returns:
      reference to a SageMaker that can be used for defining a relationship to a SageMaker
    • refByQualifiedName

      public static SageMaker refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a SageMaker by qualifiedName. Use this to create a relationship to this SageMaker, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the SageMaker to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a SageMaker that can be used for defining a relationship to a SageMaker
    • get

      public static SageMaker get(AtlanClient client, String id) throws AtlanException
      Retrieves a SageMaker by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SageMaker to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full SageMaker, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SageMaker does not exist or the provided GUID is not a SageMaker
    • get

      public static SageMaker get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
      Retrieves a SageMaker by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SageMaker to retrieve, either its GUID or its full qualifiedName
      includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full SageMaker, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SageMaker does not exist or the provided GUID is not a SageMaker
    • get

      public static SageMaker get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a SageMaker by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SageMaker to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SageMaker, including any relationships
      Returns:
      the requested SageMaker, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SageMaker does not exist or the provided GUID is not a SageMaker
    • get

      public static SageMaker get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a SageMaker by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the SageMaker to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SageMaker, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the SageMaker
      Returns:
      the requested SageMaker, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the SageMaker does not exist or the provided GUID is not a SageMaker
    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) SageMaker to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the SageMaker
      Returns:
      true if the SageMaker is now active, and false otherwise
      Throws:
      AtlanException - on any API problems
    • updater

      public static SageMaker.SageMakerBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a SageMaker.
      Parameters:
      qualifiedName - of the SageMaker
      name - of the SageMaker
      Returns:
      the minimal request necessary to update the SageMaker, as a builder
    • trimToRequired

      public SageMaker.SageMakerBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a SageMaker, from a potentially more-complete SageMaker object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the SageMaker, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required fields for a SageMaker are not present in the initial object
    • removeDescription

      public static SageMaker removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the SageMaker
      name - of the SageMaker
      Returns:
      the updated SageMaker, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeUserDescription

      public static SageMaker removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the SageMaker
      name - of the SageMaker
      Returns:
      the updated SageMaker, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeOwners

      public static SageMaker removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the SageMaker's owners
      qualifiedName - of the SageMaker
      name - of the SageMaker
      Returns:
      the updated SageMaker, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • updateCertificate

      public static SageMaker updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the SageMaker's certificate
      qualifiedName - of the SageMaker
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated SageMaker, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • removeCertificate

      public static SageMaker removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the SageMaker's certificate
      qualifiedName - of the SageMaker
      name - of the SageMaker
      Returns:
      the updated SageMaker, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • updateAnnouncement

      public static SageMaker updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the SageMaker's announcement
      qualifiedName - of the SageMaker
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • removeAnnouncement

      public static SageMaker removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a SageMaker.
      Parameters:
      client - connectivity to the Atlan client from which to remove the SageMaker's announcement
      qualifiedName - of the SageMaker
      name - of the SageMaker
      Returns:
      the updated SageMaker, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • replaceTerms

      public static SageMaker replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the SageMaker's assigned terms
      qualifiedName - for the SageMaker
      name - human-readable name of the SageMaker
      terms - the list of terms to replace on the SageMaker, or null to remove all terms from the SageMaker
      Returns:
      the SageMaker that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems
    • appendTerms

      @Deprecated public static SageMaker appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the SageMaker, without replacing existing terms linked to the SageMaker. Note: this operation must make two API calls — one to retrieve the SageMaker's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the SageMaker
      qualifiedName - for the SageMaker
      terms - the list of terms to append to the SageMaker
      Returns:
      the SageMaker that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems
    • removeTerms

      @Deprecated public static SageMaker removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a SageMaker, without replacing all existing terms linked to the SageMaker. Note: this operation must make two API calls — one to retrieve the SageMaker's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the SageMaker
      qualifiedName - for the SageMaker
      terms - the list of terms to remove from the SageMaker, which must be referenced by GUID
      Returns:
      the SageMaker that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      @Deprecated public static SageMaker appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a SageMaker, without replacing existing Atlan tags linked to the SageMaker. Note: this operation must make two API calls — one to retrieve the SageMaker's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the SageMaker
      qualifiedName - of the SageMaker
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated SageMaker
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      @Deprecated public static SageMaker appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a SageMaker, without replacing existing Atlan tags linked to the SageMaker. Note: this operation must make two API calls — one to retrieve the SageMaker's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the SageMaker
      qualifiedName - of the SageMaker
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated SageMaker
      Throws:
      AtlanException - on any API problems
    • removeAtlanTag

      @Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a SageMaker.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a SageMaker
      qualifiedName - of the SageMaker
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the SageMaker
    • _internal

      public static SageMaker.SageMakerBuilder<?,?> _internal()
    • toBuilder

      public SageMaker.SageMakerBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getAwsAccountId

      public String getAwsAccountId()
      12-digit number that uniquely identifies an AWS account.
      Specified by:
      getAwsAccountId in interface IAWS
      Specified by:
      getAwsAccountId in interface ISageMaker
    • getAwsArn

      public String getAwsArn()
      DEPRECATED: This legacy attribute must be unique across all AWS asset instances. This can create non-obvious edge cases for creating / updating assets, and we therefore recommended NOT using it. See and use cloudResourceName instead.
      Specified by:
      getAwsArn in interface IAWS
      Specified by:
      getAwsArn in interface ISageMaker
    • getAwsOwnerId

      public String getAwsOwnerId()
      Root user's ID.
      Specified by:
      getAwsOwnerId in interface IAWS
      Specified by:
      getAwsOwnerId in interface ISageMaker
    • getAwsOwnerName

      public String getAwsOwnerName()
      Root user's name.
      Specified by:
      getAwsOwnerName in interface IAWS
      Specified by:
      getAwsOwnerName in interface ISageMaker
    • getAwsPartition

      public String getAwsPartition()
      Group of AWS region and service objects.
      Specified by:
      getAwsPartition in interface IAWS
      Specified by:
      getAwsPartition in interface ISageMaker
    • getAwsRegion

      public String getAwsRegion()
      Physical region where the data center in which the asset exists is clustered.
      Specified by:
      getAwsRegion in interface IAWS
      Specified by:
      getAwsRegion in interface ISageMaker
    • getAwsResourceId

      public String getAwsResourceId()
      Unique resource ID assigned when a new resource is created.
      Specified by:
      getAwsResourceId in interface IAWS
      Specified by:
      getAwsResourceId in interface ISageMaker
    • getAwsService

      public String getAwsService()
      Type of service in which the asset exists.
      Specified by:
      getAwsService in interface IAWS
      Specified by:
      getAwsService in interface ISageMaker
    • getAwsTags

      public List<AwsTag> getAwsTags()
      List of tags that have been applied to the asset in AWS.
      Specified by:
      getAwsTags in interface IAWS
      Specified by:
      getAwsTags in interface ISageMaker
    • getCloudUniformResourceName

      public String getCloudUniformResourceName()
      Uniform resource name (URN) for the asset: AWS ARN, Google Cloud URI, Azure resource ID, Oracle OCID, and so on.
      Specified by:
      getCloudUniformResourceName in interface IAWS
      Specified by:
      getCloudUniformResourceName in interface ICloud
      Specified by:
      getCloudUniformResourceName in interface ISageMaker
    • getEthicalAIAccountabilityConfig

      public EthicalAIAccountabilityConfig getEthicalAIAccountabilityConfig()
      Accountability configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIAccountabilityConfig in interface IAI
      Specified by:
      getEthicalAIAccountabilityConfig in interface ISageMaker
    • getEthicalAIBiasMitigationConfig

      public EthicalAIBiasMitigationConfig getEthicalAIBiasMitigationConfig()
      Bias mitigation configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIBiasMitigationConfig in interface IAI
      Specified by:
      getEthicalAIBiasMitigationConfig in interface ISageMaker
    • getEthicalAIEnvironmentalConsciousnessConfig

      public EthicalAIEnvironmentalConsciousnessConfig getEthicalAIEnvironmentalConsciousnessConfig()
      Environmental consciousness configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIEnvironmentalConsciousnessConfig in interface IAI
      Specified by:
      getEthicalAIEnvironmentalConsciousnessConfig in interface ISageMaker
    • getEthicalAIFairnessConfig

      public EthicalAIFairnessConfig getEthicalAIFairnessConfig()
      Fairness configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIFairnessConfig in interface IAI
      Specified by:
      getEthicalAIFairnessConfig in interface ISageMaker
    • getEthicalAIPrivacyConfig

      public EthicalAIPrivacyConfig getEthicalAIPrivacyConfig()
      Privacy configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIPrivacyConfig in interface IAI
      Specified by:
      getEthicalAIPrivacyConfig in interface ISageMaker
    • getEthicalAIReliabilityAndSafetyConfig

      public EthicalAIReliabilityAndSafetyConfig getEthicalAIReliabilityAndSafetyConfig()
      Reliability and safety configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAIReliabilityAndSafetyConfig in interface IAI
      Specified by:
      getEthicalAIReliabilityAndSafetyConfig in interface ISageMaker
    • getEthicalAITransparencyConfig

      public EthicalAITransparencyConfig getEthicalAITransparencyConfig()
      Transparency configuration for ensuring the ethical use of an AI asset
      Specified by:
      getEthicalAITransparencyConfig in interface IAI
      Specified by:
      getEthicalAITransparencyConfig in interface ISageMaker
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface IAI
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface ISageMaker
    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface IAI
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface ISageMaker
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IAI
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISageMaker
    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface IAI
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISageMaker
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface IAI
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISageMaker
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface IAI
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface ISageMaker
    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface IAI
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface ISageMaker
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAI
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISageMaker
    • getPartialChildFields

      public SortedSet<IPartialField> getPartialChildFields()
      Partial fields contained in the asset.
      Specified by:
      getPartialChildFields in interface IAI
      Specified by:
      getPartialChildFields in interface ICatalog
      Specified by:
      getPartialChildFields in interface ISageMaker
    • getPartialChildObjects

      public SortedSet<IPartialObject> getPartialChildObjects()
      Partial objects contained in the asset.
      Specified by:
      getPartialChildObjects in interface IAI
      Specified by:
      getPartialChildObjects in interface ICatalog
      Specified by:
      getPartialChildObjects in interface ISageMaker
    • getSageMakerS3Uri

      public String getSageMakerS3Uri()
      Primary S3 URI associated with this SageMaker asset.
      Specified by:
      getSageMakerS3Uri in interface ISageMaker
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset
    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset
    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset
    • getTypeName

      public String getTypeName()
      Fixed typeName for SageMakers.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAI
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IAWS
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface ICloud
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISageMaker
      Overrides:
      getTypeName in class Reference