FleetAppsManagementAdminClient¶

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

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

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_platform_configuration_compartment`(…)	Moves a PlatformConfiguration into a different compartment within the same tenancy.
`change_property_compartment`(property_id, …)	Moves a Property into a different compartment within the same tenancy.
`create_compliance_policy_rule`(…)	Creates a compliance policy rule.
`create_onboarding`(create_onboarding_details, …)	Onboard a tenant to Fleet Application Management.
`create_platform_configuration`(…)	Creates a new PlatformConfiguration.
`create_property`(create_property_details, …)	Create a business-specific metadata property in Fleet Application Management.
`delete_compliance_policy_rule`(…)	Deletes a compliance policy rule specified by an identifier.
`delete_onboarding`(onboarding_id, **kwargs)	Deletes Fleet Application Management onboarding resource by identifier
`delete_platform_configuration`(…)	Deletes a PlatformConfiguration resource by identifier
`delete_property`(property_id, **kwargs)	Delete a property in Fleet Application Management.
`enable_latest_policy`(onboarding_id, …)	Enable Policies for a newer version of Fleet Application Management
`get_compliance_policy`(compliance_policy_id, …)	Gets information about a compliance policy.
`get_compliance_policy_rule`(…)	Gets information about a compliance policy rule.
`get_onboarding`(onboarding_id, **kwargs)	Gets a Fleet Application Management Onboarding by identifier.
`get_platform_configuration`(…)	Gets a PlatformConfiguration by identifier
`get_property`(property_id, **kwargs)	Gets a Property by identifier
`list_compliance_policies`(**kwargs)	Returns a list of all the Compliance Policies in the specified compartment.
`list_compliance_policy_rules`(**kwargs)	Gets a list of Compliance policy rules in a compartment.
`list_onboarding_policies`(compartment_id, …)	Returns a list of onboarding policy information for Fleet Application Management.
`list_onboardings`(**kwargs)	Returns a list of all the onboardings in the specified root compartment (tenancy).
`list_platform_configurations`(**kwargs)	Returns a list of all the Platform Configurations in the specified compartment.
`list_properties`(**kwargs)	Returns a list of all the Properties in the specified compartment.
`manage_settings`(onboarding_id, …)	Updates the Onboarding setting
`update_compliance_policy_rule`(…)	Updates a compliance policy rule specified by an identifier.
`update_onboarding`(onboarding_id, …)	Updates the Onboarding
`update_platform_configuration`(…)	Updates the PlatformConfiguration
`update_property`(property_id, …)	Update a property in Fleet Application Management.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

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

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

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

change_platform_configuration_compartment(platform_configuration_id, change_platform_configuration_compartment_details, **kwargs)¶

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

Parameters:	platform_configuration_id (str) – (required) unique PlatformConfiguration identifier change_platform_configuration_compartment_details (oci.fleet_apps_management.models.ChangePlatformConfigurationCompartmentDetails) – (required) Details of the target compartment. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_property_compartment(property_id, change_property_compartment_details, **kwargs)¶

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

Parameters:	property_id (str) – (required) unique Property identifier change_property_compartment_details (oci.fleet_apps_management.models.ChangePropertyCompartmentDetails) – (required) Details of the target compartment. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_compliance_policy_rule(create_compliance_policy_rule_details, **kwargs)¶

Creates a compliance policy rule.

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

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

create_onboarding(create_onboarding_details, **kwargs)¶

Onboard a tenant to Fleet Application Management. The onboarding process lets Fleet Application Management create a few required policies that you need to start using it and its features.

Parameters:	create_onboarding_details (oci.fleet_apps_management.models.CreateOnboardingDetails) – (required) Details for onboarding Fleet Application Management. 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 `Onboarding`
Return type:	`Response`
Example:

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

create_platform_configuration(create_platform_configuration_details, **kwargs)¶

Creates a new PlatformConfiguration.

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

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

create_property(create_property_details, **kwargs)¶

Create a business-specific metadata property in Fleet Application Management.

Parameters:	create_property_details (oci.fleet_apps_management.models.CreatePropertyDetails) – (required) Details for the new Property. 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 ModelProperty
Return type:	`Response`
Example:

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

delete_compliance_policy_rule(compliance_policy_rule_id, **kwargs)¶

Deletes a compliance policy rule specified by an identifier.

Parameters:	compliance_policy_rule_id (str) – (required) unique CompliancePolicyRule 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_compliance_policy_rule API.

delete_onboarding(onboarding_id, **kwargs)¶

Deletes Fleet Application Management onboarding resource by identifier

Parameters:	onboarding_id (str) – (required) A filter to return resources whose Onboarding identifier matches the given 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_onboarding API.

delete_platform_configuration(platform_configuration_id, **kwargs)¶

Deletes a PlatformConfiguration resource by identifier

Parameters:	platform_configuration_id (str) – (required) unique PlatformConfiguration 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_platform_configuration API.

delete_property(property_id, **kwargs)¶

Delete a property in Fleet Application Management.

Parameters:	property_id (str) – (required) unique Property 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_property API.

enable_latest_policy(onboarding_id, enable_latest_policy_details, **kwargs)¶

Enable Policies for a newer version of Fleet Application Management

Parameters:	onboarding_id (str) – (required) A filter to return resources whose Onboarding identifier matches the given identifier. enable_latest_policy_details (oci.fleet_apps_management.models.EnableLatestPolicyDetails) – (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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

get_compliance_policy(compliance_policy_id, **kwargs)¶

Gets information about a compliance policy.

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

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

get_compliance_policy_rule(compliance_policy_rule_id, **kwargs)¶

Gets information about a compliance policy rule.

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

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

get_onboarding(onboarding_id, **kwargs)¶

Gets a Fleet Application Management Onboarding by identifier.

Parameters:	onboarding_id (str) – (required) A filter to return resources whose Onboarding identifier matches the given 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 `Onboarding`
Return type:	`Response`
Example:

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

get_platform_configuration(platform_configuration_id, **kwargs)¶

Gets a PlatformConfiguration by identifier

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

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

get_property(property_id, **kwargs)¶

Gets a Property by identifier

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

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

list_compliance_policies(**kwargs)¶

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

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. lifecycle_state (str) – (optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only resources that match the entire display name given. type (str) – (optional) A filter to return Platform Configurations whose type matches the given type. Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED” id (str) – (optional) Unique identifier or OCID for listing a single Compliance Policy by id. Either compartmentId or id must be provided. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CompliancePolicyCollection`
Return type:	`Response`
Example:

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

