Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Amorphic SDK 1.0 Documentation
Amorphic SDK 1.0 Documentation Compatible with Amorphic v3.3+

Release Notes:

  • Release Notes

Getting Started:

  • Quickstart
  • User Guide
  • Getting Started with Wrapper Classes
  • Authentication Setup
  • Working with APIs
  • Next Steps

Wrapper Classes:

  • Wrapper Classes
    • AmorphicApiClient
    • TokenFetcher
    • HelpCommand

API Reference:

  • API Reference
  • Available Services
    • ArtificialIntelligence
      • add_resources_to_knowledge_base
      • chat_with_ai_guard_rail
      • create_agent
      • create_ai_chat
      • create_ai_guard_rail
      • create_ai_note
      • create_ai_project
      • create_ai_project_thread
      • create_knowledge_base
      • create_or_ingest_chat_files
      • delete_agent
      • delete_ai_chat
      • delete_ai_chat_file
      • delete_ai_guard_rail
      • delete_ai_note
      • delete_ai_project
      • delete_ai_project_thread
      • delete_knowledge_base
      • delete_knowledge_base_resource
      • get_agent_details
      • get_ai_chat
      • get_ai_chat_config
      • get_ai_configurations
      • get_ai_guard_rail
      • get_ai_knowledge_base
      • get_ai_model_details
      • get_ai_note
      • get_ai_project_details
      • get_ai_project_thread
      • get_citation_presigned_url
      • get_default_ai_guard_rail
      • get_knowledge_base_resource_details
      • get_knowledge_base_run_metrics
      • invoke_ai_model
      • list_agents
      • list_ai_chat_files
      • list_ai_chat_messages
      • list_ai_chats
      • list_ai_guard_rails
      • list_ai_models
      • list_ai_notes
      • list_ai_project_thread_messages
      • list_ai_project_threads
      • list_ai_projects
      • list_knowledge_bases
      • migrate_rag_engine
      • query_knowledge_base
      • set_ai_guard_rail_as_default
      • sync_knowledge_base
      • update_agent_details
      • update_ai_chat
      • update_ai_chat_config
      • update_ai_configurations
      • update_ai_guard_rail
      • update_ai_model
      • update_ai_model_configurations
      • update_ai_note
      • update_ai_project_details
      • update_ai_project_thread
      • update_knowledge_base
      • update_knowledge_base_resource
    • Catalog
      • create_glossary
      • create_glossary_term
      • delete_glossary
      • delete_glossary_term
      • generate_user_actions_for_assets
      • get_entity_relationship_map_for_asset
      • get_glossary
      • get_glossary_term
      • list_glossaries
      • list_glossary_terms
      • perform_catalog_search
      • update_glossary
      • update_glossary_term
    • CodeRepositories
      • create_code_repository
      • delete_code_repository
      • get_code_repository
      • list_code_repositories
      • update_code_repository
    • DataPipelines
      • create_data_pipeline
      • delete_data_pipeline
      • generate_data_pipeline_node_logs
      • get_data_pipeline_details
      • get_data_pipeline_execution_details
      • get_data_pipeline_file_load_manifest
      • get_data_pipeline_node_logs
      • list_data_pipeline_executions
      • list_data_pipelines
      • stop_data_pipeline_execution
      • trigger_data_pipeline_execution
      • update_data_pipeline
    • Datalabs
      • create_datalab
      • create_datalab_lifecycle_configuration
      • delete_datalab
      • delete_datalab_lifecycle_configuration
      • delete_datalab_session
      • get_datalab
      • get_datalab_lifecycle_configuration_details
      • get_datalab_logs
      • get_datalab_resource_access
      • list_datalab_lifecycle_configurations
      • list_datalab_sessions
      • list_datalabs
      • list_datalabs_apps
      • stop_datalab_session
      • trigger_datalab_resource_access_update
      • update_datalab
      • update_datalab_lifecycle_configuration
      • view_datalab_logs_paginated
    • Datasets
      • approve_or_reject_ai_generated_labels
      • approve_or_reject_ai_generated_summaries
      • bulk_delete_datasets
      • bulk_update_datasets
      • complete_dataset_registration
      • create_data_classification
      • create_data_permissions_on_dataset
      • create_dataset
      • create_domain
      • create_iceberg_optimizer
      • delete_data_classification
      • delete_data_permissions_on_dataset
      • delete_dataset
      • delete_dataset_files
      • delete_dataset_lifecycle_policy
      • delete_domain
      • delete_iceberg_optimizer
      • delete_pending_dataset_reload_files
      • delete_pending_iceberg_dataset_files
      • download_dataset_file
      • export_dataset_to_s3
      • generate_dataset_file_summaries
      • generate_labels_for_dataset_file
      • get_analytics_of_dataset_file
      • get_data_classification
      • get_data_load_statistics_of_dataset
      • get_data_load_throttling_details
      • get_dataload_status
      • get_datareloads_history_of_dataset
      • get_dataset
      • get_dataset_data
      • get_dataset_file_summaries
      • get_dataset_files_access
      • get_domain
      • get_file_upload_url_for_dataset
      • get_labels_for_dataset_file
      • get_models_run_status_of_dataset_file
      • get_sample_file_upload_url_for_dataset
      • get_user_data_permissions_on_dataset
      • list_data_classifications
      • list_data_permissions_on_dataset
      • list_dataset_dependent_resources
      • list_dataset_files
      • list_datasets
      • list_domains
      • list_iceberg_optimizer_runs
      • list_iceberg_optimizers
      • list_models_of_dataset_file
      • refresh_materialized_dataset
      • run_model_on_dataset_file
      • search_dataset_files_metadata
      • sync_dataset_partitions
      • trigger_adhoc_operation
      • trigger_files_reload_on_dataset
      • trigger_iceberg_dataload_job_on_dataset
      • update_column_tags_data_permissions_on_dataset
      • update_data_classification
      • update_data_load_throttling_details
      • update_data_permissions_on_dataset
      • update_dataset
      • update_domain
      • update_iceberg_optimizer
      • update_user_data_permissions_on_dataset
      • upload_file_to_dataset
    • Datasources
      • add_datasource_asset_comment
      • delete_datasource_asset_comment
      • get_datasource_asset
      • get_datasource_sync_job
      • list_datasource_asset_comments
      • list_datasource_assets
      • list_datasource_sync_jobs
      • trigger_datasource_sync_job
      • update_datasource_asset
    • EtlJobs
      • create_etl_job
      • create_shared_job_library
      • delete_etl_job
      • delete_shared_job_library
      • generate_etl_job_execution_logs
      • get_download_script_url
      • get_error_diagnosis_status
      • get_etl_job_details
      • get_etl_job_execution_logs
      • get_etl_job_execution_status
      • get_job_execution_bookmark
      • get_job_library_download_url
      • get_job_library_upload_url
      • get_resource_access_update_status
      • get_shared_job_library_details
      • get_url_for_script_upload
      • get_url_to_download_job_libraries
      • get_url_to_upload_libraries
      • list_all_job_libraries
      • list_etl_job_executions
      • list_etl_jobs
      • list_job_library_dependents
      • stop_etl_job_execution
      • trigger_error_diagnosis
      • trigger_etl_job_execution
      • trigger_resource_access_update
      • trigger_shared_library_kb_synchronization
      • update_etl_job
      • update_etl_job_libraries
      • update_shared_job_library_details
    • EventRules
      • get_rule_details
      • list_event_rules
      • perform_rule_operation
    • IamCredentials
      • get_athena_session_credentials
    • Lineage
      • get_lineage_for_resource
      • list_lineage_events_for_resource
    • MachineLearning
      • create_model
      • delete_model
      • get_model
      • get_model_presigned_url
      • get_model_run_logs_of_dataset
      • list_models
      • list_unregistered_models
      • update_model
    • Management
      • create_role
      • delete_role
      • get_role
      • get_system_information
      • list_roles
      • send_app_usage
      • update_role
    • MetadataGeneration
      • generate_payload_for_resource
      • get_resource_payload_generation_url
    • Nl2sql
      • add_training_data
      • delete_training_document
      • get_training_document_details
      • get_training_documents
      • list_sync_jobs
      • trigger_documents_sync
    • ParameterStore
      • create_parameter
      • delete_parameter
      • get_parameter
      • list_parameters
      • update_parameter
    • Playground
      • create_query_workbook
      • delete_query_workbook
      • get_query_details
      • get_query_result_download_url
      • get_query_results
      • get_query_workbook
      • list_queries
      • list_query_workbooks
      • start_query_execution
      • stop_query_execution
      • update_query_workbook
    • ResourceAccess
      • get_authorized_users_or_tags_of_resource
      • grant_resource_access
      • revoke_resource_access
    • ResourceAuditLogs
      • get_audit_logs_of_resource
    • ResourceMetrics
      • get_resource_metrics
    • RetrieveResourceNames
      • get_resource_by_resource_name
    • Schedules
      • create_schedule
      • delete_schedule
      • disable_schedule
      • enable_schedule
      • get_schedule_details
      • get_schedule_execution_details
      • get_schedule_executions
      • list_schedules
      • list_schedules_for_resource_type
      • run_schedule
      • stop_schedule_execution
      • update_schedule

Model Reference:

  • Model Reference
    • AccessToken
    • AccessTokenInput
    • AccessTokenPostOutput
    • AccessTokenPutInput
    • AccessTokensList
    • ActionObj
    • ActionObjActionArgs
    • AddOrRemoveStewardsRequestBody
    • AddResourcesToKnowledgeBase200Response
    • AdhocTriggerJobRequest
    • AdvancedConfig
    • AgentDetails
    • AgentToolObject
    • AgentToolParameters
    • AIChatsConfig
    • AIModelDetails
    • AIModelDetailsCostTagsInner
    • AIModelInvocation
    • AIModelInvocationResponse
    • AIModelUpdateInput
    • AIModelsListObject
    • AIModelsListResponse
    • AIServiceConfiguration
    • AIServiceConfigurationsBody
    • AllowedGuardRail
    • AppUsage
    • AssetComment
    • AssetCommentInput
    • AssetCommentsList
    • AssetDetails
    • AssetDetailsAssetSchema
    • AssetDetailsGlossaryDetailsInner
    • AssetMetadata
    • AthenaQueryPost
    • AuthorizedUsers
    • AuthorizedUsersGroups
    • AuthorizedUsersGroupsOwnersInner
    • AuthorizedUsersUsers
    • AuthorizedUsersUsersOwnersInner
    • AwsRoleBasicDetails
    • AwsRoleDetails
    • AwsRolesList
    • BatchDeleteDatasetsResponse
    • BatchUpdateDatasetMetadataInner
    • BulkUserCreateStatus
    • BulkUserCreateStatusStatus
    • CatalogResultItem
    • CatalogSearchResponse
    • CatalogUserActionsRequest
    • CatalogUserActionsResponse
    • CatalogUserActionsResponseApplicableTemplates
    • ChatDetailsResponse
    • ChatFileItem
    • ChatFilesActionRequest
    • ChatFilesActionRequestFilesInner
    • ChatFilesActionResponse
    • ChatFilesResponse
    • ChatListItem
    • ChatListResponse
    • ChatMessageItem
    • ChatMessagesResponse
    • ChunksRetrieved
    • CitationPageImageResponse
    • ClusterGroups
    • ClusterMetrics
    • ClusterMetricsClusters
    • ClusterMetricsClustersMetrics
    • ClusterResponse
    • ClusterResponseAdvancedDetails
    • ClusterResponseAdvancedDetailsClusterNodesInner
    • ClusterResponseAdvancedDetailsClusterParameterGroupsInner
    • ClusterResponseAdvancedDetailsDomainEndpointOptions
    • ClusterResponseAdvancedDetailsEBSOptions
    • ClusterResponseAdvancedDetailsEncryptionAtRestOptions
    • ClusterResponseAdvancedDetailsEnvironmentsInner
    • ClusterResponseAdvancedDetailsIamRolesInner
    • ClusterResponseAdvancedDetailsLatestRecoveryPoint
    • ClusterResponseAdvancedDetailsNamespace
    • ClusterResponseAdvancedDetailsNamespaceIamRolesInner
    • ClusterResponseAdvancedDetailsRestoreStatus
    • ClusterResponseAdvancedDetailsVpcSecurityGroupsInner
    • ClusterResponseAdvancedDetailsWorkgroup
    • ClusterResponseClusterDetails
    • ClusterResponseClusterDetailsClusterConfig
    • ClusterSchemaTables
    • ClusterSchemas
    • CodeRepositoriesList
    • CodeRepositoryCredential
    • CodeRepositoryDetails
    • CodeRepositoryPost
    • CodeRepositoryUpdate
    • ColumnNameAndType
    • ColumnTag
    • ColumnTagInput
    • CompactionConfiguration
    • CompleteRegistration
    • ComponentBasicDetails
    • ConnectionDetails
    • ConnsAppsConnectorDetails
    • ConnsAppsConnectorGetResponseBody
    • ConnsAppsConnectorRequestBody
    • ConnsAppsConnectorResponseBody
    • CostAnalysisKPIResultsByIdResponseBody
    • CostAnalysisKPIResultsByIdResponseBodyResourcesInner
    • CostAnalysisKPIResultsByIdResponseBodyServicesInner
    • CostAnalysisKPIResultsResponseBody
    • CostAnalysisKPIsByIdResponseBody
    • CostAnalysisKPIsByIdResponseBodyKPIConfig
    • CostAnalysisKPIsResponseBody
    • CostBudgetCreationObj
    • CostBudgetResponseBody
    • CostBudgetUpdationObj
    • CostBudgetsActionConfigurationsResponseBody
    • CostBudgetsActionConfigurationsUpdationBody
    • CostMgmtByBudgetResponseBody
    • CostTagsByNameResponseBody
    • CostTagsCreationObj
    • CostTagsResponseBody
    • CostTagsUpdationObj
    • CreateAgentRequestBody
    • CreateAgentRequestBodyResourceAccessMetadata
    • CreateAgentResponse
    • CreateDashboardRequest
    • CreateProjectRequestBody
    • CreateProjectResponse
    • CreateTemplate
    • CreateTemplateTemplateArguments
    • CustomRegexFilter
    • CustomWordFilters
    • DashboardDetailsResponseBody
    • DashboardDetailsResponseBodyResourcesInner
    • DashboardDetailsResponseBodyResourcesInnerResourceDetails
    • DashboardDetailsResponseBodyResourcesInnerResourceDetailsResourceConfiguration
    • DashboardListResponseBody
    • DashboardListResponseObject
    • DashboardSyncResponse
    • DataClassification
    • DataClassificationList
    • DataClassificationPut
    • DataLabsLogsResponse
    • DataLoadStatistics
    • DataLoadThrottling
    • DataMetricsCollectionOptions
    • DataPermissions
    • DataPermissionsColumns
    • DataPermissionsResponseInner
    • DataPermissionsRows
    • DataPipeline
    • DataPipelineExecutionInput
    • DataPipelineExecutionResponse
    • DataPipelineExecutionResponseNodesInner
    • DataPipelineExecutionResponseNodesInnerResource
    • DataPipelineExecutionStatus
    • DataPipelineExecutionsResponse
    • DataPipelineNodesInner
    • DataPipelineNodesInnerComputeResource
    • DataPipelineNodesInnerConditionsInner
    • DataPipelineNodesInnerInputsInner
    • DataPipelineNodesInnerOutputsInner
    • DataPipelineNodesInnerResource
    • DataPipelinesPost
    • DataPipelinesPostNodesInner
    • DataPipelinesPostResponse
    • DataPipelinesPostResponseLambdaUploadUrlsValue
    • DataPipelinesResponse
    • DataQualityCheck
    • DataQualityCheckDqConstraintsInner
    • DataQualityCheckRun
    • DataQualityCheckRunAutoConstraintSuggestionsInner
    • DataQualityCheckRunDqConstraintResultsInner
    • DataQualityChecksIdRunsGet200Response
    • DataReferenceDetails
    • DataReferenceDetailsAssetsInner
    • DataReloadPostResponse
    • DataReloads
    • DataReloadsItem
    • DatalabCreateInput
    • DatalabCreateInputAdditionalMetadata
    • DatalabCreateInputAdditionalMetadataStudioAdvancedConfig
    • DatalabCreateInputComputeMetadata
    • DatalabCreateInputResourceAccessMetadata
    • DatalabDetails
    • DatalabDetailsAdditionalMetadata
    • DatalabDetailsComputeMetadata
    • DatalabDetailsResourceAccessMetadata
    • DatalabDetailsServiceRoles
    • DatalabLifecycleConfigurationDetails
    • DatalabLifecycleConfigurationList
    • DatalabLifecycleConfigurationPost
    • DatalabLogsResponse
    • DatalabSessionsResponse
    • DatalabSessionsResponseSessionsInner
    • DatalabSessionsResponseSessionsInnerCommand
    • DatalabUpdateInput
    • DatalabUpdateInputAdditionalMetadata
    • DatalabsListResponse
    • DatalabsListResponseDatalabsInner
    • DatasetAccess
    • DatasetData
    • DatasetFiles
    • DatasetFilesFilesInner
    • DatasetFilesSearchResponse
    • DatasetIdList
    • DatasetLifeCycleRules
    • DatasetLifeCycleRulesExpirationRules
    • DatasetLifeCycleRulesTransitionRulesInner
    • DatasetMetadata
    • DatasetNameDomainAndId
    • DatasetSchema
    • DatasetSchemaTags
    • DatasetSummary
    • DatasourceAdvancedFilters
    • DatasourceDetails
    • DatasourceDetailsDatasourceConfig
    • DatasourceDetailsDatasourceConfigAuthConfig
    • DatasourceDetailsDatasourceConfigClusterConfig
    • DatasourceDetailsDatasourceConfigClusterConfigAutoScalingConfig
    • DatasourceDetailsDatasourceConfigPaginationConfig
    • DatasourceDetailsDatasourceConfigPublicKeysListInner
    • DatasourceEntityDetails
    • DatasourceEntityDetailsDataflowsInner
    • DatasourceEntityDetailsEntityConfig
    • DatasourceEntityDetailsEntityConfigScheduleConfig
    • DatasourceEntityList
    • DatasourceExecutions
    • DatasourceFlowsDetails
    • DatasourceFlowsDetailsDataTranformationConfirguration
    • DatasourceFlowsDetailsDataflowConfig
    • DatasourceFlowsDetailsDataflowConfigConsumerConfiguration
    • DatasourceFlowsDetailsDataflowConfigTableMappings
    • DatasourceFlowsDetailsDataflowConfigTableMappingsRulesInner
    • DatasourceFlowsDetailsDataflowConfigTableMappingsRulesInnerDataType
    • DatasourceFlowsDetailsDataflowConfigTableMappingsRulesInnerFiltersInner
    • DatasourceFlowsDetailsDataflowConfigTableMappingsRulesInnerFiltersInnerFilterConditionsInner
    • DatasourceFlowsDetailsDataflowConfigTableMappingsRulesInnerObjectLocator
    • DatasourceFlowsDetailsDataflowConfigTaskRetryConfig
    • DatasourceFlowsDetailsDataflowConfigTasksInner
    • DatasourceFlowsDetailsDatasetDetailsInner
    • DatasourceFlowsDetailsItemsConfigInner
    • DatasourceFlowsDetailsItemsConfigInnerItemDetailsInner
    • DatasourceFlowsDetailsItemsConfigInnerItemDetailsInnerCDCConfig
    • DatasourceFlowsDetailsItemsConfigInnerItemDetailsInnerDatasetConfig
    • DatasourceFlowsDetailsItemsConfigInnerItemDetailsInnerIngestionConfig
    • DatasourceFlowsDetailsItemsConfigInnerItemDetailsInnerIngestionConfigColumnFilters
    • DatasourceFlowsDetailsItemsConfigInnerItemDetailsInnerIngestionConfigColumnFiltersFiltersInner
    • DatasourceFlowsList
    • DatasourceFlowsUpdate
    • DatasourceFlowsUpdateDataflowConfig
    • DatasourceFlowsUpdateDataflowConfigTableMappings
    • DatasourceFlowsUpdateDatasetDetailsInner
    • DatasourceFlowsUpdateItemConfigsInner
    • DatasourceFlowsUpdateItemConfigsInnerItemDetailsInner
    • DatasourceFlowsUpdateItemConfigsInnerItemDetailsInnerIngestionConfig
    • DatasourceGetDetails
    • DatasourceGetDetailsDatasourceConfig
    • DatasourceGetDetailsDatasourceConfigClusterConfig
    • DatasourceGetDetailsDatasourceConfigS3BucketPolicy
    • DatasourceGetDetailsDatasourceConfigS3BucketPolicyStatementInner
    • DatasourceGetDetailsDatasourceConfigS3BucketPolicyStatementInnerPrincipal
    • DatasourceGetDetailsDatasourceConfigSourceConnectorProperties
    • DatasourceGetDetailsDatasourceConfigStreamAccessKeys
    • DatasourceScheduleConfig
    • DatasourceSyncJobDetails
    • DatasourceSyncJobDetailsJobMetrics
    • DatasourceSyncJobs
    • DatasourceSyncJobsSyncJobRunsInner
    • DatasourcesConnectorsIdPostRequest
    • DatasourcesDatasourceIdDataflowsIdPostRequest
    • DatasourcesList
    • DateRange
    • DeleteProjectResponse
    • DeniedTopic
    • DependentResourceObject
    • DependentResources
    • Domain
    • DomainAccess
    • DomainInfo
    • DomainParameterRequestBody
    • DomainParameterResponseBody
    • DomainUpdateObj
    • DomainUpdateObjResources
    • DomainUpdateObjResourcesDatasetsInner
    • Domains
    • DRInformation
    • DRInformationS3
    • DWHListTables
    • DWHQueryInput
    • DWHQueryResponse
    • DWHQueryResponseQueryDetails
    • DWHQueryResults
    • DWHQueryResultsQueryResults
    • EnableSchedule200Response
    • EncryptedTokenRequestBody
    • Error
    • ErrorDependentObjectNew
    • ErrorDependentObjectOld
    • ETLJob
    • ETLJobByIdResponse
    • ETLJobConnections
    • ETLJobPost
    • ETLJobPostCostTagsInner
    • ETLJobStatus
    • ETLJobUpdateBody
    • ETLJobsResponse
    • ETLLibPaths
    • ETLLibraryPostResponse
    • EventRulesList
    • ExecutionPlansPost
    • ExecutionStatus
    • ExecutionStatusExtraMetadata
    • ExecutionStatusExtraResourceAccess
    • ExecutionStatusResponse
    • ExecutionStatusesResponse
    • Executions
    • ExecutionsExecutionResult
    • ExternalTriggerMessageFormat
    • ExternalTriggerMessageFormatTriggerEvent
    • Feedback
    • FileAddDelete
    • FileAddDeleteFileLevelTagsInner
    • FileAnalytics
    • FileAnalyticsAnalytics
    • FileDownload
    • FileLoadResponse
    • FileLoadResponseFilesInner
    • FileServerUserConfigResponseModel
    • FileStatus1
    • FileUpload
    • FilesDeleteObj
    • FilesInputObj
    • FilesSearchObj
    • GenerateLabelsInputBody
    • GenerateUrlResponse
    • GetAgentDetailsResponse
    • GetAgentDetailsResponseCostInferenceProfileDetails
    • GetAgentDetailsResponseCostInferenceProfileDetailsInferenceProfileTagsInner
    • GetAgentDetailsResponseCostTagsInner
    • GetAgentDetailsResponseResourceAccessMetadata
    • GetAgentDetailsResponseTimeRange
    • GetCitationPresignedUrlRequest
    • GetErrorDiagnosisResponse
    • GetErrorDiagnosisResponseErrorDiagnosisMetadata
    • GetErrorDiagnosisResponseErrorDiagnosisMetadataMetrics
    • GetLabelsResponse
    • GetProjectDetailsResponse
    • GetProjectDetailsResponseAgentsInner
    • GetProjectDetailsResponseGuardRail
    • GetProjectDetailsResponseKnowledgeBasesInner
    • GetProjectDetailsResponseModel
    • GetResponseSAMLGroupMapping
    • GetScheduleExecutionDetails200Response
    • GetScheduleExecutions200Response
    • GetSingleResponseSAMLGroupMapping
    • GetSummaryResponse
    • GetSummaryResponseSummaryMetadata
    • GlossariesList
    • GlossaryCreateInput
    • GlossaryDetails
    • GlossaryUpdateInput
    • GroupMappingList
    • GuardRailChatRequest
    • GuardRailChatRequestModelParameters
    • GuardRailChatResponse
    • GuardRailCreateRequest
    • GuardRailDetail
    • GuardRailFilterConfig
    • GuardRailListResponse
    • GuardRailResource
    • GuardRailSummary
    • GuardRailUpdateRequest
    • Guardrail
    • HandleRequest
    • HclGetWorkflowRunResponseBody
    • HclListWorkflowRunResponseBody
    • HclListWorkflowRunsResponseBody
    • HclsActionGetResponse
    • HclsHealthImagingImagesetsList
    • HclsHealthImagingImagesetsListImageSetsInner
    • HclsJobs
    • HclsJobsByIdGetResponseBody
    • HclsJobsByIdGetResponseBodyImportJobConfig
    • HclsJobsByIdGetResponseBodyImportJobConfigDatasetDetails
    • HclsJobsByIdGetResponseBodySourcesInner
    • HclsJobsByIdGetResponseBodySourcesInnerSourceFiles
    • HclsJobsGetResponseBody
    • HclsJobsImportJobConfig
    • HclsResource
    • HclsResourceResponse
    • HclsStores
    • HclsStoresDatasetAccess
    • HclsStoresDependentResourcesInner
    • HclsStoresDependentResourcesInnerResourcesInner
    • HclsStoresGetResponseBody
    • HclsStoresStoreConfig
    • HclsWorkflowRun
    • HealthCheck
    • HighCostingServiceResponse
    • HighCostingServiceResponseServices
    • HighCostingServiceResponseServicesDataPipelinesInner
    • HighCostingServiceResponseServicesDatalabsInner
    • HighCostingServiceResponseServicesDatasourceEntitiesInner
    • HighCostingServiceResponseServicesDatasourcesInner
    • HighCostingServiceResponseServicesHealthlakeStoresInner
    • HighCostingServiceResponseServicesJobsInner
    • IAMCredentialsResponse
    • IAMCredentialsResponseIamCredentials
    • IndexHistoryInner
    • InputBody
    • InputDetails
    • JobExecLineageEventsInner
    • JobExecLineageEventsInnerExtra
    • JobExecLineageEventsInnerExtraReadMetrics
    • JobExecLineageEventsInnerExtraWriteMetrics
    • JobLibPreSigned
    • KeySchema
    • KnowledgeBaseCreateRequest
    • KnowledgeBaseDetail
    • KnowledgeBaseDetailMetrics
    • KnowledgeBaseListResponse
    • KnowledgeBaseListResponseKnowledgebasesInner
    • KnowledgeBaseQueryResponse
    • KnowledgeBaseUpdateRequest
    • KnowledgebaseResource
    • LabelAndDatapoints
    • LabelAndDatapointsDatapointsInner
    • LambdaConcurrentExecutions
    • License
    • Limits
    • LimitsResponse
    • LineageEdge
    • LineageEvent
    • LineageEventResourcesAttachedInner
    • LineageEventsResponse
    • LineageNode
    • LineageResponse
    • ListAgentsResponse
    • ListAssetResponse
    • ListProjectsResponse
    • ListSharedJobLibDetails
    • LogsRetentionPeriod
    • MailServerInfo
    • MailServerInfoObject
    • MailServerList
    • MalwareDetectionOptions
    • Message
    • MessageCounts
    • MessageStatus
    • MetadataGeneratorInput
    • MetadataGeneratorOutput
    • MetadataGeneratorOutputPayload
    • MetadataRepairBody
    • MLModelsRunStatuses
    • MLModelsRunStatusesModelrunsInner
    • ModelByIdGetResponseBody
    • ModelByIdGetResponseBodyInputSchema
    • ModelByIdGetResponseBodyInputSchemaOneOfInner
    • ModelCreateOutput
    • ModelData
    • ModelDataInputSchema
    • ModelDataInputSchemaOneOfInner
    • ModelPreSigned
    • ModelPreSignedResponse
    • ModelPutData
    • ModelsGetResponseBody
    • ModelsUnregistered
    • ModelsUnregisteredModelsInner
    • MultiFileDownload
    • MultiFileDownloadDateRange
    • MultiTagUpdationObj
    • NL2SQLDocumentsSyncJobDetails
    • NL2SQLDocumentsSyncJobs
    • NL2SQLTrainingDocumentDetails
    • NL2SQLTrainingDocumentsList
    • NL2SQLTrainingDocumentsPost
    • NodeNameList
    • NoteCreateRequest
    • NoteDetailsResponse
    • NoteUpdateRequest
    • NoteUpdateResponse
    • NotesCreateResponse
    • NotesListItem
    • NotesListResponse
    • NotificationEvent
    • NotificationEventNotification
    • NotificationEventsList
    • NotificationsDeleteRequestBody
    • NotificationsRequestBody
    • NotificationsRequestBodyResourcesInner
    • NotificationsResponseBody
    • NotificationsResponseBodyNotificationsInner
    • NotificationsResponseBodyNotificationsInnerResourcesInner
    • NotificationsResponseBodyNotificationsInnerResourcesInnerEmail
    • OpensearchindexAction
    • OperationsResponse
    • OptimizerConfiguration
    • OptimizerCreateUpdateResponse
    • OptimizerDeleteResponse
    • OptimizerListResponse
    • OptimizerResponse
    • OptimizerRun
    • OptimizerRunsResponse
    • OrphanFileDeletionConfiguration
    • ParametersListResponseBody
    • ParametersPutRequestBody
    • ParametersRequestBody
    • ParametersResponseBody
    • PasswordUpdate
    • PiiTypeFilter
    • PostAppUsageBody
    • PostAppUsageBodyAdditionalInfo
    • PostAppUsageResponse
    • PreSigned
    • PreSignedResponse
    • PresignedUrlResponse
    • PreviousObjectVersions
    • ProjectListItem
    • QMRulePredicates
    • QMRules
    • QueriesAndLoadsResponse
    • QueriesAndLoadsResponseQueryResults
    • QueryBody
    • QueryResponse
    • QueryResponses
    • QueryResult
    • QueryWorkbookCreate
    • QueryWorkbookCreateResponse
    • QueryWorkbookDetails
    • QueryWorkbookDetailsChatConfiguration
    • QueryWorkbookDetailsChatConfigurationQueryOn
    • QueryWorkbookMessage
    • QueryWorkbookUpdate
    • QueryWorkbooksList
    • RegisteredDataset
    • RegisteredDatasetDataCategoryConfig
    • RegisteredDatasetDatasetReport
    • RegisteredDatasetDatasetReportEntities
    • RegisteredDatasetDatasetReportKeyPhrasesInner
    • RegisteredDatasetDatasetReportSentimentAnalysis
    • RegisteredDatasetDatasetReportSentimentAnalysisSentimentScore
    • RegisteredDatasetDatasetReportSentimentAnalysisSentimentScoreSentimentScore
    • RegisteredDatasetHudiTableOptions
    • RegisteredDatasetIcebergTableOptions
    • RegisteredDatasetList
    • RegisteredDatasetSchedulesInner
    • RegisteredDatasetSyncToS3Options
    • RegisteredDatasetSyncToS3OptionsLastModifiedBy
    • RegisteredDatasetViewVersionsInner
    • RequestAccess
    • ResourceAccessDetails
    • ResourceAccessGrantInput
    • ResourceAccessGrantInputAdditionalMetadata
    • ResourceAccessInput
    • ResourceAccessResponse
    • ResourceAccessRevokeInput
    • ResourceAdditionRequest
    • ResourceAdditionRequestChunkingConfiguration
    • ResourceAdditionRequestParsingConfiguration
    • ResourceAuditLogsOutput
    • ResourceAuditLogsOutputAuditLogsInner
    • ResourceIds
    • ResourceMetadata
    • ResourceMetrics
    • ResourceMetricsDataPoint
    • ResourceMetricsItem
    • ResourceMetricsMessage
    • ResourceResponse
    • ResourceStatsOutputInner
    • ResourceTagsResponseBody
    • RetentionConfiguration
    • RoleDetails
    • RoleDetailsList
    • RoleInfo
    • RoleMetadata
    • RolesPostResponse
    • RuleDetails
    • RunModel
    • RunSchedule200Response
    • RunsResponse
    • RunsResponseJobrunsInner
    • RunsResponseJobrunsInnerMetrics
    • SAMLGroupMapping
    • SAMLGroupMappingUpdate
    • ScheduleDetailsInner
    • ScheduleExecution
    • ScheduleExecutionScheduleExecution
    • ScheduleExecutionScheduleExecutionExtraMetadata
    • ScheduleId
    • ScheduleJob
    • ScheduleJobEdit
    • ScheduleParam
    • ScheduledJobArgument
    • ScheduledJobStatus
    • ScheduledJobStatusList
    • SensitiveInformationFilters
    • ServiceLimit
    • ServiceLimitThreshold
    • ServiceLimitsResponse
    • ServiceUserAuthTokenRequest
    • SharedJobLibDetails1
    • SharedJobLibInfo
    • SharedLibraryResource
    • SourceDetail
    • SourceUpdateRequest
    • Status
    • StudioApp
    • StudioAppsList
    • SystemAlertsInfo
    • SystemConfiguration
    • SystemConfigurationApplicationTags
    • SystemConfigurationCatalogSearchConfiguration
    • SystemConfigurationDomains
    • SystemConfigurationWebSearchConfiguration
    • SystemConfigurationWhitelistedIPs
    • SystemInformation
    • TagObject
    • TagsByNameResponseBody
    • TagsByNameResponseBodyUsersAttachedInner
    • TagsCreationObj
    • TagsListResponseBody
    • TagsResponseBody
    • TagsUpdationObj
    • TbacTag
    • Template
    • TemplatesList
    • Tenant
    • TenantResponseBody
    • TenantResponseBodyResources
    • Tenants
    • TermBasicDetails
    • TermCreateInput
    • TermDetails
    • TermUpdateInput
    • TermsList
    • TimePeriod
    • TimestampRange
    • TimestampRangeWithNextToken
    • TokenResponse
    • TriggerDocumentsSyncRequest
    • TriggerSharedLibraryKbSynchronization200Response
    • UpdateAgentRequestBody
    • UpdateAgentRequestBodyResourceAccessMetadata
    • UpdateAiModelConfigurationsRequest
    • UpdateAwsRoleInfo
    • UpdateChatRequest
    • UpdateDashboardRequest
    • UpdateDatasetMetadata
    • UpdateMailServerInfo
    • UpdateNotificationEvents
    • UpdateProjectOrAvatarResponse
    • UpdateProjectRequestBody
    • UpdateRoleInfo
    • UpdateSharedJobLibInfo
    • UpdateSummaryInputBody
    • UpdateSystemConfiguration
    • UpdateSystemConfigurationWebSearchConfiguration
    • UpdateTemplate
    • UpdateUserDelete
    • Usage
    • UsageByService
    • UsagePatternObject
    • User
    • UserAccessObj
    • UserAgreementInput
    • UserAgreementResponseBody
    • UserAgreementStatus
    • UserAgreementsResponseBody
    • UserAgreementsResponseBodyUserAgreementsInner
    • UserCreateDetails
    • UserCreateDetailsUserDetails
    • UserDataPermissions
    • UserDevice
    • UserPreferences
    • UserPreferencesCustomTags
    • UserRequests
    • UserRequestsRequestsSent
    • UserResource
    • UserResources
    • UserResourcesCodeRepositoriesInner
    • UserResourcesDashboardsInner
    • UserResourcesDataPipelinesInner
    • UserResourcesDataQualityChecksInner
    • UserResourcesDatalabLifecycleConfigurationsInner
    • UserResourcesDatalabsInner
    • UserResourcesDatasourcesInner
    • UserResourcesDomainNamesInner
    • UserResourcesEtlJobsInner
    • UserResourcesGroups
    • UserResourcesGroupsAdminInner
    • UserResourcesModelsInner
    • UserResourcesParameters
    • UserResourcesRolesInner
    • UserResourcesSchedulesInner
    • UserResponse
    • UsersResponse
    • UsersResponseUsersInner
    • VerticalByIdResponseBody
    • VerticalsResponseBody
    • VerticalsUserUpdateObj
    • VerticalsUsersResponseBodyInner
    • WhitelistIPAddresses
    • WidgetsInner
    • WLMConfigResponse
    • WLMQueueConfig
    • WLMQueueUpdRequestBody

Examples:

  • Examples
  • Getting Started with Wrapper Classes
  • Dataset Management Examples
  • User Management Examples
  • Management Examples
  • Discovery and Help Examples
Back to top

perform_catalog_search¶

CatalogApi.perform_catalog_search(role_id, limit=None, get_metrics=None, page_number=None, query=None, fields_to_match=None, access_level=None, start_time=None, end_time=None, time_field=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)[source]¶

Search assets in catalog

search assets in catalog

Parameters:
  • role_id (str) – (required)

  • limit (str)

  • get_metrics (str)

  • page_number (str)

  • query (str)

  • fields_to_match (str)

  • access_level (str)

  • start_time (str)

  • end_time (str)

  • time_field (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

CatalogSearchResponse

Returns:

Returns the result object.

Next
update_glossary
Previous
list_glossary_terms
Made with Furo
On this page
  • perform_catalog_search
    • CatalogApi.perform_catalog_search()