KmsManagementClientCompositeOperations¶
- class oci.key_management.KmsManagementClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
KmsManagementClientand offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods:
__init__(client, **kwargs)Creates a new KmsManagementClientCompositeOperations object
backup_key_and_wait_for_state(key_id[, ...])Calls
backup_key()and waits for theKeyacted upon to enter the given state(s).Calls
cancel_key_deletion()and waits for theKeyacted upon to enter the given state(s).Calls
cancel_key_version_deletion()and waits for theKeyVersionacted upon to enter the given state(s).create_key_and_wait_for_state(create_key_details)Calls
create_key()and waits for theKeyacted upon to enter the given state(s).Calls
create_key_version()and waits for theKeyVersionacted upon to enter the given state(s).disable_key_and_wait_for_state(key_id[, ...])Calls
disable_key()and waits for theKeyacted upon to enter the given state(s).enable_key_and_wait_for_state(key_id[, ...])Calls
enable_key()and waits for theKeyacted upon to enter the given state(s).Calls
schedule_key_deletion()and waits for theKeyacted upon to enter the given state(s).Calls
schedule_key_version_deletion()and waits for theKeyVersionacted upon to enter the given state(s).update_key_and_wait_for_state(key_id, ...[, ...])Calls
update_key()and waits for theKeyacted upon to enter the given state(s).- __init__(client, **kwargs)¶
Creates a new KmsManagementClientCompositeOperations object
- Parameters
client (KmsManagementClient) – The service client which will be wrapped by this object
- backup_key_and_wait_for_state(key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
backup_key()and waits for theKeyacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
backup_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- cancel_key_deletion_and_wait_for_state(key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cancel_key_deletion()and waits for theKeyacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
cancel_key_deletion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- cancel_key_version_deletion_and_wait_for_state(key_id, key_version_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cancel_key_version_deletion()and waits for theKeyVersionacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
key_version_id (str) – (required) The OCID of the key version.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
cancel_key_version_deletion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_key_and_wait_for_state(create_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_key()and waits for theKeyacted upon to enter the given state(s).- Parameters
create_key_details (oci.key_management.models.CreateKeyDetails) – (required) CreateKeyDetails
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_key_version_and_wait_for_state(key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_key_version()and waits for theKeyVersionacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_key_version()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- disable_key_and_wait_for_state(key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
disable_key()and waits for theKeyacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
disable_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- enable_key_and_wait_for_state(key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
enable_key()and waits for theKeyacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
enable_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- schedule_key_deletion_and_wait_for_state(key_id, schedule_key_deletion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
schedule_key_deletion()and waits for theKeyacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
schedule_key_deletion_details (oci.key_management.models.ScheduleKeyDeletionDetails) – (required) ScheduleKeyDeletionDetails
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
schedule_key_deletion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- schedule_key_version_deletion_and_wait_for_state(key_id, key_version_id, schedule_key_version_deletion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
schedule_key_version_deletion()and waits for theKeyVersionacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
key_version_id (str) – (required) The OCID of the key version.
schedule_key_version_deletion_details (oci.key_management.models.ScheduleKeyVersionDeletionDetails) – (required) ScheduleKeyVersionDeletionDetails
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
schedule_key_version_deletion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_key_and_wait_for_state(key_id, update_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_key()and waits for theKeyacted upon to enter the given state(s).- Parameters
key_id (str) – (required) The OCID of the key.
update_key_details (oci.key_management.models.UpdateKeyDetails) – (required) UpdateKeyDetails
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_key()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait