FleetAppsManagementClient¶
-
class
oci.fleet_apps_management.
FleetAppsManagementClient
(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 check_resource_tagging
(…)Check if Fleet Application Management tags can be added to the resources. confirm_targets
(confirm_targets_details, …)Confirm targets to be managed for a Fleet. create_fleet
(create_fleet_details, **kwargs)Create a product, environment, group, or generic type of fleet in Fleet Application Management. create_fleet_credential
(…)Add credentials to a fleet in Fleet Application Management. create_fleet_property
(…)Add an existing global property to a fleet in Fleet Application Management. create_fleet_resource
(…)Add resource to a fleet in Fleet Application Management. delete_fleet
(fleet_id, **kwargs)Delete a fleet in Fleet Application Management. delete_fleet_credential
(fleet_credential_id, …)Delete a credential associated with a fleet product or application in Fleet Application Management. delete_fleet_property
(fleet_property_id, …)Delete a property associated with a fleet in Fleet Application Management. delete_fleet_resource
(fleet_resource_id, …)Removes a resource from the fleet in Fleet Application Management. generate_compliance_report
(…)Generate compliance reports for a Fleet. get_compliance_report
(fleet_id, …)Retrieve compliance report for a fleet. get_fleet
(fleet_id, **kwargs)Get the details of a fleet in Fleet Application Management. get_fleet_credential
(fleet_credential_id, …)Gets a FleetCredential by identifier. get_fleet_property
(fleet_property_id, …)Gets a Fleet Property by identifier. get_fleet_resource
(fleet_resource_id, …)Gets a Fleet Resource by identifier. get_work_request
(work_request_id, **kwargs)Gets details of the work request with the given ID. list_announcements
(**kwargs)Return a list of AnnouncementSummary items. list_fleet_credentials
(fleet_id, **kwargs)List credentials in Fleet Application Management. list_fleet_products
(fleet_id, **kwargs)Returns a list of products associated with the confirmed targets. list_fleet_properties
(fleet_id, **kwargs)List fleet properties in Fleet Application Management. list_fleet_resources
(fleet_id, **kwargs)List resources for a fleet in Fleet Application Management. list_fleet_targets
(fleet_id, **kwargs)Returns the list of all confirmed targets within a fleet. list_fleets
(**kwargs)Returns a list of Fleets in the specified Tenancy. list_inventory_resources
(compartment_id, …)Returns a list of InventoryResources. list_targets
(fleet_id, **kwargs)Return all targets belonging to the resources within a fleet. list_work_request_errors
(work_request_id, …)Returns a (paginated) list of errors for the work request with the given ID. list_work_request_logs
(work_request_id, **kwargs)Returns a (paginated) list of logs for the work request with the given ID. list_work_requests
(**kwargs)Lists the work requests in a compartment. request_resource_validation
(…)Request validation for resources within a fleet. request_target_discovery
(…)Confirm targets to be managed for a Fleet. update_fleet
(fleet_id, update_fleet_details, …)Update fleet information in Fleet Application Management. update_fleet_credential
(fleet_credential_id, …)Edit credentials associated with a product or application in Fleet Application Management. update_fleet_property
(fleet_property_id, …)Edit a property associated with a fleet in Fleet Application Management. update_fleet_resource
(fleet_resource_id, …)Updates the FleetResource. -
__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, adict
can be passed. You can validate_config the dict usingvalidate_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 convenienceDEFAULT_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.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
check_resource_tagging
(check_resource_tagging_details, **kwargs)¶ Check if Fleet Application Management tags can be added to the resources.
Parameters: - check_resource_tagging_details (oci.fleet_apps_management.models.CheckResourceTaggingDetails) – (required) Details for checking if Fleet Application Management tags can be added to the resources.
- 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 usesDEFAULT_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 typeResourceTagCheckDetails
Return type: Example: Click here to see an example of how to use check_resource_tagging API.
-
confirm_targets
(confirm_targets_details, fleet_id, **kwargs)¶ Confirm targets to be managed for a Fleet. Only targets that are confirmed will be managed by Fleet Application Management
Parameters: - confirm_targets_details (oci.fleet_apps_management.models.ConfirmTargetsDetails) – (required) Details for confirming Targets.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use confirm_targets API.
-
create_fleet
(create_fleet_details, **kwargs)¶ Create a product, environment, group, or generic type of fleet in Fleet Application Management.
Parameters: - create_fleet_details (oci.fleet_apps_management.models.CreateFleetDetails) – (required) Details for the new Fleet.
- 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 usesDEFAULT_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: Return type: Example: Click here to see an example of how to use create_fleet API.
-
create_fleet_credential
(create_fleet_credential_details, fleet_id, **kwargs)¶ Add credentials to a fleet in Fleet Application Management.
Parameters: - create_fleet_credential_details (oci.fleet_apps_management.models.CreateFleetCredentialDetails) – (required) Details for the new FleetCredential.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 typeFleetCredential
Return type: Example: Click here to see an example of how to use create_fleet_credential API.
-
create_fleet_property
(create_fleet_property_details, fleet_id, **kwargs)¶ Add an existing global property to a fleet in Fleet Application Management.
Parameters: - create_fleet_property_details (oci.fleet_apps_management.models.CreateFleetPropertyDetails) – (required) Details for the new FleetProperty.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 typeFleetProperty
Return type: Example: Click here to see an example of how to use create_fleet_property API.
-
create_fleet_resource
(create_fleet_resource_details, fleet_id, **kwargs)¶ Add resource to a fleet in Fleet Application Management.
Parameters: - create_fleet_resource_details (oci.fleet_apps_management.models.CreateFleetResourceDetails) – (required) Details for the new FleetResource.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 typeFleetResource
Return type: Example: Click here to see an example of how to use create_fleet_resource API.
-
delete_fleet
(fleet_id, **kwargs)¶ Delete a fleet in Fleet Application Management.
Parameters: - fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use delete_fleet API.
-
delete_fleet_credential
(fleet_credential_id, fleet_id, **kwargs)¶ Delete a credential associated with a fleet product or application in Fleet Application Management.
Parameters: - fleet_credential_id (str) – (required) unique FleetCredential identifier
- fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use delete_fleet_credential API.
-
delete_fleet_property
(fleet_property_id, fleet_id, **kwargs)¶ Delete a property associated with a fleet in Fleet Application Management.
Parameters: - fleet_property_id (str) – (required) unique FleetProperty identifier.
- fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use delete_fleet_property API.
-
delete_fleet_resource
(fleet_resource_id, fleet_id, **kwargs)¶ Removes a resource from the fleet in Fleet Application Management.
Parameters: - fleet_resource_id (str) – (required) unique FleetResource identifier
- fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use delete_fleet_resource API.
-
generate_compliance_report
(generate_compliance_report_details, fleet_id, **kwargs)¶ Generate compliance reports for a Fleet.
Parameters: - generate_compliance_report_details (oci.fleet_apps_management.models.GenerateComplianceReportDetails) – (required) Details for generating Compliance Report for the Fleet.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use generate_compliance_report API.
-
get_compliance_report
(fleet_id, compliance_report_id, **kwargs)¶ Retrieve compliance report for a fleet.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- compliance_report_id (str) – (required) compliance report 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 usesDEFAULT_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 typeComplianceReport
Return type: Example: Click here to see an example of how to use get_compliance_report API.
-
get_fleet
(fleet_id, **kwargs)¶ Get the details of a fleet in Fleet Application Management.
Parameters: - fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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: Return type: Example: Click here to see an example of how to use get_fleet API.
-
get_fleet_credential
(fleet_credential_id, fleet_id, **kwargs)¶ Gets a FleetCredential by identifier.
Parameters: - fleet_credential_id (str) – (required) unique FleetCredential identifier
- fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 typeFleetCredential
Return type: Example: Click here to see an example of how to use get_fleet_credential API.
-
get_fleet_property
(fleet_property_id, fleet_id, **kwargs)¶ Gets a Fleet Property by identifier.
Parameters: - fleet_property_id (str) – (required) unique FleetProperty identifier.
- fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 typeFleetProperty
Return type: Example: Click here to see an example of how to use get_fleet_property API.
-
get_fleet_resource
(fleet_resource_id, fleet_id, **kwargs)¶ Gets a Fleet Resource by identifier.
Parameters: - fleet_resource_id (str) – (required) unique FleetResource identifier
- fleet_id (str) – (required) Unique Fleet 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 usesDEFAULT_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 typeFleetResource
Return type: Example: Click here to see an example of how to use get_fleet_resource API.
-
get_work_request
(work_request_id, **kwargs)¶ Gets details of the work request with the given ID.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- 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 usesDEFAULT_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 typeWorkRequest
Return type: Example: Click here to see an example of how to use get_work_request API.
-
list_announcements
(**kwargs)¶ Return a list of AnnouncementSummary items.
Parameters: - summary_contains (str) – (optional) Filter the list of announcements that contains the given summary value.
- 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 AnnouncementSummary by. Only one sort order may be provided. If no value is specified timeReleased is default.
Allowed values are: “timeReleased”, “summary”
- 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 usesDEFAULT_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 typeAnnouncementCollection
Return type: Example: Click here to see an example of how to use list_announcements API.
-
list_fleet_credentials
(fleet_id, **kwargs)¶ List credentials in Fleet Application Management.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- lifecycle_state (str) –
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
Allowed values are: “ACTIVE”, “DELETED”, “FAILED”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- resource_id (str) – (optional) Resource Identifier
- target (str) – (optional) A filter to return only resources whose target matches the given target name.
- credential_level (str) –
(optional) A filter to return only resources whose credentialLevel matches the given credentialLevel.
Allowed values are: “FLEET”, “RESOURCE”, “TARGET”
- id (str) – (optional) A filter to return only resources whose credential 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.
- 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 usesDEFAULT_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 typeFleetCredentialCollection
Return type: Example: Click here to see an example of how to use list_fleet_credentials API.
-
list_fleet_products
(fleet_id, **kwargs)¶ Returns a list of products associated with the confirmed targets.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- resource_id (str) – (optional) Resource Identifier
- resource_display_name (str) – (optional) Resource Display Name.
- 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 and resourceDisplayName is ascending.
Allowed values are: “displayName”, “resourceDisplayName”
- 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 usesDEFAULT_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 typeFleetProductCollection
Return type: Example: Click here to see an example of how to use list_fleet_products API.
-
list_fleet_properties
(fleet_id, **kwargs)¶ List fleet properties in Fleet Application Management.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- lifecycle_state (str) –
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
Allowed values are: “ACTIVE”, “DELETED”, “FAILED”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) – (optional) A filter to return only resources whose fleetProperty 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.
- 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 usesDEFAULT_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 typeFleetPropertyCollection
Return type: Example: Click here to see an example of how to use list_fleet_properties API.
-
list_fleet_resources
(fleet_id, **kwargs)¶ List resources for a fleet in Fleet Application Management.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- tenancy_id (str) – (optional) Resource Tenancy Id
- lifecycle_state (str) –
(optional) A filter to return only resources whose lifecycleState matches the given lifecycleState.
Allowed values are: “ACTIVE”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) – (optional) A filter to return only resources whose identifier matches the given identifier.
- fleet_resource_type (str) – (optional) A filter to return only resources whose resourceType matches the given resourceType.
- 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 usesDEFAULT_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 typeFleetResourceCollection
Return type: Example: Click here to see an example of how to use list_fleet_resources API.
-
list_fleet_targets
(fleet_id, **kwargs)¶ Returns the list of all confirmed targets within a fleet.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- product (str) – (optional) Product Name.
- resource_id (str) – (optional) Resource Identifier
- resource_display_name (str) – (optional) Resource Display Name.
- 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,product and resourceDisplayName is ascending.
Allowed values are: “displayName”, “product”, “resourceDisplayName”
- 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 usesDEFAULT_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 typeFleetTargetCollection
Return type: Example: Click here to see an example of how to use list_fleet_targets API.
-
list_fleets
(**kwargs)¶ Returns a list of Fleets in the specified Tenancy.
Parameters: - lifecycle_state (str) –
(optional) A filter to return fleets whose lifecycleState matches the given lifecycleState.
Allowed values are: “ACTIVE”, “INACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, “NEEDS_ATTENTION”
- compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- fleet_type (str) –
(optional) A filter to return fleets whose fleetType matches the given fleetType.
Allowed values are: “PRODUCT”, “ENVIRONMENT”, “GENERIC”, “GROUP”
- application_type (str) – (optional) A filter to return resources that match the Application Type/Product Stack given..
- product (str) – (optional) A filter to return resources that match the Product given.
- environment_type (str) – (optional) A filter to return resources that match the Environment Type given.
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- id (str) – (optional) A filter to return fleets whose id matches the given 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 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 usesDEFAULT_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 typeFleetCollection
Return type: Example: Click here to see an example of how to use list_fleets API.
- lifecycle_state (str) –
-
list_inventory_resources
(compartment_id, resource_compartment_id, **kwargs)¶ Returns a list of InventoryResources.
Parameters: - compartment_id (str) – (required) A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID.
- resource_compartment_id (str) – (required) A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID.
- lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- resource_region (str) – (optional) Resource Region
- defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}={value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. Example: Identification.Development=Yes
- freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.
- inventory_properties (list[str]) – (optional) A list of inventory properties filters to apply. The key for each inventory property and value for each resource type is “{resourceType}.{inventoryProperty}={value}”. Example: Instance.displayName=TEST_INSTANCE
- matching_criteria (str) – (optional) Fetch resources matching ANY or ALL criteria passed as params in “tags” and “inventoryProperties”. Example: matchingCriteria=ANY
- 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 usesDEFAULT_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 typeInventoryResourceCollection
Return type: Example: Click here to see an example of how to use list_inventory_resources API.
-
list_targets
(fleet_id, **kwargs)¶ Return all targets belonging to the resources within a fleet. It will include both confirmed and unconfirmed targets.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- display_name (str) – (optional) A filter to return only resources that match the entire display name given.
- limit (int) – (optional) The maximum number of items to return.
- page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
- sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.
Allowed values are: “ASC”, “DESC”
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
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 usesDEFAULT_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 typeFleetTargetCollection
Return type: Example: Click here to see an example of how to use list_targets API.
-
list_work_request_errors
(work_request_id, **kwargs)¶ Returns a (paginated) list of errors for the work request with the given ID.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- 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.
- limit (int) – (optional) The maximum number of items to return.
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
Allowed values are: “timestamp”
- sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.
Allowed values are: “ASC”, “DESC”
- 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 usesDEFAULT_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 typeWorkRequestErrorCollection
Return type: Example: Click here to see an example of how to use list_work_request_errors API.
-
list_work_request_logs
(work_request_id, **kwargs)¶ Returns a (paginated) list of logs for the work request with the given ID.
Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- opc_request_id (str) – (optional) The client request ID for tracing.
- 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.
- limit (int) – (optional) The maximum number of items to return.
- sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
Allowed values are: “timestamp”
- sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.
Allowed values are: “ASC”, “DESC”
- 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 usesDEFAULT_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 typeWorkRequestLogEntryCollection
Return type: Example: Click here to see an example of how to use list_work_request_logs API.
-
list_work_requests
(**kwargs)¶ Lists the work requests in a compartment.
Parameters: - compartment_id (str) – (optional) The ID of the compartment in which to list resources.
- work_request_id (str) – (optional) The ID of the asynchronous work request.
- status (str) –
(optional) A filter to return only resources their lifecycleState matches the given OperationStatus.
Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”
- resource_id (str) – (optional) Resource Identifier
- opc_request_id (str) – (optional) The client request ID for tracing.
- 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.
- limit (int) – (optional) The maximum number of items to return.
- 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 timeAccepted is descending.
Allowed values are: “timeAccepted”
- 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 usesDEFAULT_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 typeWorkRequestSummaryCollection
Return type: Example: Click here to see an example of how to use list_work_requests API.
-
request_resource_validation
(request_resource_validation_details, fleet_id, **kwargs)¶ Request validation for resources within a fleet.
Parameters: - request_resource_validation_details (oci.fleet_apps_management.models.RequestResourceValidationDetails) – (required) Details for requesting resource validation.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use request_resource_validation API.
-
request_target_discovery
(request_target_discovery_details, fleet_id, **kwargs)¶ Confirm targets to be managed for a Fleet. Only targets that are confirmed will be managed by Fleet Application Management
Parameters: - request_target_discovery_details (oci.fleet_apps_management.models.RequestTargetDiscoveryDetails) – (required) Details for requesting target discovery.
- fleet_id (str) – (required) Unique Fleet identifier.
- 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use request_target_discovery API.
-
update_fleet
(fleet_id, update_fleet_details, **kwargs)¶ Update fleet information in Fleet Application Management.
Parameters: - fleet_id (str) – (required) Unique Fleet identifier.
- update_fleet_details (oci.fleet_apps_management.models.UpdateFleetDetails) – (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 usesDEFAULT_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: Return type: Example: Click here to see an example of how to use update_fleet API.
-
update_fleet_credential
(fleet_credential_id, fleet_id, update_fleet_credential_details, **kwargs)¶ Edit credentials associated with a product or application in Fleet Application Management.
Parameters: - fleet_credential_id (str) – (required) unique FleetCredential identifier
- fleet_id (str) – (required) Unique Fleet identifier.
- update_fleet_credential_details (oci.fleet_apps_management.models.UpdateFleetCredentialDetails) – (required) The credential 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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use update_fleet_credential API.
-
update_fleet_property
(fleet_property_id, fleet_id, update_fleet_property_details, **kwargs)¶ Edit a property associated with a fleet in Fleet Application Management.
Parameters: - fleet_property_id (str) – (required) unique FleetProperty identifier.
- fleet_id (str) – (required) Unique Fleet identifier.
- update_fleet_property_details (oci.fleet_apps_management.models.UpdateFleetPropertyDetails) – (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 usesDEFAULT_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 typeFleetProperty
Return type: Example: Click here to see an example of how to use update_fleet_property API.
-
update_fleet_resource
(fleet_resource_id, fleet_id, update_fleet_resource_details, **kwargs)¶ Updates the FleetResource.
Parameters: - fleet_resource_id (str) – (required) unique FleetResource identifier
- fleet_id (str) – (required) Unique Fleet identifier.
- update_fleet_resource_details (oci.fleet_apps_management.models.UpdateFleetResourceDetails) – (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 usesDEFAULT_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 NoneReturn type: Example: Click here to see an example of how to use update_fleet_resource API.
-