WaaClient

class oci.waa.WaaClient(config, **kwargs)

API for the Web Application Acceleration service. Use this API to manage regional Web App Acceleration policies such as Caching and Compression for accelerating HTTP services.

Methods

__init__(config, **kwargs) Creates a new service client
change_web_app_acceleration_compartment(…) Moves a Web App Acceleration resource from one compartment to another.
change_web_app_acceleration_policy_compartment(…) Moves a WebAppAccelerationfPolicy resource from one compartment to another.
create_web_app_acceleration(…) Creates a new WebAppAcceleration.
create_web_app_acceleration_policy(…) Creates a new WebAppAccelerationPolicy.
delete_web_app_acceleration(…) Deletes a WebAppAcceleration resource identified by the OCID.
delete_web_app_acceleration_policy(…) Deletes a WebAppAccelerationPolicy resource identified by the OCID.
get_web_app_acceleration(…) Gets a WebAppAcceleration by OCID.
get_web_app_acceleration_policy(…) Gets a WebAppAccelerationPolicy with the given OCID.
list_web_app_acceleration_policies(…) Gets a list of all WebAppAccelerationPolicies in a compartment.
list_web_app_accelerations(compartment_id, …) Gets a list of all WebAppAccelerations in a compartment.
purge_web_app_acceleration_cache(…) Clears resources from the cache of the WebAppAcceleration.
update_web_app_acceleration(…) Updates the WebAppAcceleration identified by the OCID.
update_web_app_acceleration_policy(…) Update the WebAppAccelerationPolicy identified by the OCID.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
change_web_app_acceleration_compartment(web_app_acceleration_id, change_web_app_acceleration_compartment_details, **kwargs)

Moves a Web App Acceleration resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • web_app_acceleration_id (str) –

    (required) The OCID of the WebAppAcceleration.

  • change_web_app_acceleration_compartment_details (oci.waa.models.ChangeWebAppAccelerationCompartmentDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use change_web_app_acceleration_compartment API.

change_web_app_acceleration_policy_compartment(web_app_acceleration_policy_id, change_web_app_acceleration_policy_compartment_details, **kwargs)

Moves a WebAppAccelerationfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • web_app_acceleration_policy_id (str) –

    (required) The OCID of the WebAppAccelerationPolicy.

  • change_web_app_acceleration_policy_compartment_details (oci.waa.models.ChangeWebAppAccelerationPolicyCompartmentDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use change_web_app_acceleration_policy_compartment API.

create_web_app_acceleration(create_web_app_acceleration_details, **kwargs)

Creates a new WebAppAcceleration.

Parameters:
  • create_web_app_acceleration_details (oci.waa.models.CreateWebAppAccelerationDetails) – (required) Details for the new WebAppAcceleration.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppAcceleration
Return type:

Response
Example:

Click here to see an example of how to use create_web_app_acceleration API.

create_web_app_acceleration_policy(create_web_app_acceleration_policy_details, **kwargs)

Creates a new WebAppAccelerationPolicy.

Parameters:
  • create_web_app_acceleration_policy_details (oci.waa.models.CreateWebAppAccelerationPolicyDetails) – (required) Details for the new WebAppAccelerationPolicy.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppAccelerationPolicy
Return type:

Response
Example:

Click here to see an example of how to use create_web_app_acceleration_policy API.

delete_web_app_acceleration(web_app_acceleration_id, **kwargs)

Deletes a WebAppAcceleration resource identified by the OCID.

Parameters:
  • web_app_acceleration_id (str) –

    (required) The OCID of the WebAppAcceleration.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_web_app_acceleration API.

delete_web_app_acceleration_policy(web_app_acceleration_policy_id, **kwargs)

Deletes a WebAppAccelerationPolicy resource identified by the OCID.

Parameters:
  • web_app_acceleration_policy_id (str) –

    (required) The OCID of the WebAppAccelerationPolicy.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use delete_web_app_acceleration_policy API.

get_web_app_acceleration(web_app_acceleration_id, **kwargs)

Gets a WebAppAcceleration by OCID.

Parameters:
  • web_app_acceleration_id (str) –

    (required) The OCID of the WebAppAcceleration.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppAcceleration
Return type:

Response
Example:

Click here to see an example of how to use get_web_app_acceleration API.

get_web_app_acceleration_policy(web_app_acceleration_policy_id, **kwargs)

Gets a WebAppAccelerationPolicy with the given OCID.

Parameters:
  • web_app_acceleration_policy_id (str) –

    (required) The OCID of the WebAppAccelerationPolicy.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppAccelerationPolicy
Return type:

Response
Example:

Click here to see an example of how to use get_web_app_acceleration_policy API.

list_web_app_acceleration_policies(compartment_id, **kwargs)

Gets a list of all WebAppAccelerationPolicies in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • lifecycle_state (list[WebAppAccelerationPolicyLifecycleState]) – (optional) A filter to return only resources that match the given lifecycleState.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • id (str) –

    (optional) A filter to return only the WebAppAccelerationPolicy with the given OCID.

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppAccelerationPolicyCollection
Return type:

Response
Example:

Click here to see an example of how to use list_web_app_acceleration_policies API.

list_web_app_accelerations(compartment_id, **kwargs)

Gets a list of all WebAppAccelerations in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • id (str) –

    (optional) A filter to return only the WebAppAcceleration with the given OCID.

  • web_app_acceleration_policy_id (str) –

    (optional) A filter to return only the WebAppAcceleration with the given OCID of related WebAppAccelerationPolicy.

  • lifecycle_state (list[WebAppAccelerationLifecycleState]) – (optional) A filter to return only resources that match the given lifecycleState.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppAccelerationCollection
Return type:

Response
Example:

Click here to see an example of how to use list_web_app_accelerations API.

purge_web_app_acceleration_cache(web_app_acceleration_id, purge_web_app_acceleration_cache_details, **kwargs)

Clears resources from the cache of the WebAppAcceleration. Each new request for a purged resource will be forwarded to the origin server to fetch a new version of the resource.

Parameters:
  • web_app_acceleration_id (str) –

    (required) The OCID of the WebAppAcceleration.

  • purge_web_app_acceleration_cache_details (oci.waa.models.PurgeWebAppAccelerationCacheDetails) – (required) Options for the cache purge.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use purge_web_app_acceleration_cache API.

update_web_app_acceleration(web_app_acceleration_id, update_web_app_acceleration_details, **kwargs)

Updates the WebAppAcceleration identified by the OCID.

Parameters:
  • web_app_acceleration_id (str) –

    (required) The OCID of the WebAppAcceleration.

  • update_web_app_acceleration_details (oci.waa.models.UpdateWebAppAccelerationDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use update_web_app_acceleration API.

update_web_app_acceleration_policy(web_app_acceleration_policy_id, update_web_app_acceleration_policy_details, **kwargs)

Update the WebAppAccelerationPolicy identified by the OCID.

Parameters:
  • web_app_acceleration_policy_id (str) –

    (required) The OCID of the WebAppAccelerationPolicy.

  • update_web_app_acceleration_policy_details (oci.waa.models.UpdateWebAppAccelerationPolicyDetails) – (required) The information to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

Click here to see an example of how to use update_web_app_acceleration_policy API.