BlockstorageClient¶

class oci.core.BlockstorageClient(config, **kwargs)¶

Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](/iaas/Content/Network/Concepts/overview.htm), [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](/iaas/Content/Identity/Reference/corepolicyreference.htm) article.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_boot_volume_backup_compartment`(…)	Moves a boot volume backup into a different compartment within the same tenancy.
`change_boot_volume_compartment`(…)	Moves a boot volume into a different compartment within the same tenancy.
`change_volume_backup_compartment`(…)	Moves a volume backup into a different compartment within the same tenancy.
`change_volume_compartment`(volume_id, …)	Moves a volume into a different compartment within the same tenancy.
`change_volume_group_backup_compartment`(…)	Moves a volume group backup into a different compartment within the same tenancy.
`change_volume_group_compartment`(…)	Moves a volume group into a different compartment within the same tenancy.
`copy_boot_volume_backup`(…)	Creates a boot volume backup copy in specified region.
`copy_volume_backup`(volume_backup_id, …)	Creates a volume backup copy in specified region.
`copy_volume_group_backup`(…)	Creates a volume group backup copy in specified region.
`create_boot_volume`(…)	Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.
`create_boot_volume_backup`(…)	Creates a new boot volume backup of the specified boot volume.
`create_volume`(create_volume_details, **kwargs)	Creates a new volume in the specified compartment.
`create_volume_backup`(…)	Creates a new backup of the specified volume.
`create_volume_backup_policy`(…)	Creates a new user defined backup policy.
`create_volume_backup_policy_assignment`(…)	Assigns a volume backup policy to the specified volume.
`create_volume_group`(…)	Creates a new volume group in the specified compartment.
`create_volume_group_backup`(…)	Creates a new backup volume group of the specified volume group.
`delete_boot_volume`(boot_volume_id, **kwargs)	Deletes the specified boot volume.
`delete_boot_volume_backup`(…)	Deletes a boot volume backup.
`delete_boot_volume_kms_key`(boot_volume_id, …)	Removes the specified boot volume’s assigned Vault Service encryption key.
`delete_volume`(volume_id, **kwargs)	Deletes the specified volume.
`delete_volume_backup`(volume_backup_id, **kwargs)	Deletes a volume backup.
`delete_volume_backup_policy`(policy_id, **kwargs)	Deletes a user defined backup policy.
`delete_volume_backup_policy_assignment`(…)	Deletes a volume backup policy assignment.
`delete_volume_group`(volume_group_id, **kwargs)	Deletes the specified volume group.
`delete_volume_group_backup`(…)	Deletes a volume group backup.
`delete_volume_kms_key`(volume_id, **kwargs)	Removes the specified volume’s assigned Vault service encryption key.
`get_block_volume_replica`(…)	Gets information for the specified block volume replica.
`get_boot_volume`(boot_volume_id, **kwargs)	Gets information for the specified boot volume.
`get_boot_volume_backup`(…)	Gets information for the specified boot volume backup.
`get_boot_volume_kms_key`(boot_volume_id, **kwargs)	Gets the Vault service encryption key assigned to the specified boot volume.
`get_boot_volume_replica`(…)	Gets information for the specified boot volume replica.
`get_volume`(volume_id, **kwargs)	Gets information for the specified volume.
`get_volume_backup`(volume_backup_id, **kwargs)	Gets information for the specified volume backup.
`get_volume_backup_policy`(policy_id, **kwargs)	Gets information for the specified volume backup policy.
`get_volume_backup_policy_asset_assignment`(…)	Gets the volume backup policy assignment for the specified volume.
`get_volume_backup_policy_assignment`(…)	Gets information for the specified volume backup policy assignment.
`get_volume_group`(volume_group_id, **kwargs)	Gets information for the specified volume group.
`get_volume_group_backup`(…)	Gets information for the specified volume group backup.
`get_volume_group_replica`(…)	Gets information for the specified volume group replica.
`get_volume_kms_key`(volume_id, **kwargs)	Gets the Vault service encryption key assigned to the specified volume.
`list_block_volume_replicas`(**kwargs)	Lists the block volume replicas in the specified compartment and availability domain.
`list_boot_volume_backups`(compartment_id, …)	Lists the boot volume backups in the specified compartment.
`list_boot_volume_replicas`(**kwargs)	Lists the boot volume replicas in the specified compartment and availability domain.
`list_boot_volumes`(**kwargs)	Lists the boot volumes in the specified compartment and availability domain.
`list_volume_backup_policies`(**kwargs)	Lists all the volume backup policies available in the specified compartment.
`list_volume_backups`(compartment_id, **kwargs)	Lists the volume backups in the specified compartment.
`list_volume_group_backups`(compartment_id, …)	Lists the volume group backups in the specified compartment.
`list_volume_group_replicas`(…)	Lists the volume group replicas in the specified compartment.
`list_volume_groups`(compartment_id, **kwargs)	Lists the volume groups in the specified compartment and availability domain.
`list_volumes`(**kwargs)	Lists the volumes in the specified compartment and availability domain.
`update_boot_volume`(boot_volume_id, …)	Updates the specified boot volume’s display name, defined tags, and free-form tags.
`update_boot_volume_backup`(…)	Updates the display name for the specified boot volume backup.
`update_boot_volume_kms_key`(boot_volume_id, …)	Updates the specified volume with a new Vault service master encryption key.
`update_volume`(volume_id, …)	Updates the specified volume’s display name.
`update_volume_backup`(volume_backup_id, …)	Updates the display name for the specified volume backup.
`update_volume_backup_policy`(policy_id, …)	Updates a user defined backup policy.
`update_volume_group`(volume_group_id, …)	Updates the set of volumes in a volume group along with the display name.
`update_volume_group_backup`(…)	Updates the display name for the specified volume group backup.
`update_volume_kms_key`(volume_id, …)	Updates the specified volume with a new Key Management master encryption key.

__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_boot_volume_backup_compartment(boot_volume_backup_id, change_boot_volume_backup_compartment_details, **kwargs)¶

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

Parameters:	boot_volume_backup_id (str) – (required) The OCID of the boot volume backup. change_boot_volume_backup_compartment_details (oci.core.models.ChangeBootVolumeBackupCompartmentDetails) – (required) Request to change the compartment of given boot volume backup. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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_boot_volume_backup_compartment API.

change_boot_volume_compartment(boot_volume_id, change_boot_volume_compartment_details, **kwargs)¶

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

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. change_boot_volume_compartment_details (oci.core.models.ChangeBootVolumeCompartmentDetails) – (required) Request to change the compartment of given boot volume. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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_boot_volume_compartment API.

change_volume_backup_compartment(volume_backup_id, change_volume_backup_compartment_details, **kwargs)¶

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

Parameters:	volume_backup_id (str) – (required) The OCID of the volume backup. change_volume_backup_compartment_details (oci.core.models.ChangeVolumeBackupCompartmentDetails) – (required) Request to change the compartment of given volume backup. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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_volume_backup_compartment API.

change_volume_compartment(volume_id, change_volume_compartment_details, **kwargs)¶

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

Parameters:	volume_id (str) – (required) The OCID of the volume. change_volume_compartment_details (oci.core.models.ChangeVolumeCompartmentDetails) – (required) Request to change the compartment of given volume. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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_volume_compartment API.

change_volume_group_backup_compartment(volume_group_backup_id, change_volume_group_backup_compartment_details, **kwargs)¶

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

Parameters:	volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. change_volume_group_backup_compartment_details (oci.core.models.ChangeVolumeGroupBackupCompartmentDetails) – (required) Request to change the compartment of given volume group backup. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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_volume_group_backup_compartment API.

change_volume_group_compartment(volume_group_id, change_volume_group_compartment_details, **kwargs)¶

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

Parameters:	volume_group_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group. change_volume_group_compartment_details (oci.core.models.ChangeVolumeGroupCompartmentDetails) – (required) Request to change the compartment of given volume group. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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_volume_group_compartment API.

copy_boot_volume_backup(boot_volume_backup_id, copy_boot_volume_backup_details, **kwargs)¶

Creates a boot volume backup copy in specified region. For general information about volume backups, see Overview of Boot Volume Backups

Parameters:	boot_volume_backup_id (str) – (required) The OCID of the boot volume backup. copy_boot_volume_backup_details (oci.core.models.CopyBootVolumeBackupDetails) – (required) Request to create a cross-region copy of given boot volume backup. 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 may be rejected). opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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 `BootVolumeBackup`
Return type:	`Response`
Example:

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

copy_volume_backup(volume_backup_id, copy_volume_backup_details, **kwargs)¶

Creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups

Parameters:	volume_backup_id (str) – (required) The OCID of the volume backup. copy_volume_backup_details (oci.core.models.CopyVolumeBackupDetails) – (required) Request to create a cross-region copy of given backup. 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 may be rejected). opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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 `VolumeBackup`
Return type:	`Response`
Example:

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

copy_volume_group_backup(volume_group_backup_id, copy_volume_group_backup_details, **kwargs)¶

Creates a volume group backup copy in specified region. For general information about volume group backups, see Overview of Block Volume Backups.

Parameters:	volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. copy_volume_group_backup_details (oci.core.models.CopyVolumeGroupBackupDetails) – (required) Request to create a cross-region copy of given volume group backup. 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 may be rejected). opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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 `VolumeGroupBackup`
Return type:	`Response`
Example:

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

create_boot_volume(create_boot_volume_details, **kwargs)¶

Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes. You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:	create_boot_volume_details (oci.core.models.CreateBootVolumeDetails) – (required) Request to create a new boot volume. 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 may 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 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`. 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 `BootVolume`
Return type:	`Response`
Example:

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

