Class SymmetricKeyService

constructor

• new SymmetricKeyService(sdk: SDKInterface): SymmetricKeyService

  Parameters

  • sdk: SDKInterface

  Returns SymmetricKeyService

$type

create

• create(
      request: CreateSymmetricKeyRequest,
  ): Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Creates a symmetric KMS key in the specified container.

  Parameters

  • request: CreateSymmetricKeyRequest

  Returns Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CreateSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSymmetricKeyRequest,
  ): Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Creates a symmetric KMS key in the specified container.

  Parameters

  • request: CreateSymmetricKeyRequest

  Returns Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Creates a symmetric KMS key in the specified container.

  Parameters

  • request: CreateSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Creates a symmetric KMS key in the specified container.

  Parameters

  • request: CreateSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateSymmetricKeyRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteSymmetricKeyRequest,
  ): Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Schedules a symmetric KMS key for deletion.

  Parameters

  • request: DeleteSymmetricKeyRequest

  Returns Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: DeleteSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSymmetricKeyRequest,
  ): Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Schedules a symmetric KMS key for deletion.

  Parameters

  • request: DeleteSymmetricKeyRequest

  Returns Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Schedules a symmetric KMS key for deletion.

  Parameters

  • request: DeleteSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Schedules a symmetric KMS key for deletion.

  Parameters

  • request: DeleteSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

get

• get(
      request: GetSymmetricKeyRequest,
  ): Request<GetSymmetricKeyRequest, SymmetricKey>

  Returns the specified symmetric KMS key by id.

  Parameters

  • request: GetSymmetricKeyRequest

  Returns Request<GetSymmetricKeyRequest, SymmetricKey>

