CostAdClient

class oci.budget.CostAdClient(config, **kwargs)

Use the Budgets API to manage budgets and budget alerts. For more information, see [Budgets Overview](/iaas/Content/Billing/Concepts/budgetsoverview.htm).

Methods

__init__(config, **kwargs) Creates a new service client
create_cost_alert_subscription(…) Creates a new CostAlert Subscription.
create_cost_anomaly_monitor(…) Creates a new costAnomaly Monitor.
delete_cost_alert_subscription(…) Deletes a specified CostAlertSubscription resource.
delete_cost_anomaly_monitor(…) Deletes a specified CostAnomalyMonitor resource.
disable_cost_anomaly_monitor(…) Disables the cost anomaly monitor.
enable_cost_anomaly_monitor(…) Enables the cost anomaly monitor.
get_cost_alert_subscription(…) Gets a CostAlertSubscription by the identifier.
get_cost_anomaly_event(…) Gets a CostAnomalyEvent by the identifier.
get_cost_anomaly_monitor(…) Gets a CostAnomalyMonitor by the identifier.
list_cost_alert_subscriptions(…) Gets a list of Cost Alert Subscription in a compartment.
list_cost_anomaly_events(compartment_id, …) Gets a list of Cost Anomaly Event in a compartment.
list_cost_anomaly_monitors(compartment_id, …) Gets a list of Cost Anomaly Monitors in a compartment.
summarize_cost_anomaly_event_analytics(…) Gets a list of Cost Anomaly Events analytics summary - aggregated metrics for a given time period.
update_cost_alert_subscription(…) Update a CostAlertSubscription identified by the OCID.
update_cost_anomaly_event(…) Update a CostAnomalyEvent identified by the OCID.
update_cost_anomaly_monitor(…) Update a CostAnomalyMonitor 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.
create_cost_alert_subscription(create_cost_alert_subscription_details, **kwargs)

Creates a new CostAlert Subscription.

Parameters:
  • create_cost_alert_subscription_details (oci.budget.models.CreateCostAlertSubscriptionDetails) – (required) Details for the new subscription.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAlertSubscription

Return type:

Response

Example:

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

create_cost_anomaly_monitor(create_cost_anomaly_monitor_details, **kwargs)

Creates a new costAnomaly Monitor.

Parameters:
  • create_cost_anomaly_monitor_details (oci.budget.models.CreateCostAnomalyMonitorDetails) – (required) Details for the new monitor.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyMonitor

Return type:

Response

Example:

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

delete_cost_alert_subscription(cost_alert_subscription_id, **kwargs)

Deletes a specified CostAlertSubscription resource.

Parameters:
  • cost_alert_subscription_id (str) – (required) The unique costAlertSubscription OCID.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_cost_alert_subscription API.

delete_cost_anomaly_monitor(cost_anomaly_monitor_id, **kwargs)

Deletes a specified CostAnomalyMonitor resource.

Parameters:
  • cost_anomaly_monitor_id (str) – (required) The unique costAnomalyMonitor OCID.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_cost_anomaly_monitor API.

disable_cost_anomaly_monitor(cost_anomaly_monitor_id, **kwargs)

Disables the cost anomaly monitor. This stops cost anomaly detection for targeted resource(s).

Parameters:
  • cost_anomaly_monitor_id (str) – (required) The unique costAnomalyMonitor OCID.
  • 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.
  • 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.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyMonitor

Return type:

Response

Example:

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

enable_cost_anomaly_monitor(cost_anomaly_monitor_id, **kwargs)

Enables the cost anomaly monitor. This (re)starts the cost anomaly detection for targeted resource(s).

Parameters:
  • cost_anomaly_monitor_id (str) – (required) The unique costAnomalyMonitor OCID.
  • 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.
  • 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.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyMonitor

Return type:

Response

Example:

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

get_cost_alert_subscription(cost_alert_subscription_id, **kwargs)

Gets a CostAlertSubscription by the identifier.

Parameters:
  • cost_alert_subscription_id (str) – (required) The unique costAlertSubscription OCID.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAlertSubscription

Return type:

Response

Example:

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

get_cost_anomaly_event(cost_anomaly_event_id, **kwargs)

Gets a CostAnomalyEvent by the identifier.

Parameters:
  • cost_anomaly_event_id (str) – (required) The unique costAnomalyEventId OCID.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyEvent

Return type:

Response

Example:

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

get_cost_anomaly_monitor(cost_anomaly_monitor_id, **kwargs)

Gets a CostAnomalyMonitor by the identifier.

Parameters:
  • cost_anomaly_monitor_id (str) – (required) The unique costAnomalyMonitor OCID.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyMonitor

Return type:

Response