create_boot_volume_backup(create_boot_volume_backup_details, **kwargs)¶

Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups

When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Parameters:	create_boot_volume_backup_details (oci.core.models.CreateBootVolumeBackupDetails) – (required) Request to create a new backup of given boot volume. 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 may 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 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`. 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 `BootVolumeBackup`
Return type:	`Response`
Example:

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

create_volume(create_volume_details, **kwargs)¶

Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service.

A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:	create_volume_details (oci.core.models.CreateVolumeDetails) – (required) Request to create a new volume. 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 may 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 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`. 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 `Volume`
Return type:	`Response`
Example:

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

create_volume_backup(create_volume_backup_details, **kwargs)¶

Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups

When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Parameters:	create_volume_backup_details (oci.core.models.CreateVolumeBackupDetails) – (required) Request to create a new backup of given volume. 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 may 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 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`. 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 `VolumeBackup`
Return type:	`Response`
Example:

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

create_volume_backup_policy(create_volume_backup_policy_details, **kwargs)¶

Creates a new user defined backup policy.

For more information about Oracle defined backup policies and user defined backup policies, see Policy-Based Backups.

Parameters:	create_volume_backup_policy_details (oci.core.models.CreateVolumeBackupPolicyDetails) – (required) Request to create a new scheduled backup policy. 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 may be rejected). opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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`. 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 `VolumeBackupPolicy`
Return type:	`Response`
Example:

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

