ResourceManagerClient

class oci.resource_manager.ResourceManagerClient(config, **kwargs)

Use the Resource Manager API to automate deployment and operations for all Oracle Cloud Infrastructure resources. Using the infrastructure-as-code (IaC) model, the service is based on Terraform, an open source industry standard that lets DevOps engineers develop and deploy their infrastructure anywhere. For more information, see [the Resource Manager documentation](/iaas/Content/ResourceManager/home.htm).

Methods

__init__(config, **kwargs) Creates a new service client
cancel_job(job_id, **kwargs) Indicates the intention to cancel the specified job.
change_configuration_source_provider_compartment(…) Moves a configuration source provider into a different compartment within the same tenancy.
change_stack_compartment(stack_id, …) Moves a Stack and it’s associated Jobs into a different compartment.
change_template_compartment(template_id, …) Moves a template into a different compartment within the same tenancy.
create_configuration_source_provider(…) Creates a configuration source provider in the specified compartment.
create_job(create_job_details, **kwargs) Creates a job.
create_stack(create_stack_details, **kwargs) Creates a stack in the specified compartment.
create_template(create_template_details, …) Creates a private template in the specified compartment.
delete_configuration_source_provider(…) Deletes the specified configuration source provider.
delete_stack(stack_id, **kwargs) Deletes the specified stack object.
delete_template(template_id, **kwargs) Deletes the specified template.
detect_stack_drift(stack_id, **kwargs) Checks drift status for the specified stack.
get_configuration_source_provider(…) Gets the properties of the specified configuration source provider.
get_job(job_id, **kwargs) Returns the specified job along with the job details.
get_job_detailed_log_content(job_id, **kwargs) Returns the Terraform detailed log content for the specified job in plain text.
get_job_logs(job_id, **kwargs) Returns console log entries for the specified job in JSON format.
get_job_logs_content(job_id, **kwargs) Returns a raw log file for the specified job.
get_job_tf_config(job_id, **kwargs) Returns the Terraform configuration file for the specified job in .zip format.
get_job_tf_state(job_id, **kwargs) Returns the Terraform state for the specified job.
get_stack(stack_id, **kwargs) Gets a stack using the stack ID.
get_stack_tf_config(stack_id, **kwargs) Returns the Terraform configuration file in .zip format for the specified stack.
get_stack_tf_state(stack_id, **kwargs) Returns the Terraform state for the specified stack.
get_template(template_id, **kwargs) Gets the specified template.
get_template_logo(template_id, **kwargs) Returns the Terraform logo file in .logo format for the specified template.
get_template_tf_config(template_id, **kwargs) Returns the Terraform configuration file in .zip format for the specified template.
get_work_request(work_request_id, **kwargs) Return the given work request.
list_configuration_source_providers(**kwargs) Lists configuration source providers according to the specified filter.
list_jobs(**kwargs) Returns a list of jobs in a stack or compartment, ordered by time created.
list_resource_discovery_services(**kwargs) Returns a list of supported services for Resource Discovery.
list_stack_resource_drift_details(stack_id, …) Lists drift status details for each resource defined in the specified stack.
list_stacks(**kwargs) Returns a list of stacks.
list_template_categories(**kwargs) Lists template categories.
list_templates(**kwargs) Lists templates according to the specified filter.
list_terraform_versions(**kwargs) Returns a list of supported Terraform versions for use with stacks.
list_work_request_errors(work_request_id, …) Return a (paginated) list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs) Return a (paginated) list of logs for a given work request.
list_work_requests(compartment_id, **kwargs) Lists the work requests in a given compartment or for a given resource.
update_configuration_source_provider(…) Updates the properties of the specified configuration source provider.
update_job(job_id, update_job_details, **kwargs) Updates the specified job.
update_stack(stack_id, update_stack_details, …) Updates the specified stack object.
update_template(template_id, …) Updates the specified template.
__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.

cancel_job(job_id, **kwargs)

