OrganizationClientCompositeOperations¶
-
class
oci.tenant_manager_control_plane.
OrganizationClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
OrganizationClient
and 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 OrganizationClientCompositeOperations object create_child_tenancy_and_wait_for_state
(…)Calls create_child_tenancy()
and waits for theWorkRequest
to enter the given state(s).delete_organization_tenancy_and_wait_for_state
(…)Calls delete_organization_tenancy()
and waits for theWorkRequest
to enter the given state(s).restore_organization_tenancy_and_wait_for_state
(…)Calls restore_organization_tenancy()
and waits for theWorkRequest
to enter the given state(s).update_organization_and_wait_for_state
(…)Calls update_organization()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new OrganizationClientCompositeOperations object
Parameters: client (OrganizationClient) – The service client which will be wrapped by this object
-
create_child_tenancy_and_wait_for_state
(create_child_tenancy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_child_tenancy()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_child_tenancy_details (oci.tenant_manager_control_plane.models.CreateChildTenancyDetails) – (required) Parameters to create a child tenancy.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_child_tenancy()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_organization_tenancy_and_wait_for_state
(organization_tenancy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_organization_tenancy()
and waits for theWorkRequest
to enter the given state(s).Parameters: - organization_tenancy_id (str) – (required) OCID of the tenancy to be terminated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_organization_tenancy()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
restore_organization_tenancy_and_wait_for_state
(organization_tenancy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
restore_organization_tenancy()
and waits for theWorkRequest
to enter the given state(s).Parameters: - organization_tenancy_id (str) – (required) OCID of the tenancy to be restored.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
restore_organization_tenancy()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_organization_and_wait_for_state
(organization_id, update_organization_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_organization()
and waits for theWorkRequest
to enter the given state(s).Parameters: - organization_id (str) – (required) OCID of the organization.
- update_organization_details (oci.tenant_manager_control_plane.models.UpdateOrganizationDetails) – (required) The information to be updated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_organization()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-