create_volume_backup_policy_assignment(create_volume_backup_policy_assignment_details, **kwargs)¶

Assigns a volume backup policy to the specified volume. Note that a given volume can only have one backup policy assigned to it. If this operation is used for a volume that already has a different backup policy assigned, the prior backup policy will be silently unassigned.

Parameters:	create_volume_backup_policy_assignment_details (oci.core.models.CreateVolumeBackupPolicyAssignmentDetails) – (required) Request to assign a specified policy to a particular volume. 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`. 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 `VolumeBackupPolicyAssignment`
Return type:	`Response`
Example:

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

create_volume_group(create_volume_group_details, **kwargs)¶

Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

For more information, see Volume Groups.

Parameters:	create_volume_group_details (oci.core.models.CreateVolumeGroupDetails) – (required) Request to create a new volume group. 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 may 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 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`. 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 `VolumeGroup`
Return type:	`Response`
Example:

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

create_volume_group_backup(create_volume_group_backup_details, **kwargs)¶

Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.

Parameters:	create_volume_group_backup_details (oci.core.models.CreateVolumeGroupBackupDetails) – (required) Request to create a new backup group of given volume group. 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 may 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 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`. 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 `VolumeGroupBackup`
Return type:	`Response`
Example:

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

delete_boot_volume(boot_volume_id, **kwargs)¶

Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see Disconnecting From a Boot Volume. Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. 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. 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`. 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_boot_volume API.

