2023-04-25 16:58:47 +02:00
---
title: metadataService
slug: /main-concepts/metadata-standard/schemas/entity/services/metadataservice
---
# Metadata Service
*This schema defines the Metadata Service entity, such as Amundsen, Atlas etc.*
## Properties
- **`id` **: Unique identifier of this database service instance. Refer to *../../type/basic.json#/definitions/uuid* .
- **`name` **: Name that identifies this database service. Refer to *../../type/basic.json#/definitions/entityName* .
- **`fullyQualifiedName` **: FullyQualifiedName same as `name` . Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName* .
- **`displayName` ** *(string)* : Display Name that identifies this database service.
- **`serviceType` **: Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... Refer to *#/definitions/metadataServiceType* .
- **`description` **: Description of a database service instance. Refer to *../../type/basic.json#/definitions/markdown* .
- **`connection` **: Refer to *#/definitions/metadataConnection* .
2023-08-27 10:55:55 +02:00
- **`pipelines` **: References to pipelines deployed for this database service to extract metadata, usage, lineage etc.. Refer to *../../type/entityReferenceList.json#/definitions/entityReferenceList* .
2023-04-25 16:58:47 +02:00
- **`version` **: Metadata version of the entity. Refer to *../../type/entityHistory.json#/definitions/entityVersion* .
- **`updatedAt` **: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *../../type/basic.json#/definitions/timestamp* .
- **`updatedBy` ** *(string)* : User who made the update.
2023-08-27 10:55:55 +02:00
- **`testConnectionResult` **: Last test connection results for this service. Refer to *connections/testConnectionResult.json* .
- **`tags` ** *(array)* : Tags for this Metadata Service. Default: `None` .
- **Items**: Refer to *../../type/tagLabel.json* .
2023-04-25 16:58:47 +02:00
- **`owner` **: Owner of this database service. Refer to *../../type/entityReference.json* .
- **`href` **: Link to the resource corresponding to this database service. Refer to *../../type/basic.json#/definitions/href* .
- **`changeDescription` **: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription* .
- **`deleted` ** *(boolean)* : When `true` indicates the entity has been soft deleted. Default: `False` .
2023-08-27 10:55:55 +02:00
- **`provider` **: Refer to *../../type/basic.json#/definitions/providerType* .
2023-04-25 16:58:47 +02:00
## Definitions
2023-08-27 10:55:55 +02:00
- **`metadataServiceType` ** *(string)* : Type of database service such as Amundsen, Atlas... Must be one of: `['Amundsen', 'MetadataES', 'OpenMetadata', 'Atlas']` .
2023-04-25 16:58:47 +02:00
- **`metadataConnection` ** *(object)* : Metadata Service Connection. Cannot contain additional properties.
- **`config` **
2023-08-27 10:55:55 +02:00
Documentation file automatically generated at 2023-07-07 05:50:35.981927.