JavaManagementServiceClient

class oci.jms.JavaManagementServiceClient(config, **kwargs)

API for the Java Management Service. Use this API to view, create, and manage Fleets.

Methods

__init__(config, **kwargs) Creates a new service client
change_fleet_compartment(fleet_id, …) Move a specified Fleet into the compartment identified in the POST form.
create_fleet(create_fleet_details, **kwargs) Create a new Fleet using the information provided.
delete_fleet(fleet_id, **kwargs) Deletes the Fleet specified by an identifier.
get_fleet(fleet_id, **kwargs) Retrieve a Fleet with the specified identifier.
get_fleet_agent_configuration(fleet_id, **kwargs) Retrieve a Fleet Agent Configuration for the specified Fleet.
get_work_request(work_request_id, **kwargs) Retrieve the details of a work request with the specified ID.
list_fleets(**kwargs) Returns a list of all the Fleets contained by a compartment.
list_work_request_errors(work_request_id, …) Retrieve a (paginated) list of errors for a specified work request.
list_work_request_logs(work_request_id, **kwargs) Retrieve a (paginated) list of logs for a specified work request.
list_work_requests(**kwargs) List the work requests in a compartment.
summarize_application_usage(fleet_id, **kwargs) List application usage in a Fleet filtered by query parameters.
summarize_installation_usage(fleet_id, **kwargs) List Java installation usage in a Fleet filtered by query parameters.
summarize_jre_usage(fleet_id, **kwargs) List Java Runtime usage in a specified Fleet filtered by query parameters.
summarize_managed_instance_usage(fleet_id, …) List managed instance usage in a Fleet filtered by query parameters.
update_fleet(fleet_id, update_fleet_details, …) Update the Fleet specified by an identifier.
update_fleet_agent_configuration(fleet_id, …) Update the Fleet Agent Configuration for the specified Fleet.
__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 will not have circuit breakers enabled by default, users can use their own circuit breaker strategy or the convenient DEFAULT_CIRCUIT_BREAKER_STRATEGY provided by the SDK to enable it. 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.
change_fleet_compartment(fleet_id, change_fleet_compartment_details, **kwargs)

Move a specified Fleet into the compartment identified in the POST form. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • change_fleet_compartment_details (oci.jms.models.ChangeFleetCompartmentDetails) – (required) Compartment 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_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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

create_fleet(create_fleet_details, **kwargs)

Create a new Fleet using the information provided.

