DesktopServiceClient¶

class oci.desktops.DesktopServiceClient(config, **kwargs)¶

Create and manage cloud-hosted desktops which can be accessed from a web browser or installed client.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`cancel_work_request`(work_request_id, **kwargs)	Cancel work request with the given ID.
`change_desktop_pool_compartment`(…)	Moves a desktop pool into a different compartment within the same tenancy.
`create_desktop_pool`(…)	Creates a desktop pool with the given configuration parameters.
`delete_desktop`(desktop_id, **kwargs)	Deletes the desktop with the specified OCID.
`delete_desktop_pool`(desktop_pool_id, **kwargs)	Deletes a desktop pool with the specified OCID.
`get_desktop`(desktop_id, **kwargs)	Provides information about the desktop with the specified OCID.
`get_desktop_pool`(desktop_pool_id, **kwargs)	Returns information about the desktop pool including all configuration parameters and the current state.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given ID.
`list_desktop_pool_desktops`(compartment_id, …)	Returns a list of desktops within a given desktop pool.
`list_desktop_pool_volumes`(desktop_pool_id, …)	Returns a list of volumes within the given desktop pool.
`list_desktop_pools`(compartment_id, **kwargs)	Returns a list of desktop pools within the given compartment.
`list_desktops`(compartment_id, **kwargs)	Returns a list of desktops filtered by the specified parameters.
`list_work_request_errors`(work_request_id, …)	Return a (paginated) list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Return a (paginated) list of logs for a given work request.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a compartment.
`start_desktop`(desktop_id, **kwargs)	Starts the desktop with the specified OCID.
`start_desktop_pool`(desktop_pool_id, **kwargs)	Starts the desktop pool with the specified OCID.
`stop_desktop`(desktop_id, **kwargs)	Stops the desktop with the specified OCID.
`stop_desktop_pool`(desktop_pool_id, **kwargs)	Stops the desktop pool with the specified OCID.
`update_desktop`(desktop_id, …)	Modifies information about the desktop such as the name.
`update_desktop_pool`(desktop_pool_id, …)	Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.

__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.

cancel_work_request(work_request_id, **kwargs)¶

Cancel work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. if_match (str) – (optional) For optimistic concurrency control. opc_request_id (str) – (optional) The unique identifier of the request. 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 cancel_work_request API.

change_desktop_pool_compartment(desktop_pool_id, change_desktop_pool_compartment_details, **kwargs)¶

Moves a desktop pool into a different compartment within the same tenancy. You must provide the OCID of the desktop pool and the OCID of the compartment that you are moving the pool to.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. change_desktop_pool_compartment_details (oci.desktops.models.ChangeDesktopPoolCompartmentDetails) – (required) The details of the new compartment of the desktop pool. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. opc_retry_token (str) – (optional) A token that uniquely identifies a request. 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_desktop_pool_compartment API.

create_desktop_pool(create_desktop_pool_details, **kwargs)¶

Creates a desktop pool with the given configuration parameters.

Parameters:	create_desktop_pool_details (oci.desktops.models.CreateDesktopPoolDetails) – (required) The details of the desktop pool to create. opc_retry_token (str) – (optional) A token that uniquely identifies a request. opc_request_id (str) – (optional) The unique identifier of the request. 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 `DesktopPool`
Return type:	`Response`
Example:

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

delete_desktop(desktop_id, **kwargs)¶

Deletes the desktop with the specified OCID. The service terminates the associated compute instance. The end-user loses access to the desktop instance permanently. Any associated block volume becomes inactive but is not deleted.

Parameters:	desktop_id (str) – (required) The OCID of the desktop. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. 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_desktop API.

delete_desktop_pool(desktop_pool_id, **kwargs)¶

Deletes a desktop pool with the specified OCID. The service terminates all compute instances and users immediately lose access to their desktops. You can choose to preserve the block volumes associated with the pool.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. are_volumes_preserved (bool) – (optional) Whether the volumes are preserved when a desktop pool is deleted. 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_desktop_pool API.

get_desktop(desktop_id, **kwargs)¶

Provides information about the desktop with the specified OCID.

Parameters:	desktop_id (str) – (required) The OCID of the desktop. opc_request_id (str) – (optional) The unique identifier of the request. 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 `Desktop`
Return type:	`Response`
Example:

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

get_desktop_pool(desktop_pool_id, **kwargs)¶

Returns information about the desktop pool including all configuration parameters and the current state.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. opc_request_id (str) – (optional) The unique identifier of the request. 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 `DesktopPool`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

Gets the status 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 unique identifier of the request. 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 `WorkRequest`
Return type:	`Response`
Example:

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

list_desktop_pool_desktops(compartment_id, desktop_pool_id, **kwargs)¶

Returns a list of desktops within a given desktop pool. You can limit the results to an availability domain, desktop name, or desktop state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Parameters:	compartment_id (str) – (required) The OCID of the compartment of the desktop pool. desktop_pool_id (str) – (required) The OCID of the desktop pool. availability_domain (str) – (optional) The name of the availability domain. display_name (str) – (optional) A filter to return only results with the given displayName. id (str) – (optional) A filter to return only results with the given OCID. lifecycle_state (str) – (optional) A filter to return only results with the given lifecycleState. limit (int) – (optional) The maximum number of results to return. sort_by (str) – (optional) A field to sort by. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) A field to indicate the sort order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. 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 `DesktopPoolDesktopCollection`
Return type:	`Response`
Example:

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