Example:

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

list_cost_alert_subscriptions(compartment_id, **kwargs)

Gets a list of Cost Alert Subscription in a compartment.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.

    Allowed values are: “timeCreated”, “name”, “id”

  • name (str) – (optional) Unique, non-changeable resource name.
  • lifecycle_state (str) –

    (optional) The current state of the cost alert subscription.

    Allowed values are: “ACTIVE”, “INACTIVE”

  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAlertSubscriptionCollection

Return type:

Response

Example:

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

list_cost_anomaly_events(compartment_id, **kwargs)

Gets a list of Cost Anomaly Event in a compartment.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If not specified, the default is timeAnomalyEventDate. The default sort order for timeAnomalyEventDate is DESC. The default sort order for costAnomalyName is ASC in alphanumeric order.

    Allowed values are: “timeAnomalyEventDate”, “costAnomalyName”, “id”

  • name (str) – (optional) Unique, non-changeable resource name.
  • cost_anomaly_monitor_id (str) – (optional) The cost monitor ocid.
  • target_tenant_id (list[str]) – (optional) The target tenantId ocid filter param.
  • time_anomaly_event_start_date (datetime) – (optional) startDate for anomaly event date.
  • time_anomaly_event_end_date (datetime) – (optional) endDate for anomaly event date.
  • region (list[str]) – (optional) region of the anomaly event.
  • cost_impact (float) – (optional) cost impact (absolute) of the anomaly event.
  • cost_impact_percentage (float) – (optional) cost impact (percentage) of the anomaly event.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyEventCollection

Return type:

Response

Example:

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

list_cost_anomaly_monitors(compartment_id, **kwargs)

Gets a list of Cost Anomaly Monitors in a compartment.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.

    Allowed values are: “timeCreated”, “name”, “id”

  • lifecycle_state (str) –

    (optional) The current state of the cost monitor.

    Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”

  • name (str) – (optional) Unique, non-changeable resource name.
  • target_tenant_id (list[str]) – (optional) The target tenantId ocid filter param.
  • region (list[str]) – (optional) Cost Anomaly Monitor target resource filter region.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyMonitorCollection

Return type:

Response

Example:

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

summarize_cost_anomaly_event_analytics(compartment_id, **kwargs)

Gets a list of Cost Anomaly Events analytics summary - aggregated metrics for a given time period.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If not specified, the default is timeAnomalyEventDate. The default sort order for timeAnomalyEventDate is DESC. The default sort order for costAnomalyName is ASC in alphanumeric order.

    Allowed values are: “timeAnomalyEventDate”, “costAnomalyName”, “id”

  • name (str) – (optional) Unique, non-changeable resource name.
  • cost_anomaly_monitor_id (str) – (optional) The cost monitor ocid.
  • target_tenant_id (list[str]) – (optional) The target tenantId ocid filter param.
  • time_anomaly_event_start_date (datetime) – (optional) startDate for anomaly event date.
  • time_anomaly_event_end_date (datetime) – (optional) endDate for anomaly event date.
  • region (list[str]) – (optional) region of the anomaly event.
  • cost_impact (float) – (optional) cost impact (absolute) of the anomaly event.
  • cost_impact_percentage (float) – (optional) cost impact (percentage) of the anomaly event.
  • 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyEventAnalyticCollection

Return type:

Response

Example:

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

update_cost_alert_subscription(cost_alert_subscription_id, update_cost_alert_subscription_details, **kwargs)

Update a CostAlertSubscription identified by the OCID.

Parameters:
  • cost_alert_subscription_id (str) – (required) The unique costAlertSubscription OCID.
  • update_cost_alert_subscription_details (oci.budget.models.UpdateCostAlertSubscriptionDetails) – (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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAlertSubscription

Return type:

Response

Example:

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

update_cost_anomaly_event(cost_anomaly_event_id, update_cost_anomaly_event_details, **kwargs)

Update a CostAnomalyEvent identified by the OCID.

Parameters:
  • cost_anomaly_event_id (str) – (required) The unique costAnomalyEventId OCID.
  • update_cost_anomaly_event_details (oci.budget.models.UpdateCostAnomalyEventDetails) – (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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyEvent

Return type:

Response

Example:

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

update_cost_anomaly_monitor(cost_anomaly_monitor_id, update_cost_anomaly_monitor_details, **kwargs)

Update a CostAnomalyMonitor identified by the OCID.

Parameters:
  • cost_anomaly_monitor_id (str) – (required) The unique costAnomalyMonitor OCID.
  • update_cost_anomaly_monitor_details (oci.budget.models.UpdateCostAnomalyMonitorDetails) – (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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 CostAnomalyMonitor

Return type:

Response

Example:

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