Updated on 2025-02-14 GMT+08:00

Adding a Metadata Event Subscriber

Function

This API is used to add a metadata event subscriber.

URI

POST /v1/{project_id}/instances/{instance_id}/metadata-event/subscribers

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

instance_id

Yes

String

LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Tenant token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

subscriber_name

Yes

String

Subscriber name: DATAARTS_STUDIO

Enumeration values:

  • DATAARTS_STUDIO

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

subscriber_name

String

Subscriber name: DATAARTS_STUDIO

Enumeration values:

  • DATAARTS_STUDIO

Example Requests

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/metadata-event/subscribers

{
  "subscriber_name" : "DATAARTS_STUDIO"
}

Example Responses

Status code: 201

Created

{
  "subscriber_name" : "DATAARTS_STUDIO"
}

Status Codes

Status Code

Description

201

Created

Error Codes

See Error Codes.