Get the endpoint that is being used to call (ex, https://www.example.com).
Sets the endpoint to call (ex, https://www.example.com).
The endpoint of the service.
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
flag to enable the use of realm specific endpoint template
Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later. The file also contains the metadata of the vault that the key belonged to.
This operation does not retry by default if the user has not defined a retry configuration.
BackupKeyResponse
Cancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key's lifecycle state to what it was before its scheduled deletion.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
CancelKeyDeletionResponse
Cancels the scheduled deletion of the specified key version. Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled deletion.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
CancelKeyVersionDeletionResponse
Moves a key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When provided, if-match is checked against the ETag values of the key.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
ChangeKeyCompartmentResponse
Close the client once it is no longer needed
Creates a new 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.
This operation does not retry by default if the user has not defined a retry configuration.
CreateKeyResponse
Generates a new KeyVersion resource that provides new cryptographic
material for a master encryption key. The key must be in an ENABLED
state to be rotated.
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.
This operation does not retry by default if the user has not defined a retry configuration.
CreateKeyVersionResponse
Creates a new KmsManagementWaiter for resources for this service.
The waiter configuration for termination and delay strategy
The service waiters.
Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys.
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.
This operation does not retry by default if the user has not defined a retry configuration.
DisableKeyResponse
Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys.
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.
This operation does not retry by default if the user has not defined a retry configuration.
EnableKeyResponse
Gets information about the specified 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 read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
GetKeyResponse
Gets information about the specified key version.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
GetKeyVersionResponse
When a vault has a replica, each operation on the vault or its resources, such as keys, is replicated and has an associated replicationId. Replication status provides details about whether the operation associated with the given replicationId has been successfully applied across replicas.
This operation does not retry by default if the user has not defined a retry configuration.
GetReplicationStatusResponse
Gets the waiters available for resources for this service.
The service waiters.
Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and unwraps AES key material for import into Key Management.
This operation does not retry by default if the user has not defined a retry configuration.
GetWrappingKeyResponse
Imports AES and RSA keys to create a new key. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports both RSA and AES keys. The AES keys are symmetric keys of length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). Furthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, only private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
This operation does not retry by default if the user has not defined a retry configuration.
ImportKeyResponse
Imports AES key material to create a new key version and then rotate the key to begin using the new key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
This operation does not retry by default if the user has not defined a retry configuration.
ImportKeyVersionResponse
NOTE: This function is deprecated in favor of listKeyVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.KeyVersionSummary objects contained in responses from the listKeyVersions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listKeyVersionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listKeyVersions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listKeysRecordIterator function. Creates a new async iterator which will iterate over the models.KeySummary objects contained in responses from the listKeys operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listKeysResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listKeys operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists all KeyVersion resources for the specified 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 read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
ListKeyVersionsResponse
Creates a new async iterator which will iterate over the models.KeyVersionSummary objects contained in responses from the listKeyVersions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listKeyVersions operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the master encryption keys in the specified vault and compartment.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
ListKeysResponse
Creates a new async iterator which will iterate over the models.KeySummary objects contained in responses from the listKeys operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listKeys operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Restores the specified key to the specified vault, based on information in the backup file provided. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
This operation does not retry by default if the user has not defined a retry configuration.
RestoreKeyFromFileResponse
Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.
This operation does not retry by default if the user has not defined a retry configuration.
RestoreKeyFromObjectStoreResponse
Schedules the deletion of the specified key. This sets the lifecycle state of the key
to PENDING_DELETION
and then deletes it after the specified retention period ends.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
ScheduleKeyDeletionResponse
Schedules the deletion of the specified key version. This sets the lifecycle state of the key version
to PENDING_DELETION
and then deletes it after the specified retention period ends.
As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.
This operation does not retry by default if the user has not defined a retry configuration.
ScheduleKeyVersionDeletionResponse
Shutdown the circuit breaker used by the client when it is no longer needed
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.
This operation does not retry by default if the user has not defined a retry configuration.
UpdateKeyResponse
This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.