Updated on 2024-02-21 GMT+08:00

Updating a Service Access Client

Function

This API is used to update service access clients by ID.

URI

PUT /v1/{project_id}/instances/{instance_id}/access-clients/{client_id}

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 (lakeformation_04_0026.xml).

instance_id

Yes

String

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

client_id

Yes

String

Client ID. The value is automatically generated when the client is created.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Client name. The value should contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed.

Response Parameters

None

Example Requests

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/access-clients/{client_id}

{
  "name" : "lakeformation_client"
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful upgrade.

Error Codes

See Error Codes.