• get(
      request: GetSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<GetSymmetricKeyRequest, SymmetricKey>

  Parameters

  • request: GetSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<GetSymmetricKeyRequest, SymmetricKey>

• get(
      request: GetSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSymmetricKeyRequest, SymmetricKey>

  Parameters

  • request: GetSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSymmetricKeyRequest, SymmetricKey>

• get(
      request: GetSymmetricKeyRequest,
  ): Request<GetSymmetricKeyRequest, SymmetricKey>

  Returns the specified symmetric KMS key by id.

  Parameters

  • request: GetSymmetricKeyRequest

  Returns Request<GetSymmetricKeyRequest, SymmetricKey>

• get(
      request: GetSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<GetSymmetricKeyRequest, SymmetricKey>

  Returns the specified symmetric KMS key by id.

  Parameters

  • request: GetSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<GetSymmetricKeyRequest, SymmetricKey>

• get(
      request: GetSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSymmetricKeyRequest, SymmetricKey>

  Returns the specified symmetric KMS key by id.

  Parameters

  • request: GetSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSymmetricKeyRequest, SymmetricKey>

getByName

• getByName(
      request: GetSymmetricKeyByNameRequest,
  ): Request<GetSymmetricKeyByNameRequest, SymmetricKey>

  Returns the specified symmetric KMS key by name.

  Parameters

  • request: GetSymmetricKeyByNameRequest

  Returns Request<GetSymmetricKeyByNameRequest, SymmetricKey>

• getByName(
      request: GetSymmetricKeyByNameRequest,
      metadata: Metadata,
  ): Request<GetSymmetricKeyByNameRequest, SymmetricKey>

  Parameters

  • request: GetSymmetricKeyByNameRequest
  • metadata: Metadata

  Returns Request<GetSymmetricKeyByNameRequest, SymmetricKey>

• getByName(
      request: GetSymmetricKeyByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSymmetricKeyByNameRequest, SymmetricKey>

  Parameters

  • request: GetSymmetricKeyByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSymmetricKeyByNameRequest, SymmetricKey>

• getByName(
      request: GetSymmetricKeyByNameRequest,
  ): Request<GetSymmetricKeyByNameRequest, SymmetricKey>

  Returns the specified symmetric KMS key by name.

  Parameters

  • request: GetSymmetricKeyByNameRequest

  Returns Request<GetSymmetricKeyByNameRequest, SymmetricKey>

• getByName(
      request: GetSymmetricKeyByNameRequest,
      metadata: Metadata,
  ): Request<GetSymmetricKeyByNameRequest, SymmetricKey>

  Returns the specified symmetric KMS key by name.

  Parameters

  • request: GetSymmetricKeyByNameRequest
  • metadata: Metadata

  Returns Request<GetSymmetricKeyByNameRequest, SymmetricKey>

• getByName(
      request: GetSymmetricKeyByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSymmetricKeyByNameRequest, SymmetricKey>

  Returns the specified symmetric KMS key by name.

  Parameters

  • request: GetSymmetricKeyByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSymmetricKeyByNameRequest, SymmetricKey>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

• list(
      request: ListSymmetricKeysRequest,
  ): Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

  Returns the list of symmetric KMS keys in the specified container.

  Parameters

  • request: ListSymmetricKeysRequest

  Returns Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

• list(
      request: ListSymmetricKeysRequest,
      metadata: Metadata,
  ): Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

  Parameters

  • request: ListSymmetricKeysRequest
  • metadata: Metadata

  Returns Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

• list(
      request: ListSymmetricKeysRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

  Parameters

  • request: ListSymmetricKeysRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

• list(
      request: ListSymmetricKeysRequest,
  ): Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

  Returns the list of symmetric KMS keys in the specified container.

  Parameters

  • request: ListSymmetricKeysRequest

  Returns Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

• list(
      request: ListSymmetricKeysRequest,
      metadata: Metadata,
  ): Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

  Returns the list of symmetric KMS keys in the specified container.

  Parameters

  • request: ListSymmetricKeysRequest
  • metadata: Metadata

  Returns Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

• list(
      request: ListSymmetricKeysRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

  Returns the list of symmetric KMS keys in the specified container.

  Parameters

  • request: ListSymmetricKeysRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSymmetricKeysRequest, ListSymmetricKeysResponse>

rotate

• rotate(
      request: RotateSymmetricKeyRequest,
  ): Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

  Parameters

  • request: RotateSymmetricKeyRequest

  Returns Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

• rotate(
      request: RotateSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: RotateSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

• rotate(
      request: RotateSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: RotateSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

• rotate(
      request: RotateSymmetricKeyRequest,
  ): Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

  Parameters

  • request: RotateSymmetricKeyRequest

  Returns Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

• rotate(
      request: RotateSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

  Parameters

  • request: RotateSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

• rotate(
      request: RotateSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

  Parameters

  • request: RotateSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<RotateSymmetricKeyRequest, Operation<GetOperationRequest>>

undelete

• undelete(
      request: UndeleteSymmetricKeyRequest,
  ): Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Restores a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteSymmetricKeyRequest

  Returns Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UndeleteSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UndeleteSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSymmetricKeyRequest,
  ): Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Restores a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteSymmetricKeyRequest

  Returns Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Restores a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

  Restores a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UndeleteSymmetricKeyRequest, Operation<GetOperationRequest>>

update

• update(
      request: UpdateSymmetricKeyRequest,
  ): Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Updates a symmetric KMS key.

  Parameters

  • request: UpdateSymmetricKeyRequest

  Returns Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Parameters

  • request: UpdateSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSymmetricKeyRequest,
  ): Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Updates a symmetric KMS key.

  Parameters

  • request: UpdateSymmetricKeyRequest

  Returns Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSymmetricKeyRequest,
      metadata: Metadata,
  ): Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Updates a symmetric KMS key.

  Parameters

  • request: UpdateSymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSymmetricKeyRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

  Updates a symmetric KMS key.

  Parameters

  • request: UpdateSymmetricKeyRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSymmetricKeyRequest, Operation<GetOperationRequest>>

updateDeletionDelay

• updateDeletionDelay(
      request: UpdateSymmetricKeyDeletionDelayRequest,
  ): Request<
      UpdateSymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateSymmetricKeyDeletionDelayRequest

  Returns Request<UpdateSymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateSymmetricKeyDeletionDelayRequest,
      metadata: Metadata,
  ): Request<
      UpdateSymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Parameters

  • request: UpdateSymmetricKeyDeletionDelayRequest
  • metadata: Metadata

  Returns Request<UpdateSymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateSymmetricKeyDeletionDelayRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      UpdateSymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Parameters

  • request: UpdateSymmetricKeyDeletionDelayRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateSymmetricKeyDeletionDelayRequest,
  ): Request<
      UpdateSymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateSymmetricKeyDeletionDelayRequest

  Returns Request<UpdateSymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateSymmetricKeyDeletionDelayRequest,
      metadata: Metadata,
  ): Request<
      UpdateSymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateSymmetricKeyDeletionDelayRequest
  • metadata: Metadata

  Returns Request<UpdateSymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateSymmetricKeyDeletionDelayRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      UpdateSymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for a symmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateSymmetricKeyDeletionDelayRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>