Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
pyatlan documentation
pyatlan documentation
  • Atlan Client Interface
  • Assets
    • ADF
    • ADLS
    • ADLSAccount
    • ADLSContainer
    • ADLSObject
    • AI
    • AIApplication
    • AIModel
    • API
    • APIField
    • APIObject
    • APIPath
    • APIQuery
    • APISpec
    • AWS
    • AccessControl
    • AdfActivity
    • AdfDataflow
    • AdfDataset
    • AdfLinkedservice
    • AdfPipeline
    • Airflow
    • AirflowDag
    • AirflowTask
    • Anaplan
    • AnaplanApp
    • AnaplanDimension
    • AnaplanLineItem
    • AnaplanList
    • AnaplanModel
    • AnaplanModule
    • AnaplanPage
    • AnaplanSystemDimension
    • AnaplanView
    • AnaplanWorkspace
    • Anomalo
    • AnomaloCheck
    • App
    • Application
    • ApplicationField
    • Asset
    • AtlasGlossary
    • AtlasGlossaryCategory
    • AtlasGlossaryTerm
    • AuthPolicy
    • AuthService
    • Azure
    • AzureEventHub
    • AzureEventHubConsumerGroup
    • AzureServiceBus
    • AzureServiceBusNamespace
    • AzureServiceBusSchema
    • AzureServiceBusTopic
    • BI
    • BIProcess
    • Badge
    • BigqueryTag
    • BusinessPolicy
    • BusinessPolicyException
    • BusinessPolicyIncident
    • BusinessPolicyLog
    • CalculationView
    • Cassandra
    • CassandraColumn
    • CassandraIndex
    • CassandraKeyspace
    • CassandraTable
    • CassandraView
    • Catalog
    • Cloud
    • Cognite
    • Cognite3DModel
    • CogniteAsset
    • CogniteEvent
    • CogniteFile
    • CogniteSequence
    • CogniteTimeSeries
    • Cognos
    • CognosDashboard
    • CognosDatasource
    • CognosExploration
    • CognosFile
    • CognosFolder
    • CognosModule
    • CognosPackage
    • CognosReport
    • Collection
    • Column
    • ColumnProcess
    • Connection
    • CosmosMongoDB
    • CosmosMongoDBAccount
    • CosmosMongoDBCollection
    • CosmosMongoDBDatabase
    • Cube
    • CubeDimension
    • CubeField
    • CubeHierarchy
    • Custom
    • CustomEntity
    • DataContract
    • DataDomain
    • DataMesh
    • DataProduct
    • DataQuality
    • DataSet
    • DataStudio
    • DataStudioAsset
    • Database
    • DatabricksUnityCatalogTag
    • Dataverse
    • DataverseAttribute
    • DataverseEntity
    • Dbt
    • DbtColumnProcess
    • DbtMetric
    • DbtModel
    • DbtModelColumn
    • DbtProcess
    • DbtSource
    • DbtTag
    • DbtTest
    • DocumentDB
    • DocumentDBCollection
    • DocumentDBDatabase
    • Domo
    • DomoCard
    • DomoDashboard
    • DomoDataset
    • DomoDatasetColumn
    • DynamoDB
    • DynamoDBGlobalSecondaryIndex
    • DynamoDBLocalSecondaryIndex
    • DynamoDBSecondaryIndex
    • DynamoDBTable
    • EventStore
    • File
    • Fivetran
    • FivetranConnector
    • Folder
    • Form
    • Function
    • GCS
    • GCSBucket
    • GCSObject
    • Google
    • Incident
    • Infrastructure
    • Insight
    • Kafka
    • KafkaConsumerGroup
    • KafkaTopic
    • Link
    • Looker
    • LookerDashboard
    • LookerExplore
    • LookerField
    • LookerFolder
    • LookerLook
    • LookerModel
    • LookerProject
    • LookerQuery
    • LookerTile
    • LookerView
    • MCIncident
    • MCMonitor
    • MaterialisedView
    • Matillion
    • MatillionComponent
    • MatillionGroup
    • MatillionJob
    • MatillionProject
    • Metabase
    • MetabaseCollection
    • MetabaseDashboard
    • MetabaseQuestion
    • Metric
    • MicroStrategy
    • MicroStrategyAttribute
    • MicroStrategyCube
    • MicroStrategyDocument
    • MicroStrategyDossier
    • MicroStrategyFact
    • MicroStrategyMetric
    • MicroStrategyProject
    • MicroStrategyReport
    • MicroStrategyVisualization
    • Mode
    • ModeChart
    • ModeCollection
    • ModeQuery
    • ModeReport
    • ModeWorkspace
    • Model
    • ModelAttribute
    • ModelAttributeAssociation
    • ModelDataModel
    • ModelEntity
    • ModelEntityAssociation
    • ModelVersion
    • MongoDB
    • MongoDBCollection
    • MongoDBDatabase
    • MonteCarlo
    • MultiDimensionalDataset
    • Namespace
    • NoSQL
    • ObjectStore
    • Persona
    • PowerBI
    • PowerBIColumn
    • PowerBIDashboard
    • PowerBIDataflow
    • PowerBIDataflowEntityColumn
    • PowerBIDataset
    • PowerBIDatasource
    • PowerBIMeasure
    • PowerBIPage
    • PowerBIReport
    • PowerBITable
    • PowerBITile
    • PowerBIWorkspace
    • Preset
    • PresetChart
    • PresetDashboard
    • PresetDataset
    • PresetWorkspace
    • Procedure
    • Process
    • ProcessExecution
    • Purpose
    • Qlik
    • QlikApp
    • QlikChart
    • QlikDataset
    • QlikSheet
    • QlikSpace
    • QlikStream
    • Query
    • QuickSight
    • QuickSightAnalysis
    • QuickSightAnalysisVisual
    • QuickSightDashboard
    • QuickSightDashboardVisual
    • QuickSightDataset
    • QuickSightDatasetField
    • QuickSightFolder
    • Readme
    • ReadmeTemplate
    • Redash
    • RedashDashboard
    • RedashQuery
    • RedashVisualization
    • Referenceable
    • Resource
    • Response
    • S3
    • S3Bucket
    • S3Object
    • SAP
    • SQL
    • SaaS
    • Salesforce
    • SalesforceDashboard
    • SalesforceField
    • SalesforceObject
    • SalesforceOrganization
    • SalesforceReport
    • SapErpAbapProgram
    • SapErpColumn
    • SapErpComponent
    • SapErpFunctionModule
    • SapErpTable
    • SapErpTransactionCode
    • SapErpView
    • Schema
    • SchemaRegistry
    • SchemaRegistrySubject
    • Sigma
    • SigmaDataElement
    • SigmaDataElementField
    • SigmaDataset
    • SigmaDatasetColumn
    • SigmaPage
    • SigmaWorkbook
    • Sisense
    • SisenseDashboard
    • SisenseDatamodel
    • SisenseDatamodelTable
    • SisenseFolder
    • SisenseWidget
    • SnowflakeDynamicTable
    • SnowflakePipe
    • SnowflakeStream
    • SnowflakeTag
    • Soda
    • SodaCheck
    • SourceTag
    • Spark
    • SparkJob
    • Stakeholder
    • StakeholderTitle
    • Superset
    • SupersetChart
    • SupersetDashboard
    • SupersetDataset
    • Table
    • TablePartition
    • Tableau
    • TableauCalculatedField
    • TableauDashboard
    • TableauDatasource
    • TableauDatasourceField
    • TableauFlow
    • TableauMetric
    • TableauProject
    • TableauSite
    • TableauWorkbook
    • TableauWorksheet
    • Tag
    • TagAttachment
    • Task
    • Thoughtspot
    • ThoughtspotAnswer
    • ThoughtspotColumn
    • ThoughtspotDashlet
    • ThoughtspotLiveboard
    • ThoughtspotTable
    • ThoughtspotView
    • ThoughtspotWorksheet
    • View
    • Workflow
    • WorkflowRun
  • Other models
    • Core model
    • Custom metadata
    • User
    • Group
    • Role
    • Keycloak events
    • Lineage
    • TypeDef
    • Atlan image
  • Error Handling
  • Caches
    • AtlanTagCache
    • CustomMetadataCache
    • EnumCache
    • GroupCache
    • RoleCache
    • UserCache
  • Fields
    • RelationField
    • SearchableField
    • BooleanField
    • KeywordField
    • TextField
    • NumericField
    • NumericRankField
    • KeywordTextField
    • KeywordTextStemmedField
    • CustomMetadataField
  • Events
Back to top
View this page

pyatlan¶

Most methods you are likely to use integration with or automating things in Atlan are available in the client interface. Inevitably you’ll be dealing with some (or many) different kinds of assets as part of your code, too.

  • Atlan Client Interface
  • Assets

For the complete reference on deeper topics:

  • Other models
  • Error Handling
  • Caches
  • Fields
  • Events
Next
Atlan Client Interface
Copyright © 2023, Atlan Pte. Ltd.
Made with Sphinx and @pradyunsg's Furo