Parameters:
  • create_fleet_details (oci.jms.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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

delete_fleet(fleet_id, **kwargs)

Deletes the Fleet specified by an identifier.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

get_fleet(fleet_id, **kwargs)

Retrieve a Fleet with the specified identifier.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Fleet

Return type:

Response

Example:

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

get_fleet_agent_configuration(fleet_id, **kwargs)

Retrieve a Fleet Agent Configuration for the specified Fleet.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type FleetAgentConfiguration

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

Retrieve the details of a work request with the specified ID.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the asynchronous work 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

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

list_fleets(**kwargs)

Returns a list of all the Fleets contained by a compartment.

Parameters:
  • compartment_id (str) –

    (optional) The OCID of the compartment in which to list resources.

  • id (str) – (optional) The ID of the Fleet.
  • lifecycle_state (str) –

    (optional) The state of the lifecycle.

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

  • display_name (str) – (optional) The display name.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort Fleets. Only one sort order may be provided. Default order for _timeCreated_, _approximateJreCount_, _approximateInstallationCount_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _displayName_ is ascending. If no value is specified _timeCreated_ is default.

    Allowed values are: “displayName”, “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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type FleetCollection

Return type:

Response

Example:

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

list_work_request_errors(work_request_id, **kwargs)

Retrieve a (paginated) list of errors for a specified work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the asynchronous work request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

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

list_work_request_logs(work_request_id, **kwargs)

Retrieve a (paginated) list of logs for a specified work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the asynchronous work request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

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

list_work_requests(**kwargs)

List the work requests in a compartment.

Parameters:
  • compartment_id (str) –

    (optional) The OCID of the compartment in which to list resources.

  • id (str) – (optional) The ID of an asynchronous work request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequestCollection

Return type:

Response

Example:

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

summarize_application_usage(fleet_id, **kwargs)

List application usage in a Fleet filtered by query parameters.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • application_id (str) – (optional) The Fleet-unique identifier of the application.
  • display_name (str) – (optional) The display name.
  • application_type (str) – (optional) The type of the application.
  • jre_vendor (str) – (optional) The vendor of the related Java Runtime.
  • jre_distribution (str) – (optional) The distribution of the related Java Runtime.
  • jre_version (str) – (optional) The version of the related Java Runtime.
  • installation_path (str) – (optional) The file system path of the installation.
  • managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance.
  • fields (list[str]) –

    (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateJreCount’, ‘approximateInstallationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateJreCount,approximateInstallationCount’.

    Allowed values are: “approximateJreCount”, “approximateInstallationCount”, “approximateManagedInstanceCount”

  • time_start (datetime) –

    (optional) The start of the time period during which resources are searched (formatted according to RFC3339).

  • time_end (datetime) –

    (optional) The end of the time period during which resources are searched (formatted according to RFC3339).

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort application views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _displayName_ and _osName_ is ascending. If no value is specified _timeLastSeen_ is default.

    Allowed values are: “timeFirstSeen”, “timeLastSeen”, “displayName”, “approximateJreCount”, “approximateInstallationCount”, “approximateManagedInstanceCount”, “osName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (list[str]) –

    (optional) The operating system type.

    Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ApplicationUsageCollection

Return type:

Response

Example:

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

summarize_installation_usage(fleet_id, **kwargs)

List Java installation usage in a Fleet filtered by query parameters.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • jre_vendor (str) – (optional) The vendor of the related Java Runtime.
  • jre_distribution (str) – (optional) The distribution of the related Java Runtime.
  • jre_version (str) – (optional) The version of the related Java Runtime.
  • installation_path (str) – (optional) The file system path of the installation.
  • application_id (str) – (optional) The Fleet-unique identifier of the related application.
  • managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance.
  • fields (list[str]) –

    (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateApplicationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateApplicationCount,approximateManagedInstanceCount’.

    Allowed values are: “approximateApplicationCount”, “approximateManagedInstanceCount”

  • time_start (datetime) –

    (optional) The start of the time period during which resources are searched (formatted according to RFC3339).

  • time_end (datetime) –

    (optional) The end of the time period during which resources are searched (formatted according to RFC3339).

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort installation views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _jreDistribution_ and _jreVendor_ is ascending. If no value is specified _timeLastSeen_ is default.

    Allowed values are: “jreDistribution”, “jreVendor”, “jreVersion”, “path”, “timeFirstSeen”, “timeLastSeen”, “approximateApplicationCount”, “approximateManagedInstanceCount”, “osName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (list[str]) –

    (optional) The operating system type.

    Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type InstallationUsageCollection

Return type:

Response

Example:

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

summarize_jre_usage(fleet_id, **kwargs)

List Java Runtime usage in a specified Fleet filtered by query parameters.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • jre_vendor (str) – (optional) The vendor of the Java Runtime.
  • jre_distribution (str) – (optional) The distribution of the Java Runtime.
  • jre_version (str) – (optional) The version of the Java Runtime.
  • application_id (str) – (optional) The Fleet-unique identifier of the related application.
  • managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance.
  • fields (list[str]) –

    (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateApplicationCount’, ‘approximateInstallationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateApplicationCount,approximateManagedInstanceCount’.

    Allowed values are: “approximateInstallationCount”, “approximateApplicationCount”, “approximateManagedInstanceCount”

  • time_start (datetime) –

    (optional) The start of the time period during which resources are searched (formatted according to RFC3339).

  • time_end (datetime) –

    (optional) The end of the time period during which resources are searched (formatted according to RFC3339).

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort JRE usages. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, and _version_ is descending. Default order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _distribution_, _vendor_, and _osName_ is ascending. If no value is specified _timeLastSeen_ is default.

    Allowed values are: “distribution”, “timeFirstSeen”, “timeLastSeen”, “vendor”, “version”, “approximateInstallationCount”, “approximateApplicationCount”, “approximateManagedInstanceCount”, “osName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (list[str]) –

    (optional) The operating system type.

    Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type JreUsageCollection

Return type:

Response

Example:

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

summarize_managed_instance_usage(fleet_id, **kwargs)

List managed instance usage in a Fleet filtered by query parameters.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance.
  • managed_instance_type (str) –

    (optional) The type of the managed instance.

    Allowed values are: “ORACLE_MANAGEMENT_AGENT”

  • jre_vendor (str) – (optional) The vendor of the related Java Runtime.
  • jre_distribution (str) – (optional) The distribution of the related Java Runtime.
  • jre_version (str) – (optional) The version of the related Java Runtime.
  • installation_path (str) – (optional) The file system path of the installation.
  • application_id (str) – (optional) The Fleet-unique identifier of the related application.
  • fields (list[str]) –

    (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateJreCount’, ‘approximateInstallationCount’ and ‘approximateApplicationCount’. For example ‘approximateJreCount,approximateInstallationCount’.

    Allowed values are: “approximateJreCount”, “approximateInstallationCount”, “approximateApplicationCount”

  • time_start (datetime) –

    (optional) The start of the time period during which resources are searched (formatted according to RFC3339).

  • time_end (datetime) –

    (optional) The end of the time period during which resources are searched (formatted according to RFC3339).

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) The sort order, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort managed instance views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, approximateJreCount_, _approximateInstallationCount_ and _approximateApplicationCount_ is descending. Default order for _osName_ is ascending. If no value is specified _timeLastSeen_ is default.

    Allowed values are: “timeFirstSeen”, “timeLastSeen”, “approximateJreCount”, “approximateInstallationCount”, “approximateApplicationCount”, “osName”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (list[str]) –

    (optional) The operating system type.

    Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN”

  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ManagedInstanceUsageCollection

Return type:

Response

Example:

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

update_fleet(fleet_id, update_fleet_details, **kwargs)

Update the Fleet specified by an identifier.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • update_fleet_details (oci.jms.models.UpdateFleetDetails) – (required) The new details for the Fleet.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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

update_fleet_agent_configuration(fleet_id, update_fleet_agent_configuration_details, **kwargs)

Update the Fleet Agent Configuration for the specified Fleet.

Parameters:
  • fleet_id (str) –

    (required) The OCID of the Fleet.

  • update_fleet_agent_configuration_details (oci.jms.models.UpdateFleetAgentConfigurationDetails) – (required) The new details for the Fleet Agent Configuration.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

Example:

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