Indicates the intention to cancel the specified job. Cancellation of the job is not immediate, and may be delayed, or may not happen at all. You can optionally choose forced cancellation by setting isForced to true. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • is_forced (bool) – (optional) Indicates whether a forced cancellation is requested for the job while it was running. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

change_configuration_source_provider_compartment(configuration_source_provider_id, change_configuration_source_provider_compartment_details, **kwargs)

Moves a configuration source provider into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:
  • configuration_source_provider_id (str) –

    (required) The OCID of the configuration source provider.

  • change_configuration_source_provider_compartment_details (oci.resource_manager.models.ChangeConfigurationSourceProviderCompartmentDetails) – (required) Defines the properties of changeConfigurationSourceProviderCompartment operation.
  • 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

change_stack_compartment(stack_id, change_stack_compartment_details, **kwargs)

Moves a Stack and it’s associated Jobs into a different compartment.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • change_stack_compartment_details (oci.resource_manager.models.ChangeStackCompartmentDetails) – (required) Defines the properties of changeStackCompartment operation.
  • 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

change_template_compartment(template_id, change_template_compartment_details, **kwargs)

Moves a template into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:
  • template_id (str) –

    (required) The OCID of the template.

  • change_template_compartment_details (oci.resource_manager.models.ChangeTemplateCompartmentDetails) – (required) The details for moving a template to a different compartment.
  • 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

create_configuration_source_provider(create_configuration_source_provider_details, **kwargs)

Creates a configuration source provider in the specified compartment. For more information, see To create a configuration source provider.

Parameters:
  • create_configuration_source_provider_details (oci.resource_manager.models.CreateConfigurationSourceProviderDetails) – (required) The properties for creating a ConfigurationSourceProvider.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ConfigurationSourceProvider

Return type:

Response

Example:

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

create_job(create_job_details, **kwargs)

Creates a job.

Parameters:
  • create_job_details (oci.resource_manager.models.CreateJobDetails) – (required) The properties for a request to create a job.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Job

Return type:

Response

Example:

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

create_stack(create_stack_details, **kwargs)

Creates a stack in the specified compartment. You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see To create a stack.

Parameters:
  • create_stack_details (oci.resource_manager.models.CreateStackDetails) – (required) The properties for creating a stack.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Stack

Return type:

Response

Example:

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

create_template(create_template_details, **kwargs)

Creates a private template in the specified compartment.

Parameters:
  • create_template_details (oci.resource_manager.models.CreateTemplateDetails) – (required) The configuration details for creating a template.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Template

Return type:

Response

Example:

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

delete_configuration_source_provider(configuration_source_provider_id, **kwargs)

Deletes the specified configuration source provider.

Parameters:
  • configuration_source_provider_id (str) –

    (required) The OCID of the configuration source provider.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_stack(stack_id, **kwargs)

Deletes the specified stack object.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_template(template_id, **kwargs)

Deletes the specified template.

Parameters:
  • template_id (str) –

    (required) The OCID of the template.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

detect_stack_drift(stack_id, **kwargs)

Checks drift status for the specified stack.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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 retrying the same action. 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 may be rejected.
  • detect_stack_drift_details (oci.resource_manager.models.DetectStackDriftDetails) – (optional) The details for detecting drift in a stack
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

get_configuration_source_provider(configuration_source_provider_id, **kwargs)

Gets the properties of the specified configuration source provider.

Parameters:
  • configuration_source_provider_id (str) –

    (required) The OCID of the configuration source provider.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ConfigurationSourceProvider

Return type:

Response

Example:

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

get_job(job_id, **kwargs)

Returns the specified job along with the job details.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Job

Return type:

Response

Example:

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

get_job_detailed_log_content(job_id, **kwargs)

Returns the Terraform detailed log content for the specified job in plain text. Learn about Terraform detailed log.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type str

Return type:

Response

Example:

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

get_job_logs(job_id, **kwargs)