delete_boot_volume_backup(boot_volume_backup_id, **kwargs)¶

Deletes a boot volume backup.

Parameters:	boot_volume_backup_id (str) – (required) The OCID of the boot volume backup. 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. 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`. 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_boot_volume_backup API.

delete_boot_volume_kms_key(boot_volume_id, **kwargs)¶

Removes the specified boot volume’s assigned Vault Service encryption key.

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. 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. 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`. 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_boot_volume_kms_key API.

delete_volume(volume_id, **kwargs)¶

Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see Disconnecting From a Volume. Warning: All data on the volume will be permanently lost when the volume is deleted.

Parameters:	volume_id (str) – (required) The OCID of the volume. 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. 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`. 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_volume API.

delete_volume_backup(volume_backup_id, **kwargs)¶

Deletes a volume backup.

Parameters:	volume_backup_id (str) – (required) The OCID of the volume backup. 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. 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`. 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_volume_backup API.

delete_volume_backup_policy(policy_id, **kwargs)¶

Deletes a user defined backup policy.

For more information about user defined backup policies, see Policy-Based Backups.

Avoid entering confidential information.

Parameters:	policy_id (str) – (required) The OCID of the volume backup policy. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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. 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`. 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_volume_backup_policy API.

delete_volume_backup_policy_assignment(policy_assignment_id, **kwargs)¶

Deletes a volume backup policy assignment.

Parameters:	policy_assignment_id (str) – (required) The OCID of the volume backup policy assignment. 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. 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`. 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_volume_backup_policy_assignment API.

delete_volume_group(volume_group_id, **kwargs)¶

Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.

Parameters:	volume_group_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group. 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. 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`. 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_volume_group API.

delete_volume_group_backup(volume_group_backup_id, **kwargs)¶

Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see Volume Groups.

Parameters:	volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. 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. 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`. 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_volume_group_backup API.

delete_volume_kms_key(volume_id, **kwargs)¶

Removes the specified volume’s assigned Vault service encryption key.

Parameters:	volume_id (str) – (required) The OCID of the volume. 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. 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`. 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_volume_kms_key API.

get_block_volume_replica(block_volume_replica_id, **kwargs)¶

Gets information for the specified block volume replica.

Parameters:	block_volume_replica_id (str) – (required) The OCID of the block volume replica. 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`. 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 `BlockVolumeReplica`
Return type:	`Response`
Example:

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

get_boot_volume(boot_volume_id, **kwargs)¶

Gets information for the specified boot volume.

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. 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`. 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 `BootVolume`
Return type:	`Response`
Example:

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

get_boot_volume_backup(boot_volume_backup_id, **kwargs)¶

Gets information for the specified boot volume backup.

Parameters:	boot_volume_backup_id (str) – (required) The OCID of the boot volume backup. 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`. 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 `BootVolumeBackup`
Return type:	`Response`
Example:

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

get_boot_volume_kms_key(boot_volume_id, **kwargs)¶

