Update

Updates the specified key pair.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Key = cloudApi.iam.key.Key;
const UpdateKeyRequest = cloudApi.iam.key_service.UpdateKeyRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.KeyServiceClient);

  const operation = await client.update(
    UpdateKeyRequest.fromPartial({
      keyId: "keyId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // description: "description"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Key>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.iam.v1.key_pb2 import Key
from yandex.cloud.iam.v1.key_service_pb2_grpc import KeyServiceStub
from yandex.cloud.iam.v1.key_service_pb2 import UpdateKeyMetadata
from yandex.cloud.iam.v1.key_service_pb2 import UpdateKeyRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(KeyServiceStub)
operation = service.Update(
    UpdateKeyRequest(
        key_id="keyId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # description = "description"
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Key,
    meta_type=UpdateKeyMetadata,
)
print(operation_result)

UpdateKeyRequest

keyId : string

ID of the Key resource to update. To get key pair ID, use a KeyService.List request.

updateMask : google.protobuf.FieldMask

Field mask that specifies which fields of the Key resource are going to be updated.

description : string

Description of the key pair.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp

The time when the Operation resource was last modified.

done : bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  The normal response of the operation in case of success.

  If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

---