Returns console log entries for the specified job in JSON format.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • type (list[LogEntryType]) – (optional) A filter that returns only logs of a specified type.
  • level_greater_than_or_equal_to (str) –

    (optional) A filter that returns only log entries that match a given severity level or greater.

    Allowed values are: “TRACE”, “DEBUG”, “INFO”, “WARN”, “ERROR”, “FATAL”

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • timestamp_greater_than_or_equal_to (datetime) – (optional) Time stamp specifying the lower time limit for which logs are returned in a query. Format is defined by RFC3339. Example: 2020-01-01T12:00:00.000Z
  • timestamp_less_than_or_equal_to (datetime) – (optional) Time stamp specifying the upper time limit for which logs are returned in a query. Format is defined by RFC3339. Example: 2020-02-01T12:00:00.000Z
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of LogEntry

Return type:

Response

Example:

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

get_job_logs_content(job_id, **kwargs)

Returns a raw log file for the specified job. The raw log file contains console log entries in text format. The maximum number of entries in a file is 100,000.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type str

Return type:

Response

Example:

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

get_job_tf_config(job_id, **kwargs)

Returns the Terraform configuration file for the specified job in .zip format. Returns an error if no zip file is found.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_job_tf_state(job_id, **kwargs)

Returns the Terraform state for the specified job.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_stack(stack_id, **kwargs)

Gets a stack using the stack ID.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Stack

Return type:

Response

Example:

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

get_stack_tf_config(stack_id, **kwargs)

Returns the Terraform configuration file in .zip format for the specified stack. Returns an error if no zip file is found.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_stack_tf_state(stack_id, **kwargs)

Returns the Terraform state for the specified stack.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_template(template_id, **kwargs)

Gets the specified template.

Parameters:
  • template_id (str) –

    (required) The OCID of the template.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Template

Return type:

Response

Example:

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

Returns the Terraform logo file in .logo format for the specified template. Returns an error if no logo file is found.

Parameters:
  • template_id (str) –

    (required) The OCID of the template.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_template_tf_config(template_id, **kwargs)

Returns the Terraform configuration file in .zip format for the specified template. Returns an error if no zip file is found.

Parameters:
  • template_id (str) –

    (required) The OCID of the template.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type stream

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

Return the given work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the work request.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

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

list_configuration_source_providers(**kwargs)

Lists configuration source providers according to the specified filter. - For compartmentId, lists all configuration source providers in the matching compartment. - For configurationSourceProviderId, lists the matching configuration source provider.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • configuration_source_provider_id (str) –

    (optional) A filter to return only configuration source providers that match the provided OCID.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
  • sort_by (str) –

    (optional) The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • config_source_provider_type (str) – (optional) A filter to return only configuration source providers of the specified type (GitHub or GitLab).
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ConfigurationSourceProviderCollection

Return type:

Response

Example:

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

list_jobs(**kwargs)

Returns a list of jobs in a stack or compartment, ordered by time created.

  • To list all jobs in a stack, provide the stack OCID.
  • To list all jobs in a compartment, provide the compartment OCID.
  • To return a specific job, provide the job OCID.
Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • stack_id (str) –

    (optional) The stack OCID on which to filter.

  • id (str) –

    (optional) The OCID on which to query for jobs.

  • lifecycle_state (str) –

    (optional) A filter that returns all resources that match the specified lifecycle state. The state value is case-insensitive.

    Allowable values: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
  • sort_by (str) –

    (optional) The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of JobSummary

Return type:

Response

Example:

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

list_resource_discovery_services(**kwargs)

Returns a list of supported services for Resource Discovery. For reference on service names, see the Terraform provider documentation.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ResourceDiscoveryServiceCollection

Return type:

Response

Example:

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

list_stack_resource_drift_details(stack_id, **kwargs)

Lists drift status details for each resource defined in the specified stack. The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. The drift status details correspond to the specified work request (workRequestId). If no work request is specified, then the drift status details correspond to the latest completed work request for the stack.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • work_request_id (str) –

    (optional) The OCID of the work request.

  • resource_drift_status (list[StackResourceDriftSummaryResourceDriftStatus]) –

    (optional) A filter that returns only resources that match the given drift status. The value is case-insensitive. Allowable values -

    • NOT_CHECKED
    • MODIFIED
    • IN_SYNC
    • DELETED
  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type StackResourceDriftCollection