Gets the Vault service encryption key assigned to the specified boot volume.

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. 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. 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`. 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 `BootVolumeKmsKey`
Return type:	`Response`
Example:

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

get_boot_volume_replica(boot_volume_replica_id, **kwargs)¶

Gets information for the specified boot volume replica.

Parameters:	boot_volume_replica_id (str) – (required) The OCID of the boot volume replica. 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`. 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 `BootVolumeReplica`
Return type:	`Response`
Example:

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

get_volume(volume_id, **kwargs)¶

Gets information for the specified volume.

Parameters:	volume_id (str) – (required) The OCID of the volume. 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`. 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 `Volume`
Return type:	`Response`
Example:

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

get_volume_backup(volume_backup_id, **kwargs)¶

Gets information for the specified volume backup.

Parameters:	volume_backup_id (str) – (required) The OCID of the volume backup. 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`. 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 `VolumeBackup`
Return type:	`Response`
Example:

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

get_volume_backup_policy(policy_id, **kwargs)¶

Gets information for the specified volume backup policy.

Parameters:	policy_id (str) – (required) The OCID of the volume backup policy. 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`. 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 `VolumeBackupPolicy`
Return type:	`Response`
Example:

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

get_volume_backup_policy_asset_assignment(asset_id, **kwargs)¶

Gets the volume backup policy assignment for the specified volume. The assetId query parameter is required, and the returned list will contain at most one item, since volume can only have one volume backup policy assigned at a time.

Parameters:	asset_id (str) – (required) The OCID of an asset (e.g. a volume). limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see 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 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`. 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 list of `VolumeBackupPolicyAssignment`
Return type:	`Response`
Example:

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

get_volume_backup_policy_assignment(policy_assignment_id, **kwargs)¶

Gets information for the specified volume backup policy assignment.

Parameters:	policy_assignment_id (str) – (required) The OCID of the volume backup policy assignment. 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`. 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 `VolumeBackupPolicyAssignment`
Return type:	`Response`
Example:

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

get_volume_group(volume_group_id, **kwargs)¶

Gets information for the specified volume group. For more information, see Volume Groups.

Parameters:	volume_group_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group. 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`. 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 `VolumeGroup`
Return type:	`Response`
Example:

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

get_volume_group_backup(volume_group_backup_id, **kwargs)¶

Gets information for the specified volume group backup. For more information, see Volume Groups.

Parameters:	volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. 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`. 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 `VolumeGroupBackup`
Return type:	`Response`
Example:

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

get_volume_group_replica(volume_group_replica_id, **kwargs)¶

Gets information for the specified volume group replica.

Parameters:	volume_group_replica_id (str) – (required) The OCID of the volume replica group. 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`. 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 `VolumeGroupReplica`
Return type:	`Response`
Example:

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

get_volume_kms_key(volume_id, **kwargs)¶

Gets the Vault service encryption key assigned to the specified volume.

Parameters:	volume_id (str) – (required) The OCID of the volume. 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. 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`. 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 `VolumeKmsKey`
Return type:	`Response`
Example:

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

list_block_volume_replicas(**kwargs)¶

Lists the block volume replicas in the specified compartment and availability domain.

Parameters:	availability_domain (str) – (optional) The name of the availability domain. Example: Uocm:PHX-AD-1 compartment_id (str) – (optional) The OCID of the compartment. volume_group_replica_id (str) – (optional) The OCID of the volume group replica. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “PROVISIONING”, “AVAILABLE”, “ACTIVATING”, “TERMINATING”, “TERMINATED”, “FAULTY” 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`. 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 list of `BlockVolumeReplica`
Return type:	`Response`
Example:

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

