lib/oci/key_management/kms_management_client.rb
# Updates the properties of a master encryption key. Specifically, you can update the
# `displayName`, `freeformTags`, and `definedTags` properties. Furthermore,
# the key must be in an `ENABLED` or `CREATING` state to be updated.
#
# As a management operation, this call is subject to a Key Management limit that applies to the total number
# of requests across all management write operations. Key Management might throttle this call to reject an
# otherwise valid request when the total rate of management write operations exceeds 10 requests per second
# for a given tenancy.
#
# @param [String] key_id The OCID of the key.
# @param [OCI::KeyManagement::Models::UpdateKeyDetails] update_key_details UpdateKeyDetails
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
#   resource, set the `if-match` parameter to the value of the etag from a
#   previous GET or POST response for that resource. The resource will be
#   updated or deleted only if the etag you provide matches the resource's
#   current etag value.
#
# @option opts [String] :opc_request_id Unique identifier for the request. If provided, the returned request ID
#   will include this value. Otherwise, a random request ID will be
#   generated by the service.
#
# @return [Response] A Response object with data of type {OCI::KeyManagement::Models::Key Key}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/keymanagement/update_key.rb.html) to see an example of how to use update_key API.
Updates the properties of a master encryption key.

As a management operation, this call is subject to a Key Management limit that applies to the total number
of requests across all management write operations. Key Management might throttle this call to reject an
otherwise valid request when the total rate of management write operations exceeds 10 requests per second
for a given tenancy.
Updates the properties of a master encryption key . As a management operation this call is subject to a Key Management limit that applies to the total number of requests across all management write operations . Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy .
def update_key(key_id, update_key_details, opts = {})
      logger.debug 'Calling operation KmsManagementClient#update_key.' if logger
      raise "Missing the required parameter 'key_id' when calling update_key." if key_id.nil?
      raise "Missing the required parameter 'update_key_details' when calling update_key." if update_key_details.nil?
      raise "Parameter value for 'key_id' must not be blank" if OCI::Internal::Util.blank_string?(key_id)
      path = '/20180608/keys/{keyId}'.sub('{keyId}', key_id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
      post_body = @api_client.object_to_http_body(update_key_details)
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsManagementClient#update_key') do
        @api_client.call_api(
          :PUT,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'OCI::KeyManagement::Models::Key'
        )
      end
    end
def update_key ( key_id , update_key_details , opts = { } ) logger . debug 'Calling operation KmsManagementClient#update_key.' if logger raise "Missing the required parameter 'key_id' when calling update_key." if key_id . nil? raise "Missing the required parameter 'update_key_details' when calling update_key." if update_key_details . nil? raise "Parameter value for 'key_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( key_id ) path = '/20180608/keys/{keyId}' . sub ( '{keyId}' , key_id . to_s ) operation_signing_strategy = :standard query_params = { } header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :' if-match ' ] = opts [ :if_match ] if opts [ :if_match ] header_params [ :' opc-request-id ' ] = opts [ :opc_request_id ] if opts [ :opc_request_id ] post_body = @api_client . object_to_http_body ( update_key_details ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'KmsManagementClient#update_key' ) do @api_client . call_api ( :PUT , path , endpoint , header_params : header_params , query_params : query_params , operation_signing_strategy : operation_signing_strategy , body : post_body , return_type : 'OCI::KeyManagement::Models::Key' ) end end
Updates the properties of a master encryption key.
Updates the properties of a master encryption key .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::KeyManagement::Models::Key Key}
A Response object with data of type { OCI :: KeyManagement :: Models :: Key Key }
Response
key_id
update_key_details
opts
:opc_request_id Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
: opc_request_id Unique identifier for the request . If provided the returned request ID will include this value . Otherwise a random request ID will be generated by the service .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use update_key API.
Click [ here ] to see an example of how to use update_key API .