list_desktop_pool_volumes(desktop_pool_id, compartment_id, **kwargs)¶

Returns a list of volumes within the given desktop pool. You can limit the results to an availability domain, volume name, or volume state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. compartment_id (str) – (required) The OCID of the compartment of the desktop pool. availability_domain (str) – (optional) The name of the availability domain. display_name (str) – (optional) A filter to return only results with the given displayName. id (str) – (optional) A filter to return only results with the given OCID. lifecycle_state (str) – (optional) A filter to return only results with the given lifecycleState. limit (int) – (optional) The maximum number of results to return. sort_by (str) – (optional) A field to sort by. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) A field to indicate the sort order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. 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 `DesktopPoolVolumeCollection`
Return type:	`Response`
Example:

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

list_desktop_pools(compartment_id, **kwargs)¶

Returns a list of desktop pools within the given compartment. You can limit the results to an availability domain, pool name, or pool state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Parameters:	compartment_id (str) – (required) The OCID of the compartment of the desktop pool. availability_domain (str) – (optional) The name of the availability domain. display_name (str) – (optional) A filter to return only results with the given displayName. id (str) – (optional) A filter to return only results with the given OCID. lifecycle_state (str) – (optional) A filter to return only results with the given lifecycleState. limit (int) – (optional) The maximum number of results to return. sort_by (str) – (optional) A field to sort by. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) A field to indicate the sort order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. 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 `DesktopPoolCollection`
Return type:	`Response`
Example:

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

list_desktops(compartment_id, **kwargs)¶

Returns a list of desktops filtered by the specified parameters. You can limit the results to an availability domain, desktop name, desktop OCID, desktop state, pool OCID, or compartment OCID. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Parameters:	compartment_id (str) – (required) The OCID of the compartment of the desktop pool. availability_domain (str) – (optional) The name of the availability domain. display_name (str) – (optional) A filter to return only results with the given displayName. id (str) – (optional) A filter to return only results with the given OCID. lifecycle_state (str) – (optional) A filter to return only results with the given lifecycleState. limit (int) – (optional) The maximum number of results to return. sort_by (str) – (optional) A field to sort by. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) A field to indicate the sort order. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. desktop_pool_id (str) – (optional) The OCID of the desktop pool. 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 `DesktopCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Return a (paginated) list of errors for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. limit (int) – (optional) The maximum number of results to return. 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” sort_order (str) – (optional) A field to indicate the sort order. 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 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 `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)¶

Return a (paginated) list of logs for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. limit (int) – (optional) The maximum number of results to return. 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” sort_order (str) – (optional) A field to indicate the sort order. 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 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 `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

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

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment of the desktop pool. 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”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” resource_id (str) – (optional) The ID of the resource affected by the work request. opc_request_id (str) – (optional) The unique identifier of the request. page (str) – (optional) For list pagination. limit (int) – (optional) The maximum number of results to return. sort_order (str) – (optional) A field to indicate the sort order. 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 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 `WorkRequestSummaryCollection`
Return type:	`Response`
Example:

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

start_desktop(desktop_id, **kwargs)¶

Starts the desktop with the specified OCID.

Parameters:	desktop_id (str) – (required) The OCID of the desktop. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. opc_retry_token (str) – (optional) A token that uniquely identifies a request. 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 start_desktop API.

start_desktop_pool(desktop_pool_id, **kwargs)¶

Starts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. opc_retry_token (str) – (optional) A token that uniquely identifies a request. 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 start_desktop_pool API.

stop_desktop(desktop_id, **kwargs)¶

Stops the desktop with the specified OCID. Stopping a desktop causes the end-user to lose access to their desktop instance until the desktop is restarted.

Parameters:	desktop_id (str) – (required) The OCID of the desktop. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. opc_retry_token (str) – (optional) A token that uniquely identifies a request. is_soft_stop (bool) – (optional) Force a STOP(power off) of the desktop if set to false 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 stop_desktop API.

stop_desktop_pool(desktop_pool_id, **kwargs)¶

Stops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. opc_retry_token (str) – (optional) A token that uniquely identifies a request. 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 stop_desktop_pool API.

update_desktop(desktop_id, update_desktop_details, **kwargs)¶

Modifies information about the desktop such as the name.

Parameters:	desktop_id (str) – (required) The OCID of the desktop. update_desktop_details (oci.desktops.models.UpdateDesktopDetails) – (required) The details of the update. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. 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_desktop API.

update_desktop_pool(desktop_pool_id, update_desktop_pool_details, **kwargs)¶

Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.

Parameters:	desktop_pool_id (str) – (required) The OCID of the desktop pool. update_desktop_pool_details (oci.desktops.models.UpdateDesktopPoolDetails) – (required) The details of the update. opc_request_id (str) – (optional) The unique identifier of the request. if_match (str) – (optional) For optimistic concurrency control. 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_desktop_pool API.