list_compliance_policy_rules(**kwargs)¶

Gets a list of Compliance policy rules in a compartment.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” patch_name (str) – (optional) A filter to return only resources that match the patch selection against the given patch name. compliance_policy_id (str) – (optional) unique CompliancePolicy identifier. id (str) – (optional) Unique identifier or OCID for listing a single Compliance Policy Rule by id. Either compartmentId or id must be provided. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CompliancePolicyRuleCollection`
Return type:	`Response`
Example:

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

list_onboarding_policies(compartment_id, **kwargs)¶

Returns a list of onboarding policy information for Fleet Application Management.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) 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. Allowed values are: “timeCreated” 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 `OnboardingPolicyCollection`
Return type:	`Response`
Example:

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

list_onboardings(**kwargs)¶

Returns a list of all the onboardings in the specified root compartment (tenancy). The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. lifecycle_state (str) – (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “INACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, “NEEDS_ATTENTION” id (str) – (optional) Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OnboardingCollection`
Return type:	`Response`
Example:

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

list_platform_configurations(**kwargs)¶

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

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETED”, “FAILED”, “DELETING”, “UPDATING”, “CREATING” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. config_category (str) – (optional) Config Category Allowed values are: “PRODUCT”, “PRODUCT_STACK”, “ENVIRONMENT”, “PATCH_TYPE”, “CREDENTIAL”, “SELF_HOSTED_INSTANCE”, “LIFECYCLE_OPERATION” compartment_id_in_subtree (bool) – (optional) If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. type (str) – (optional) A filter to return Platform Configurations whose type matches the given type. Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PlatformConfigurationCollection`
Return type:	`Response`
Example:

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

list_properties(**kwargs)¶

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

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. lifecycle_state (str) – (optional) A filter to return only resources whose lifecycleState matches the given lifecycleState. Allowed values are: “ACTIVE”, “DELETED”, “FAILED”, “UPDATING” display_name (str) – (optional) A filter to return only resources that match the entire display name given. id (str) – (optional) Unique identifier or OCID for listing a single Property by id. Either compartmentId or id must be provided. type (str) – (optional) A filter to return properties whose type matches the given type. Allowed values are: “USER_DEFINED”, “ORACLE_DEFINED”, “SYSTEM_DEFINED” scope (str) – (optional) A filter to return only resources their scope matches the given scope. Allowed values are: “TAXONOMY”, “PLATFORM_CONFIG” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PropertyCollection`
Return type:	`Response`
Example:

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

manage_settings(onboarding_id, manage_settings_details, **kwargs)¶

Updates the Onboarding setting

Parameters:	onboarding_id (str) – (required) A filter to return resources whose Onboarding identifier matches the given identifier. manage_settings_details (oci.fleet_apps_management.models.ManageSettingsDetails) – (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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

update_compliance_policy_rule(compliance_policy_rule_id, update_compliance_policy_rule_details, **kwargs)¶

Updates a compliance policy rule specified by an identifier.

Parameters:	compliance_policy_rule_id (str) – (required) unique CompliancePolicyRule identifier. update_compliance_policy_rule_details (oci.fleet_apps_management.models.UpdateCompliancePolicyRuleDetails) – (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_compliance_policy_rule API.

update_onboarding(onboarding_id, update_onboarding_details, **kwargs)¶

Updates the Onboarding

Parameters:	onboarding_id (str) – (required) A filter to return resources whose Onboarding identifier matches the given identifier. update_onboarding_details (oci.fleet_apps_management.models.UpdateOnboardingDetails) – (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_onboarding API.

update_platform_configuration(platform_configuration_id, update_platform_configuration_details, **kwargs)¶

Updates the PlatformConfiguration

Parameters:	platform_configuration_id (str) – (required) unique PlatformConfiguration identifier update_platform_configuration_details (oci.fleet_apps_management.models.UpdatePlatformConfigurationDetails) – (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_platform_configuration API.

update_property(property_id, update_property_details, **kwargs)¶

Update a property in Fleet Application Management.

Parameters:	property_id (str) – (required) unique Property identifier update_property_details (oci.fleet_apps_management.models.UpdatePropertyDetails) – (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 ModelProperty
Return type:	`Response`
Example:

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