list_boot_volume_backups(compartment_id, **kwargs)¶

Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. boot_volume_id (str) – (optional) The OCID of the boot volume. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. source_boot_volume_backup_id (str) – (optional) A filter to return only resources that originated from the given source boot volume backup. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “REQUEST_RECEIVED” 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`. 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 list of `BootVolumeBackup`
Return type:	`Response`
Example:

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

list_boot_volume_replicas(**kwargs)¶

Lists the boot volume replicas in the specified compartment and availability domain.

Parameters:	availability_domain (str) – (optional) The name of the availability domain. Example: Uocm:PHX-AD-1 compartment_id (str) – (optional) The OCID of the compartment. volume_group_replica_id (str) – (optional) The OCID of the volume group replica. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “PROVISIONING”, “AVAILABLE”, “ACTIVATING”, “TERMINATING”, “TERMINATED”, “FAULTY” 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`. 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 list of `BootVolumeReplica`
Return type:	`Response`
Example:

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

list_boot_volumes(**kwargs)¶

Lists the boot volumes in the specified compartment and availability domain.

Parameters:	availability_domain (str) – (optional) The name of the availability domain. Example: Uocm:PHX-AD-1 compartment_id (str) – (optional) The OCID of the compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. volume_group_id (str) – (optional) The OCID of the volume group. 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`. 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 list of `BootVolume`
Return type:	`Response`
Example:

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

list_volume_backup_policies(**kwargs)¶

Lists all the volume backup policies available in the specified compartment.

For more information about Oracle defined backup policies and user defined backup policies, see Policy-Based Backups.

Parameters:	limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. compartment_id (str) – (optional) The OCID of the compartment. If no compartment is specified, the Oracle defined backup policies are listed. 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`. 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 list of `VolumeBackupPolicy`
Return type:	`Response`
Example:

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

list_volume_backups(compartment_id, **kwargs)¶

Lists the volume backups in the specified compartment. You can filter the results by volume.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. volume_id (str) – (optional) The OCID of the volume. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. source_volume_backup_id (str) – (optional) A filter to return only resources that originated from the given source volume backup. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “REQUEST_RECEIVED” 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`. 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 list of `VolumeBackup`
Return type:	`Response`
Example:

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

list_volume_group_backups(compartment_id, **kwargs)¶

Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see Volume Groups.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. volume_group_id (str) – (optional) The OCID of the volume group. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. 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 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`. 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 list of `VolumeGroupBackup`
Return type:	`Response`
Example:

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

list_volume_group_replicas(availability_domain, compartment_id, **kwargs)¶

Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see Volume Group Replication.

Parameters:	availability_domain (str) – (required) The name of the availability domain. Example: Uocm:PHX-AD-1 compartment_id (str) – (required) The OCID of the compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “PROVISIONING”, “AVAILABLE”, “ACTIVATING”, “TERMINATING”, “TERMINATED”, “FAULTY” 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`. 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 list of `VolumeGroupReplica`
Return type:	`Response`
Example:

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

list_volume_groups(compartment_id, **kwargs)¶

Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. availability_domain (str) – (optional) The name of the availability domain. Example: Uocm:PHX-AD-1 limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY”, “UPDATE_PENDING” 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`. 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 list of `VolumeGroup`
Return type:	`Response`
Example:

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

list_volumes(**kwargs)¶

Lists the volumes in the specified compartment and availability domain.

