Package com.atlan.model.assets

Class AWS

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.AWS
All Implemented Interfaces:
IAsset, IAWS, ICloud, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class AWS extends Asset implements IAWS, IAsset, IReferenceable, ICloud
Base class for AWS assets.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all AWS 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) AWS assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all AWS assets

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all AWS 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) AWSs will be included
      Returns:
      a fluent search that includes all AWS assets

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

      public static AWS get(AtlanClient client, String id) throws AtlanException
      Retrieves a AWS 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 AWS to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full AWS, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AWS does not exist or the provided GUID is not a AWS

    • get

      public static AWS get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
      Retrieves a AWS 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 AWS 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 AWS, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AWS does not exist or the provided GUID is not a AWS

    • get

      public static AWS get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a AWS 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 AWS to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the AWS, including any relationships
      Returns:
      the requested AWS, 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 AWS does not exist or the provided GUID is not a AWS

    • get

      public static AWS get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a AWS 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 AWS to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the AWS, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the AWS
      Returns:
      the requested AWS, 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 AWS does not exist or the provided GUID is not a AWS

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

      public static AWS updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a AWS.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the AWS's announcement
      qualifiedName - of the AWS
      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 AWS removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a AWS.
      Parameters:
      client - connectivity to the Atlan client from which to remove the AWS's announcement
      qualifiedName - of the AWS
      name - of the AWS
      Returns:
      the updated AWS, or null if the removal failed
      Throws:
      AtlanException - on any API problems

    • replaceTerms

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

    • appendTerms

      @Deprecated public static AWS appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
      Link additional terms to the AWS, without replacing existing terms linked to the AWS. Note: this operation must make two API calls — one to retrieve the AWS'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 AWS
      qualifiedName - for the AWS
      terms - the list of terms to append to the AWS
      Returns:
      the AWS that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems

    • removeTerms

      @Deprecated public static AWS removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
      Remove terms from a AWS, without replacing all existing terms linked to the AWS. Note: this operation must make two API calls — one to retrieve the AWS'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 AWS
      qualifiedName - for the AWS
      terms - the list of terms to remove from the AWS, which must be referenced by GUID
      Returns:
      the AWS that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      @Deprecated public static AWS appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAtlanTags(List)
      Add Atlan tags to a AWS, without replacing existing Atlan tags linked to the AWS. Note: this operation must make two API calls — one to retrieve the AWS'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 AWS
      qualifiedName - of the AWS
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated AWS
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      @Deprecated public static AWS appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
      Add Atlan tags to a AWS, without replacing existing Atlan tags linked to the AWS. Note: this operation must make two API calls — one to retrieve the AWS'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 AWS
      qualifiedName - of the AWS
      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 AWS
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      @Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Deprecated.
      see Asset.AssetBuilder.removeAtlanTag(String)
      Remove an Atlan tag from a AWS.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a AWS
      qualifiedName - of the AWS
      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 AWS

    • _internal

      public static AWS.AWSBuilder<?,?> _internal()

    • toBuilder

      public AWS.AWSBuilder<?,?> 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

    • 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

    • getAwsOwnerId

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

    • getAwsOwnerName

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

    • getAwsPartition

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

    • getAwsRegion

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

    • getAwsResourceId

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

    • getAwsService

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

    • getAwsTags

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

    • 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

    • 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 AWSs.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IAWS
      Specified by:
      getTypeName in interface ICloud
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference