WaasClientCompositeOperations

class oci.waas.WaasClientCompositeOperations(client, **kwargs)

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

__init__(client, **kwargs)

Creates a new WaasClientCompositeOperations object

Parameters:client (WaasClient) -- The service client which will be wrapped by this object
accept_recommendations_and_wait_for_state(waas_policy_id, protection_rule_keys, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • protection_rule_keys (list[str]) -- (required)
  • 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 accept_recommendations()
  • 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_address_list_and_wait_for_state(create_address_list_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_address_list() and waits for the AddressList acted upon to enter the given state(s).

Parameters:
  • create_address_list_details (CreateAddressListDetails) -- (required) The details of the address list resource to create.
  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to create_address_list()
  • 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_certificate_and_wait_for_state(create_certificate_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_certificate() and waits for the Certificate acted upon to enter the given state(s).

Parameters:
  • create_certificate_details (CreateCertificateDetails) -- (required) The details of the SSL certificate resource to create.
  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to create_certificate()
  • 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_custom_protection_rule_and_wait_for_state(create_custom_protection_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_custom_protection_rule() and waits for the CustomProtectionRule acted upon to enter the given state(s).

Parameters:
  • create_custom_protection_rule_details (CreateCustomProtectionRuleDetails) -- (required) The details of the Custom Protection rule.
  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to create_custom_protection_rule()
  • 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_waas_policy_and_wait_for_state(create_waas_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_waas_policy_details (CreateWaasPolicyDetails) -- (required) The details of the WAAS policy.
  • 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_waas_policy()
  • 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
delete_address_list_and_wait_for_state(address_list_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_address_list() and waits for the AddressList acted upon to enter the given state(s).

Parameters:
  • address_list_id (str) --

    (required) The OCID of the address list. This number is generated when the address list is added to the compartment.

  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to delete_address_list()
  • 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
delete_certificate_and_wait_for_state(certificate_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_certificate() and waits for the Certificate acted upon to enter the given state(s).

Parameters:
  • certificate_id (str) --

    (required) The OCID of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.

  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to delete_certificate()
  • 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
delete_custom_protection_rule_and_wait_for_state(custom_protection_rule_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_custom_protection_rule() and waits for the CustomProtectionRule acted upon to enter the given state(s).

Parameters:
  • custom_protection_rule_id (str) --

    (required) The OCID of the Custom Protection rule. This number is generated when the Custom Protection rule is added to the compartment.

  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to delete_custom_protection_rule()
  • 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
delete_waas_policy_and_wait_for_state(waas_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • 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_waas_policy()
  • 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
purge_cache_and_wait_for_state(waas_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • 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 purge_cache()
  • 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
update_access_rules_and_wait_for_state(waas_policy_id, access_rules, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • access_rules (list[AccessRule]) -- (required)
  • 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_access_rules()
  • 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
update_address_list_and_wait_for_state(address_list_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_address_list() and waits for the AddressList acted upon to enter the given state(s).

Parameters:
  • address_list_id (str) --

    (required) The OCID of the address list. This number is generated when the address list is added to the compartment.

  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to update_address_list()
  • 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
update_caching_rules_and_wait_for_state(waas_policy_id, caching_rules_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • caching_rules_details (list[CachingRule]) -- (required)
  • 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_caching_rules()
  • 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
update_captchas_and_wait_for_state(waas_policy_id, captchas, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • captchas (list[Captcha]) -- (required) A list of CAPTCHA details.
  • 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_captchas()
  • 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
update_certificate_and_wait_for_state(certificate_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_certificate() and waits for the Certificate acted upon to enter the given state(s).

Parameters:
  • certificate_id (str) --

    (required) The OCID of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.

  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to update_certificate()
  • 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
update_custom_protection_rule_and_wait_for_state(custom_protection_rule_id, update_custom_protection_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_custom_protection_rule() and waits for the CustomProtectionRule acted upon to enter the given state(s).

Parameters:
  • custom_protection_rule_id (str) --

    (required) The OCID of the Custom Protection rule. This number is generated when the Custom Protection rule is added to the compartment.

  • update_custom_protection_rule_details (UpdateCustomProtectionRuleDetails) -- (required) The details of the Custom Protection rule to update.
  • wait_for_states (list[str]) -- An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to update_custom_protection_rule()
  • 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
update_device_fingerprint_challenge_and_wait_for_state(waas_policy_id, update_device_fingerprint_challenge_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_device_fingerprint_challenge_details (DeviceFingerprintChallenge) -- (required) The device fingerprint challenge settings 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_device_fingerprint_challenge()
  • 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
update_good_bots_and_wait_for_state(waas_policy_id, good_bots, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • good_bots (list[GoodBot]) -- (required)
  • 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_good_bots()
  • 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
update_human_interaction_challenge_and_wait_for_state(waas_policy_id, update_human_interaction_challenge_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_human_interaction_challenge_details (HumanInteractionChallenge) -- (required) The human interaction challenge settings.
  • 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_human_interaction_challenge()
  • 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
update_js_challenge_and_wait_for_state(waas_policy_id, update_js_challenge_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_js_challenge_details (JsChallenge) -- (required) The JavaScript challenge settings 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_js_challenge()
  • 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
update_policy_config_and_wait_for_state(waas_policy_id, update_policy_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_policy_config_details (PolicyConfig) -- (required) The new configuration to apply to a WAAS policy.
  • 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_policy_config()
  • 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
update_protection_rules_and_wait_for_state(waas_policy_id, protection_rules, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • protection_rules (list[ProtectionRuleAction]) -- (required)
  • 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_protection_rules()
  • 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
update_protection_settings_and_wait_for_state(waas_policy_id, update_protection_settings_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_protection_settings_details (ProtectionSettings) -- (required) The details of the protection settings 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_protection_settings()
  • 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
update_threat_feeds_and_wait_for_state(waas_policy_id, threat_feeds, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • threat_feeds (list[ThreatFeedAction]) -- (required) A list of threat feeds for which to update the actions.
  • 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_threat_feeds()
  • 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
update_waas_policy_and_wait_for_state(waas_policy_id, update_waas_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_waas_policy_details (UpdateWaasPolicyDetails) -- (required) The details of the WAAS policy to update.
  • 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_waas_policy()
  • 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
update_waas_policy_custom_protection_rules_and_wait_for_state(waas_policy_id, update_custom_protection_rules_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_custom_protection_rules_details (list[CustomProtectionRuleSetting]) -- (required)
  • 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_waas_policy_custom_protection_rules()
  • 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
update_waf_address_rate_limiting_and_wait_for_state(waas_policy_id, update_waf_address_rate_limiting_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_waf_address_rate_limiting_details (AddressRateLimiting) -- (required) The address rate limiting settings.
  • 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_waf_address_rate_limiting()
  • 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
update_waf_config_and_wait_for_state(waas_policy_id, update_waf_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • update_waf_config_details (WafConfig) -- (required) The new Web Application Firewall configuration to apply to a WAAS policy.
  • 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_waf_config()
  • 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
update_whitelists_and_wait_for_state(waas_policy_id, whitelists, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • waas_policy_id (str) --

    (required) The OCID of the WAAS policy.

  • whitelists (list[Whitelist]) -- (required)
  • 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_whitelists()
  • 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