Update

Updates the specified symmetric KMS key.

TypeScript

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

const SymmetricAlgorithm = cloudApi.kms.symmetric_key.SymmetricAlgorithm;
const SymmetricKey = cloudApi.kms.symmetric_key.SymmetricKey;
const SymmetricKey_Status = cloudApi.kms.symmetric_key.SymmetricKey_Status;
const UpdateSymmetricKeyRequest =
  cloudApi.kms.symmetric_key_service.UpdateSymmetricKeyRequest;

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

  const operation = await client.update(
    UpdateSymmetricKeyRequest.fromPartial({
      keyId: "keyId",
      updateMask: {
        // paths: ["paths"]
      },
      // name: "name",
      // description: "description",
      // status: SymmetricKey_Status.CREATING,
      // labels: {"key": "labels"},
      // defaultAlgorithm: SymmetricAlgorithm.AES_128,
      // rotationPeriod: {
      // seconds: 0,
      // nanos: 0
      // },
      // deletionProtection: true
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.kms.v1.symmetric_key_pb2 import SymmetricAlgorithm
from yandex.cloud.kms.v1.symmetric_key_pb2 import SymmetricKey
from yandex.cloud.kms.v1.symmetric_key_service_pb2_grpc import SymmetricKeyServiceStub
from yandex.cloud.kms.v1.symmetric_key_service_pb2 import UpdateSymmetricKeyMetadata
from yandex.cloud.kms.v1.symmetric_key_service_pb2 import UpdateSymmetricKeyRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SymmetricKeyServiceStub)
operation = service.Update(
    UpdateSymmetricKeyRequest(
        key_id="keyId",
        update_mask=FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # status = SymmetricKey.Status.CREATING,
        # labels = {"key": "labels"},
        # default_algorithm = SymmetricAlgorithm.AES_128,
        # rotation_period = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # deletion_protection = true
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=SymmetricKey,
    meta_type=UpdateSymmetricKeyMetadata,
)
print(operation_result)

UpdateSymmetricKeyRequest

keyId : string

ID of the symmetric KMS key to update. To get the ID of a symmetric KMS key use a SymmetricKeyService.List request.

updateMask : google.protobuf.FieldMask

Field mask that specifies which attributes of the symmetric KMS key are going to be updated.

name : string

New name for the symmetric KMS key.

description : string

New description for the symmetric KMS key.

status : SymmetricKey.Status

New status for the symmetric KMS key. Using the SymmetricKeyService.Update method you can only set ACTIVE or INACTIVE status.

labels : string

Custom labels for the symmetric KMS key as key:value pairs. Maximum 64 per key.

defaultAlgorithm : SymmetricAlgorithm

Default encryption algorithm to be used with new versions of the symmetric KMS key.

rotationPeriod : google.protobuf.Duration

Time period between automatic symmetric KMS key rotations.

deletionProtection : bool

Flag that inhibits deletion of the symmetric KMS key

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.

---