Parameters:	availability_domain (str) – (optional) The name of the availability domain. Example: Uocm:PHX-AD-1 compartment_id (str) – (optional) The OCID of the compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. sort_by (str) – (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: “TIMECREATED”, “DISPLAYNAME” sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. Allowed values are: “ASC”, “DESC” volume_group_id (str) – (optional) The OCID of the volume group. cluster_placement_group_id (str) – (optional) A filter to return only resources that match the given cluster placement group Id exactly. lifecycle_state (str) – (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “PROVISIONING”, “RESTORING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “FAULTY” 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`. 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 list of `Volume`
Return type:	`Response`
Example:

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

update_boot_volume(boot_volume_id, update_boot_volume_details, **kwargs)¶

Updates the specified boot volume’s display name, defined tags, and free-form tags.

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. update_boot_volume_details (oci.core.models.UpdateBootVolumeDetails) – (required) Update boot volume’s display name. 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. 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`. 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 `BootVolume`
Return type:	`Response`
Example:

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

update_boot_volume_backup(boot_volume_backup_id, update_boot_volume_backup_details, **kwargs)¶

Updates the display name for the specified boot volume backup. Avoid entering confidential information.

Parameters:	boot_volume_backup_id (str) – (required) The OCID of the boot volume backup. update_boot_volume_backup_details (oci.core.models.UpdateBootVolumeBackupDetails) – (required) Update boot volume backup fields 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. 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`. 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 `BootVolumeBackup`
Return type:	`Response`
Example:

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

update_boot_volume_kms_key(boot_volume_id, update_boot_volume_kms_key_details, **kwargs)¶

Updates the specified volume with a new Vault service master encryption key.

Parameters:	boot_volume_id (str) – (required) The OCID of the boot volume. update_boot_volume_kms_key_details (oci.core.models.UpdateBootVolumeKmsKeyDetails) – (required) Updates the Vault service master encryption key assigned to the specified boot volume. 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. 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`. 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 `BootVolumeKmsKey`
Return type:	`Response`
Example:

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

update_volume(volume_id, update_volume_details, **kwargs)¶

Updates the specified volume’s display name. Avoid entering confidential information.

Parameters:	volume_id (str) – (required) The OCID of the volume. update_volume_details (oci.core.models.UpdateVolumeDetails) – (required) Update volume’s display name. Avoid entering confidential information. 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. 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`. 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 `Volume`
Return type:	`Response`
Example:

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

update_volume_backup(volume_backup_id, update_volume_backup_details, **kwargs)¶

Updates the display name for the specified volume backup. Avoid entering confidential information.

Parameters:	volume_backup_id (str) – (required) The OCID of the volume backup. update_volume_backup_details (oci.core.models.UpdateVolumeBackupDetails) – (required) Update volume backup fields 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. 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`. 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 `VolumeBackup`
Return type:	`Response`
Example:

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

update_volume_backup_policy(policy_id, update_volume_backup_policy_details, **kwargs)¶

Updates a user defined backup policy.

For more information about user defined backup policies, see Policy-Based Backups.

Avoid entering confidential information.

Parameters:	policy_id (str) – (required) The OCID of the volume backup policy. update_volume_backup_policy_details (oci.core.models.UpdateVolumeBackupPolicyDetails) – (required) Update volume backup policy fields 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) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 may 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 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`. 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 `VolumeBackupPolicy`
Return type:	`Response`
Example:

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

update_volume_group(volume_group_id, update_volume_group_details, **kwargs)¶

Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information.

For more information, see Volume Groups.

Parameters:	volume_group_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group. update_volume_group_details (oci.core.models.UpdateVolumeGroupDetails) – (required) Update volume group’s set of volumes and/or display name 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. preserve_volume_replica (bool) – (optional) Specifies whether to disable or preserve the individual volume replication when removing a volume from the replication enabled volume group. When set to true, the individual volume replica is preserved. The default value is true. 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`. 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 `VolumeGroup`
Return type:	`Response`
Example:

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

update_volume_group_backup(volume_group_backup_id, update_volume_group_backup_details, **kwargs)¶

Updates the display name for the specified volume group backup. For more information, see Volume Groups.

Parameters:	volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup. update_volume_group_backup_details (oci.core.models.UpdateVolumeGroupBackupDetails) – (required) Update volume group backup fields 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. 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`. 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 `VolumeGroupBackup`
Return type:	`Response`
Example:

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

update_volume_kms_key(volume_id, update_volume_kms_key_details, **kwargs)¶

Updates the specified volume with a new Key Management master encryption key.

Parameters:	volume_id (str) – (required) The OCID of the volume. update_volume_kms_key_details (oci.core.models.UpdateVolumeKmsKeyDetails) – (required) Updates the Vault service master encryption key assigned to the specified volume. 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. 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`. 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 `VolumeKmsKey`
Return type:	`Response`
Example:

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