FleetAppsManagementRunbooksClient¶

class oci.fleet_apps_management.FleetAppsManagementRunbooksClient(config, **kwargs)¶

Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_runbook_compartment`(runbook_id, …)	Moves a Runbook into a different compartment within the same tenancy.
`change_task_record_compartment`(…)	Moves a task record into a different compartment within the same tenancy.
`create_runbook`(create_runbook_details, **kwargs)	Creates a runbook.
`create_runbook_version`(…)	Add RunbookVersion in Fleet Application Management.
`create_task_record`(…)	Creates a new task record.
`delete_runbook`(runbook_id, **kwargs)	Deletes a runbook specified by the identifier.
`delete_runbook_version`(runbook_version_id, …)	Removes a Runbook Version from the runbook in Fleet Application Management.
`delete_task_record`(task_record_id, **kwargs)	Deletes the task record specified by an identifier.
`get_runbook`(runbook_id, **kwargs)	Get the details of a runbook in Fleet Application Management.
`get_runbook_version`(runbook_version_id, **kwargs)	Gets a Runbook Version by identifier.
`get_task_record`(task_record_id, **kwargs)	Gets information for the specified task record.
`list_runbook_versions`(**kwargs)	List versions for a runbook in Fleet Application Management.
`list_runbooks`(**kwargs)	Returns a list of all the runbooks in the specified compartment.
`list_task_records`(**kwargs)	Returns a list of all the task records in the specified compartment.
`publish_runbook`(publish_runbook_details, …)	Publish the specified version of the runbook.
`set_default_runbook`(…)	Set a runbook as default.
`update_runbook`(runbook_id, …)	Updates the runbook specified by the identifier.
`update_runbook_version`(runbook_version_id, …)	Updates the RunbookVersion.
`update_task_record`(task_record_id, …)	Updates certain attributes for the specified task record.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

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

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

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

change_runbook_compartment(runbook_id, change_runbook_compartment_details, **kwargs)¶

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

Parameters:	runbook_id (str) – (required) Unique Runbook identifier change_runbook_compartment_details (oci.fleet_apps_management.models.ChangeRunbookCompartmentDetails) – (required) Details of the target 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) 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 None
Return type:	`Response`
Example:

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

change_task_record_compartment(task_record_id, change_task_record_compartment_details, **kwargs)¶

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

Parameters:	task_record_id (str) – (required) The OCID of the task record. change_task_record_compartment_details (oci.fleet_apps_management.models.ChangeTaskRecordCompartmentDetails) – (required) Details of the target 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) 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 None
Return type:	`Response`
Example:

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

create_runbook(create_runbook_details, **kwargs)¶

Creates a runbook.

Parameters:	create_runbook_details (oci.fleet_apps_management.models.CreateRunbookDetails) – (required) Details for the new Runbook. 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 `Runbook`
Return type:	`Response`
Example:

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

create_runbook_version(create_runbook_version_details, **kwargs)¶

Add RunbookVersion in Fleet Application Management.

Parameters:	create_runbook_version_details (oci.fleet_apps_management.models.CreateRunbookVersionDetails) – (required) Details for the new Runbook Version. 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 `RunbookVersion`
Return type:	`Response`
Example:

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

create_task_record(create_task_record_details, **kwargs)¶

Creates a new task record.

Parameters:	create_task_record_details (oci.fleet_apps_management.models.CreateTaskRecordDetails) – (required) Attributes to create a task record. 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 `TaskRecord`
Return type:	`Response`
Example:

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

delete_runbook(runbook_id, **kwargs)¶

Deletes a runbook specified by the identifier.

Parameters:	runbook_id (str) – (required) Unique Runbook identifier 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_runbook API.

delete_runbook_version(runbook_version_id, **kwargs)¶

Removes a Runbook Version from the runbook in Fleet Application Management.

Parameters:	runbook_version_id (str) – (required) Unique Runbook Version identifier 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_runbook_version API.

delete_task_record(task_record_id, **kwargs)¶

Deletes the task record specified by an identifier.

Parameters:	task_record_id (str) – (required) The OCID of the task record. 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_task_record API.

get_runbook(runbook_id, **kwargs)¶

Get the details of a runbook in Fleet Application Management.

Parameters:	runbook_id (str) – (required) Unique Runbook identifier 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 `Runbook`
Return type:	`Response`
Example:

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

get_runbook_version(runbook_version_id, **kwargs)¶

Gets a Runbook Version by identifier.

Parameters:	runbook_version_id (str) – (required) Unique Runbook Version identifier 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 `RunbookVersion`
Return type:	`Response`
Example:

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

get_task_record(task_record_id, **kwargs)¶

Gets information for the specified task record.

Parameters:	task_record_id (str) – (required) The OCID of the task record. 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 `TaskRecord`
Return type:	`Response`
Example:

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

list_runbook_versions(**kwargs)¶

List versions for a runbook in Fleet Application Management.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. lifecycle_state (str) – (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “INACTIVE”, “CREATING”, “DELETING”, “UPDATING” runbook_id (str) – (optional) A filter to return only schedule definitions whose associated runbookId matches the given runbookId. id (str) – (optional) A filter to return runbook versions whose identifier matches the given identifier. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. name (str) – (optional) A filter to return only resources that match the entire name given. 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 `RunbookVersionCollection`
Return type:	`Response`
Example:

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

list_runbooks(**kwargs)¶

Returns a list of all the runbooks in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. lifecycle_state (str) – (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETED”, “FAILED”, “INACTIVE”, “CREATING”, “DELETING”, “UPDATING” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided. type (str) – (optional) A filter to return runbooks whose type matches the given type. Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED” platform (str) – (optional) A filter to return runbooks whose platform matches the given platform. operation (str) – (optional) A filter to return runbooks whose operation matches the given lifecycle operation. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation 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 `RunbookCollection`
Return type:	`Response`
Example:

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

list_task_records(**kwargs)¶

Returns a list of all the task records in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. platform (str) – (optional) The platform for the task record. type (str) – (optional) The type of the Task. Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. operation (str) – (optional) A filter to return task records whose operation matches the given lifecycle operation. id (str) – (optional) Unique identifier or OCID for listing a single task record by id. Either compartmentId or id must be provided. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. lifecycle_state (str) – (optional) The current state of the task record. Allowed values are: “ACTIVE”, “INACTIVE”, “DELETED”, “DELETING”, “FAILED”, “UPDATING” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” 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 `TaskRecordCollection`
Return type:	`Response`
Example:

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

publish_runbook(publish_runbook_details, **kwargs)¶

Publish the specified version of the runbook. The specified version of the runbook becomes acitve when it is published.Only active versions of runbook can be used in execution.

Parameters:	publish_runbook_details (oci.fleet_apps_management.models.PublishRunbookDetails) – (required) Details for publishing the specified version of runbook. 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. 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 publish_runbook API.

set_default_runbook(set_default_runbook_details, **kwargs)¶

Set a runbook as default.

Parameters:	set_default_runbook_details (oci.fleet_apps_management.models.SetDefaultRunbookDetails) – (required) Details for setting the runbook as default for a platform and operation. 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. 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 `Runbook`
Return type:	`Response`
Example:

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

update_runbook(runbook_id, update_runbook_details, **kwargs)¶

Updates the runbook specified by the identifier.

Parameters:	runbook_id (str) – (required) Unique Runbook identifier update_runbook_details (oci.fleet_apps_management.models.UpdateRunbookDetails) – (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 None
Return type:	`Response`
Example:

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

update_runbook_version(runbook_version_id, update_runbook_version_details, **kwargs)¶

Updates the RunbookVersion.

Parameters:	runbook_version_id (str) – (required) Unique Runbook Version identifier update_runbook_version_details (oci.fleet_apps_management.models.UpdateRunbookVersionDetails) – (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 None
Return type:	`Response`
Example:

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

update_task_record(task_record_id, update_task_record_details, **kwargs)¶

Updates certain attributes for the specified task record.

Parameters:	task_record_id (str) – (required) The OCID of the task record. update_task_record_details (oci.fleet_apps_management.models.UpdateTaskRecordDetails) – (required) Attributes to update a task record. 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 update_task_record API.