PrivilegedApiRequestsClientCompositeOperations

class oci.apiaccesscontrol.PrivilegedApiRequestsClientCompositeOperations(client, work_request_clients=None, **kwargs)

This class provides a wrapper around PrivilegedApiRequestsClient 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 functionality

Methods:

__init__(client[, work_request_clients])

Creates a new PrivilegedApiRequestsClientCompositeOperations object

approve_privileged_api_request_and_wait_for_state(...)

Calls approve_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

close_privileged_api_request_and_wait_for_state(...)

Calls close_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

create_privileged_api_request_and_wait_for_state(...)

Calls create_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

reject_privileged_api_request_and_wait_for_state(...)

Calls reject_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

revoke_privileged_api_request_and_wait_for_state(...)

Calls revoke_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

__init__(client, work_request_clients=None, **kwargs)

Creates a new PrivilegedApiRequestsClientCompositeOperations object

Parameters
  • client (PrivilegedApiRequestsClient) – The service client which will be wrapped by this object

  • work_request_clients (dict) –

    (optional) Service-local clients keyed by generated client class name, for example {'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.

    Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.

    Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.

approve_privileged_api_request_and_wait_for_state(privileged_api_request_id, approve_privileged_api_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls approve_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

Parameters
  • privileged_api_request_id (str) – (required) unique PrivilegedApiRequest identifier

  • approve_privileged_api_request_details (oci.apiaccesscontrol.models.ApprovePrivilegedApiRequestDetails) – (required) Details regarding the approval of an privilegedApi request created by the operator.

  • 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 approve_privileged_api_request()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

close_privileged_api_request_and_wait_for_state(privileged_api_request_id, close_privileged_api_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls close_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

Parameters
  • privileged_api_request_id (str) – (required) unique PrivilegedApiRequest identifier

  • close_privileged_api_request_details (oci.apiaccesscontrol.models.ClosePrivilegedApiRequestDetails) – (required) Details regarding the close of an privilegedApi request created by the operator.

  • 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 close_privileged_api_request()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

create_privileged_api_request_and_wait_for_state(create_privileged_api_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

Parameters
  • create_privileged_api_request_details (oci.apiaccesscontrol.models.CreatePrivilegedApiRequestDetails) – (required) Details for the new PrivilegedApiRequest.

  • 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_privileged_api_request()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

reject_privileged_api_request_and_wait_for_state(privileged_api_request_id, reject_privileged_api_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls reject_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

Parameters
  • privileged_api_request_id (str) – (required) unique PrivilegedApiRequest identifier

  • reject_privileged_api_request_details (oci.apiaccesscontrol.models.RejectPrivilegedApiRequestDetails) – (required) Details regarding the rejection of privilegedApi request created by the operator.

  • 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 reject_privileged_api_request()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

revoke_privileged_api_request_and_wait_for_state(privileged_api_request_id, revoke_privileged_api_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls revoke_privileged_api_request() and waits for the WorkRequest to enter the given state(s).

Parameters
  • privileged_api_request_id (str) – (required) unique PrivilegedApiRequest identifier

  • revoke_privileged_api_request_details (oci.apiaccesscontrol.models.RevokePrivilegedApiRequestDetails) – (required) Details regarding the revocation of privilegedApi request created by the operator.

  • 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 revoke_privileged_api_request()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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