FleetAppsManagementOperationsClient¶

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

Fleet Application Management Service API. Use this API to for all FAMS related activities. To manage fleets,view complaince report for the Fleet,scedule patches and other lifecycle activities

Methods

`__init__`(config, **kwargs)	Creates a new service client
`create_scheduler_definition`(…)	Creates a new SchedulerDefinition.
`delete_scheduler_definition`(…)	Deletes a SchedulerDefinition resource by identifier
`delete_scheduler_job`(scheduler_job_id, **kwargs)	Deletes a SchedulerJob resource by identifier
`get_execution`(scheduler_job_id, …)	Gets a JobActivity by identifier
`get_job_activity`(scheduler_job_id, …)	Gets a JobActivity by identifier
`get_scheduler_definition`(…)	Gets a SchedulerDefinition by identifier
`get_scheduler_job`(scheduler_job_id, **kwargs)	Gets a SchedulerJob by identifier
`list_executions`(scheduler_job_id, …)	Returns a list of Task Executions for a Resource.
`list_scheduled_fleets`(…)	Returns a list of ScheduledFleets
`list_scheduler_definitions`(**kwargs)	Returns a list of SchedulerDefinitions.
`list_scheduler_jobs`(**kwargs)	Returns a list of SchedulerJobs.
`update_scheduler_definition`(…)	Updates the SchedulerDefinition
`update_scheduler_job`(scheduler_job_id, …)	Updates the SchedulerJob

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

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

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

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

create_scheduler_definition(create_scheduler_definition_details, **kwargs)¶

Creates a new SchedulerDefinition.

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

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

delete_scheduler_definition(scheduler_definition_id, **kwargs)¶

Deletes a SchedulerDefinition resource by identifier

Parameters:	scheduler_definition_id (str) – (required) unique SchedulerDefinition 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_scheduler_definition API.

delete_scheduler_job(scheduler_job_id, **kwargs)¶

Deletes a SchedulerJob resource by identifier

Parameters:	scheduler_job_id (str) – (required) unique SchedulerJob 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_scheduler_job API.

get_execution(scheduler_job_id, job_activity_id, resource_id, execution_id, **kwargs)¶

Gets a JobActivity by identifier

Parameters:	scheduler_job_id (str) – (required) unique SchedulerJob identifier job_activity_id (str) – (required) unique jobActivity identifier resource_id (str) – (required) unique Resource identifier execution_id (str) – (required) Execution Id 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 `Execution`
Return type:	`Response`
Example:

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

get_job_activity(scheduler_job_id, job_activity_id, **kwargs)¶

Gets a JobActivity by identifier

Parameters:	scheduler_job_id (str) – (required) unique SchedulerJob identifier job_activity_id (str) – (required) unique jobActivity 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 `JobActivity`
Return type:	`Response`
Example:

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

get_scheduler_definition(scheduler_definition_id, **kwargs)¶

Gets a SchedulerDefinition by identifier

Parameters:	scheduler_definition_id (str) – (required) unique SchedulerDefinition 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 `SchedulerDefinition`
Return type:	`Response`
Example:

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

get_scheduler_job(scheduler_job_id, **kwargs)¶

Gets a SchedulerJob by identifier

Parameters:	scheduler_job_id (str) – (required) unique SchedulerJob 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 `SchedulerJob`
Return type:	`Response`
Example:

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

list_executions(scheduler_job_id, job_activity_id, resource_id, **kwargs)¶

Returns a list of Task Executions for a Resource.

Parameters:	scheduler_job_id (str) – (required) unique SchedulerJob identifier job_activity_id (str) – (required) unique jobActivity identifier resource_id (str) – (required) unique Resource identifier resource_task_id (str) – (optional) Task Id step_name (str) – (optional) Unique step name target_name (str) – (optional) Unique target name sequence (str) – (optional) Task Order Sequence 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 timeStarted is descending. Allowed values are: “timeStarted” 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 `ExecutionCollection`
Return type:	`Response`
Example:

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

list_scheduled_fleets(scheduler_definition_id, **kwargs)¶

Returns a list of ScheduledFleets

Parameters:	scheduler_definition_id (str) – (required) unique SchedulerDefinition identifier compartment_id (str) – (optional) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. Allowed values are: “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 `ScheduledFleetCollection`
Return type:	`Response`
Example:

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

list_scheduler_definitions(**kwargs)¶

Returns a list of SchedulerDefinitions.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE” display_name (str) – (optional) A filter to return only resources that match the entire display name given. product (str) – (optional) A filter to return only Scheduler Definitions whose assocaited product matches the given product id (str) – (optional) unique SchedulerDefinition identifier maintenance_window_id (str) – (optional) unique MaintenanceWindow identifier fleet_id (str) – (optional) unique Fleet 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 and timeOfNextRun is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName”, “timeOfNextRun” 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 `SchedulerDefinitionCollection`
Return type:	`Response`
Example:

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

list_scheduler_jobs(**kwargs)¶

Returns a list of SchedulerJobs.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETED”, “FAILED” fleet_id (str) – (optional) unique Fleet identifier time_scheduled_greater_than_or_equal_to (datetime) – (optional) Scheduled Time time_scheduled_less_than (datetime) – (optional) Scheduled Time is_remediation_job_needed (bool) – (optional) Fetch next remediation Job display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) unique SchedulerJob identifier defintion_id (str) – (optional) SchedulerJob Definition 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 and timeScheduled is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “timeScheduled”, “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 `SchedulerJobCollection`
Return type:	`Response`
Example:

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

update_scheduler_definition(scheduler_definition_id, update_scheduler_definition_details, **kwargs)¶

Updates the SchedulerDefinition

Parameters:	scheduler_definition_id (str) – (required) unique SchedulerDefinition identifier update_scheduler_definition_details (oci.fleet_apps_management.models.UpdateSchedulerDefinitionDetails) – (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_scheduler_definition API.

update_scheduler_job(scheduler_job_id, update_scheduler_job_details, **kwargs)¶

Updates the SchedulerJob

Parameters:	scheduler_job_id (str) – (required) unique SchedulerJob identifier update_scheduler_job_details (oci.fleet_apps_management.models.UpdateSchedulerJobDetails) – (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 `SchedulerJob`
Return type:	`Response`
Example:

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