Return type:

Response

Example:

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

list_stacks(**kwargs)

Returns a list of stacks. - If called using the compartment ID, returns all stacks in the specified compartment. - If called using the stack ID, returns the specified stack.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • id (str) –

    (optional) The OCID on which to query for a stack.

  • lifecycle_state (str) –

    (optional) A filter that returns only those resources that match the specified lifecycle state. The state value is case-insensitive. For more information about stack lifecycle states, see Key Concepts.

    Allowable values: - CREATING - ACTIVE - DELETING - DELETED - FAILED

    Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
  • sort_by (str) –

    (optional) The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of StackSummary

Return type:

Response

Example:

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

list_template_categories(**kwargs)

Lists template categories.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type TemplateCategorySummaryCollection

Return type:

Response

Example:

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

list_templates(**kwargs)

Lists templates according to the specified filter. The attributes compartmentId and templateCategoryId are required unless templateId is specified.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • template_category_id (str) – (optional) Unique identifier of the template category. Possible values are 0 (Quick Starts), 1 (Service), 2 (Architecture), and 3 (Private).
  • template_id (str) –

    (optional) The OCID of the template.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
  • sort_by (str) –

    (optional) The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type TemplateSummaryCollection

Return type:

Response

Example:

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

list_terraform_versions(**kwargs)

Returns a list of supported Terraform versions for use with stacks.

Parameters:
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type TerraformVersionCollection

Return type:

Response

Example:

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

list_work_request_errors(work_request_id, **kwargs)

Return a (paginated) list of errors for a given work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the work request.

  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

Example:

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

list_work_request_logs(work_request_id, **kwargs)

Return a (paginated) list of logs for a given work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the work request.

  • compartment_id (str) –

    (optional) A filter to return only resources that exist in the compartment, identified by OCID.

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • sort_order (str) –

    (optional) The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestLogEntry

Return type:

Response

Example:

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

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a given compartment or for a given resource.

Parameters:
  • compartment_id (str) –

    (required) A filter to return only resources that exist in the compartment, identified by OCID.

  • resource_id (str) –

    (optional) The OCID of the resource.

  • limit (int) –

    (optional) The number of items returned in a paginated List call. For information about pagination, see List Pagination.

  • page (str) –

    (optional) The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestSummary

Return type:

Response

Example:

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

update_configuration_source_provider(configuration_source_provider_id, update_configuration_source_provider_details, **kwargs)

Updates the properties of the specified configuration source provider. For more information, see To edit a configuration source provider.

Parameters:
  • configuration_source_provider_id (str) –

    (required) The OCID of the configuration source provider.

  • update_configuration_source_provider_details (oci.resource_manager.models.UpdateConfigurationSourceProviderDetails) – (required) Updated information provided for the ConfigurationSourceProvider.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ConfigurationSourceProvider

Return type:

Response

Example:

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

update_job(job_id, update_job_details, **kwargs)

Updates the specified job.

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • update_job_details (oci.resource_manager.models.UpdateJobDetails) – (required) Updates properties for the specified job.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Job

Return type:

Response

Example:

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

update_stack(stack_id, update_stack_details, **kwargs)

Updates the specified stack object. Use UpdateStack when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see To update a stack and To edit a stack.

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • update_stack_details (oci.resource_manager.models.UpdateStackDetails) – (required) Updated information provided for the stack.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Stack

Return type:

Response

Example:

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

update_template(template_id, update_template_details, **kwargs)

Updates the specified template.

Parameters:
  • template_id (str) –

    (required) The OCID of the template.

  • update_template_details (oci.resource_manager.models.UpdateTemplateDetails) – (required) The details for updating a template.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Template

Return type:

Response

Example:

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