MigrationClient¶

class oci.cloud_migrations.MigrationClient(config, **kwargs)¶

A description of the Oracle Cloud Migrations API.

Methods:

`__init__`(config, **kwargs)	Creates a new service client
`cancel_work_request`(work_request_id, **kwargs)	Cancels work request with the given ID.
`change_migration_compartment`(migration_id, ...)	Moves a migration resource from one compartment identifier to another.
`change_migration_plan_compartment`(...)	Moves a resource into a different compartment.
`change_replication_schedule_compartment`(...)	Moves a resource into a different compartment.
`create_migration`(create_migration_details, ...)	Creates a migration.
`create_migration_asset`(...)	Creates a migration asset.
`create_migration_plan`(...)	Creates a migration plan.
`create_replication_schedule`(...)	Creates a replication schedule.
`create_target_asset`(...)	Creates a target asset.
`delete_migration`(migration_id, **kwargs)	Deletes a migration resource by identifier.
`delete_migration_asset`(migration_asset_id, ...)	Deletes a migration asset resource by an identifier.
`delete_migration_plan`(migration_plan_id, ...)	Deletes a migration plan resource by an identifier.
`delete_replication_schedule`(...)	Deletes a replication schedule resource by identifier.
`delete_target_asset`(target_asset_id, **kwargs)	Deletes a target asset resource by identifier.
`execute_migration_plan`(migration_plan_id, ...)	Executes the migration plan with the migration plan ID.
`export_migration_plan`(migration_plan_id, ...)	Exports the migration plan to a csv file.
`get_migration`(migration_id, **kwargs)	Gets a migration by identifier.
`get_migration_asset`(migration_asset_id, **kwargs)	Gets a migration asset by identifier.
`get_migration_plan`(migration_plan_id, **kwargs)	Gets a migration plan by identifier.
`get_replication_progress`(migration_asset_id, ...)	Gets the progress percentage of a migration asset's replication process.
`get_replication_schedule`(...)	Gets a replication schedule by identifier.
`get_target_asset`(target_asset_id, **kwargs)	Gets a target asset by identifier.
`get_work_request`(work_request_id, **kwargs)	Gets the status of the work request with the given ID.
`import_migration_plan`(migration_plan_id, ...)	Imports a migration plan from a csv file.
`list_available_shapes`(migration_plan_id, ...)	List of shapes by parameters.
`list_migration_assets`(**kwargs)	Returns a list of migration assets.
`list_migration_plans`(**kwargs)	Returns a list of migration plans.
`list_migrations`(**kwargs)	Returns a list of migrations.
`list_replication_schedules`(**kwargs)	Returns a list of replication schedules.
`list_target_assets`(**kwargs)	Returns a list of target assets.
`list_work_request_errors`(work_request_id, ...)	Returns a paginated list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a paginated list of logs for a given work request.
`list_work_requests`(**kwargs)	List of work requests in a compartment.
`refresh_migration`(migration_id, **kwargs)	Refreshes migration based on the migration ID.
`refresh_migration_asset`(migration_asset_id, ...)	Refreshes the migration asset with the migration asset ID.
`refresh_migration_plan`(migration_plan_id, ...)	Refreshes the migration plan with the migration plan ID.
`start_asset_replication`(migration_asset_id, ...)	Starts replication for the asset with the migration asset ID.
`start_migration_replication`(migration_id, ...)	Starts replication for a migration or for some asset.
`update_migration`(migration_id, ...)	Updates the migration.
`update_migration_asset`(migration_asset_id, ...)	Updates the migration asset.
`update_migration_plan`(migration_plan_id, ...)	Updates the migration plan.
`update_replication_schedule`(...)	Updates the replication schedule.
`update_target_asset`(target_asset_id, ...)	Updates the target asset.

__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.
enable_strict_url_encoding – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this client should enable strict url encoding in path params of a request. By default, the client will not enable strict url encoding

cancel_work_request(work_request_id, **kwargs)¶

Cancels work request with the given ID.

Parameters

work_request_id (str) – (required) The ID of the asynchronous request.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_migration_compartment(migration_id, change_migration_compartment_details, **kwargs)¶

Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters

migration_id (str) – (required) Unique migration identifier
change_migration_compartment_details (oci.cloud_migrations.models.ChangeMigrationCompartmentDetails) – (required) The information to be updated.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_migration_plan_compartment(migration_plan_id, change_migration_plan_compartment_details, **kwargs)¶

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
change_migration_plan_compartment_details (oci.cloud_migrations.models.ChangeMigrationPlanCompartmentDetails) – (required) Details for the compartment move.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_replication_schedule_compartment(replication_schedule_id, change_replication_schedule_compartment_details, **kwargs)¶

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters

replication_schedule_id (str) – (required) Unique replication schedule identifier in path
change_replication_schedule_compartment_details (oci.cloud_migrations.models.ChangeReplicationScheduleCompartmentDetails) – (required) Details for the compartment move.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

create_migration(create_migration_details, **kwargs)¶

Creates a migration.

Parameters

create_migration_details (oci.cloud_migrations.models.CreateMigrationDetails) – (required) Details for the new migration.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Migration

Return type

Response

Example

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

create_migration_asset(create_migration_asset_details, **kwargs)¶

Creates a migration asset.

Parameters

create_migration_asset_details (oci.cloud_migrations.models.CreateMigrationAssetDetails) – (required) Details for the new migration asset.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationAsset

Return type

Response

Example

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

create_migration_plan(create_migration_plan_details, **kwargs)¶

Creates a migration plan.

Parameters

create_migration_plan_details (oci.cloud_migrations.models.CreateMigrationPlanDetails) – (required) Details for the new migration plan.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationPlan

Return type

Response

Example

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

create_replication_schedule(create_replication_schedule_details, **kwargs)¶

Creates a replication schedule.

Parameters

create_replication_schedule_details (oci.cloud_migrations.models.CreateReplicationScheduleDetails) – (required) Details for the new replication schedule.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ReplicationSchedule

Return type

Response

Example

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

create_target_asset(create_target_asset_details, **kwargs)¶

Creates a target asset.

Parameters

create_target_asset_details (oci.cloud_migrations.models.CreateTargetAssetDetails) – (required) Details for the new target asset.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type TargetAsset

Return type

Response

Example

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

delete_migration(migration_id, **kwargs)¶

Deletes a migration resource by identifier.

Parameters

migration_id (str) – (required) Unique migration identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_migration_asset(migration_asset_id, **kwargs)¶

Deletes a migration asset resource by an identifier.

Parameters

migration_asset_id (str) – (required) Unique migration asset identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_migration_plan(migration_plan_id, **kwargs)¶

Deletes a migration plan resource by an identifier.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_replication_schedule(replication_schedule_id, **kwargs)¶

Deletes a replication schedule resource by identifier.

Parameters

replication_schedule_id (str) – (required) Unique replication schedule identifier in path
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_target_asset(target_asset_id, **kwargs)¶

Deletes a target asset resource by identifier.

Parameters

target_asset_id (str) – (required) Unique target asset identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

execute_migration_plan(migration_plan_id, **kwargs)¶

Executes the migration plan with the migration plan ID.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

export_migration_plan(migration_plan_id, **kwargs)¶

Exports the migration plan to a csv file.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type stream

Return type

Response

Example

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

get_migration(migration_id, **kwargs)¶

Gets a migration by identifier.

Parameters

migration_id (str) – (required) Unique migration identifier
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Migration

Return type

Response

Example

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

get_migration_asset(migration_asset_id, **kwargs)¶

Gets a migration asset by identifier.

Parameters

migration_asset_id (str) – (required) Unique migration asset identifier
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationAsset

Return type

Response

Example

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

get_migration_plan(migration_plan_id, **kwargs)¶

Gets a migration plan by identifier.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationPlan

Return type

Response

Example

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

get_replication_progress(migration_asset_id, **kwargs)¶

Gets the progress percentage of a migration asset’s replication process.

Parameters

migration_asset_id (str) – (required) Unique migration asset identifier
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ReplicationProgress

Return type

Response

Example

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

get_replication_schedule(replication_schedule_id, **kwargs)¶

Gets a replication schedule by identifier.

Parameters

replication_schedule_id (str) – (required) Unique replication schedule identifier in path
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ReplicationSchedule

Return type

Response

Example

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

get_target_asset(target_asset_id, **kwargs)¶

Gets a target asset by identifier.

Parameters

target_asset_id (str) – (required) Unique target asset identifier
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type TargetAsset

Return type

Response

Example

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

get_work_request(work_request_id, **kwargs)¶

Gets the status of the work request with the given ID.

Parameters

work_request_id (str) – (required) The ID of the asynchronous request.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequest

Return type

Response

Example

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

import_migration_plan(migration_plan_id, import_migration_plan_details, **kwargs)¶

Imports a migration plan from a csv file.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
import_migration_plan_details (stream) – (required) The csv file to be uploaded.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled
buffer_limit (int) –
(optional) A buffer limit for the stream to be buffered. buffer_limit is used to set the buffer size capacity. Streams will be read until the size of the buffer reaches the buffer_limit. If the stream size is greater than the buffer_limit, a BufferError exception will be thrown.

The buffer_limit parameter is used when the stream object does not have a seek, tell, or fileno property for the Python Request library to calculate out the content length. If buffer_limit is not passed, then the buffer_limit will be defaulted to 100MB. Large streams can cause the process to freeze, consider passing in content-length for large streams instead.

Returns

A Response object with data of type None

Return type

Response

Example

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

list_available_shapes(migration_plan_id, **kwargs)¶

List of shapes by parameters.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
compartment_id (str) – (optional) The ID of the compartment in which to list resources.
dvh_host_id (str) – (optional) The ID of the Dvh in which to list resources.
availability_domain (str) – (optional) The availability domain in which to list resources.
reserved_capacity_id (str) – (optional) The reserved capacity ID for which to list resources.
opc_request_id (str) – (optional) The client request ID for tracing.
limit (int) – (optional) The maximum number of items to return.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Allowed values are: “timeCreated”, “displayName”
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type AvailableShapesCollection

Return type

Response

Example

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

list_migration_assets(**kwargs)¶

Returns a list of migration assets.

Parameters

migration_id (str) – (optional) Unique migration identifier
display_name (str) – (optional) A filter to return only resources that match the entire given display name.
migration_asset_id (str) – (optional) Unique migration asset identifier
limit (int) – (optional) The maximum number of items to return.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
lifecycle_state (str) –
(optional) The current state of the migration asset.

Allowed values are: “CREATING”, “UPDATING”, “NEEDS_ATTENTION”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Allowed values are: “timeCreated”, “displayName”
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationAssetCollection

Return type

Response

Example

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

list_migration_plans(**kwargs)¶

Returns a list of migration plans.

Parameters

compartment_id (str) – (optional) The ID of the compartment in which to list resources.
migration_id (str) – (optional) Unique migration identifier
display_name (str) – (optional) A filter to return only resources that match the entire given display name.
migration_plan_id (str) – (optional) Unique migration plan identifier
limit (int) – (optional) The maximum number of items to return.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
lifecycle_state (str) –
(optional) The current state of the migration plan.

Allowed values are: “CREATING”, “UPDATING”, “NEEDS_ATTENTION”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Allowed values are: “timeCreated”, “displayName”
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationPlanCollection

Return type

Response

Example

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

list_migrations(**kwargs)¶

Returns a list of migrations.

Parameters

compartment_id (str) – (optional) The ID of the compartment in which to list resources.
lifecycle_state (str) –
(optional) A filter to return only resources where the resource’s lifecycle state matches the given lifecycle state.

Allowed values are: “CREATING”, “UPDATING”, “NEEDS_ATTENTION”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
display_name (str) – (optional) A filter to return only resources that match the entire given display name.
migration_id (str) – (optional) Unique migration identifier
limit (int) – (optional) The maximum number of items to return.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Allowed values are: “timeCreated”, “displayName”
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationCollection

Return type

Response

Example

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

list_replication_schedules(**kwargs)¶

Returns a list of replication schedules.

Parameters

compartment_id (str) – (optional) The ID of the compartment in which to list resources.
lifecycle_state (str) –
(optional) The current state of the replication schedule.

Allowed values are: “CREATING”, “UPDATING”, “NEEDS_ATTENTION”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
display_name (str) – (optional) A filter to return only resources that match the entire given display name.
replication_schedule_id (str) – (optional) Unique replication schedule identifier in query
limit (int) – (optional) The maximum number of items to return.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Allowed values are: “timeCreated”, “displayName”
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ReplicationScheduleCollection

Return type

Response

Example

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

list_target_assets(**kwargs)¶

Returns a list of target assets.

Parameters

migration_plan_id (str) – (optional) Unique migration plan identifier
display_name (str) – (optional) A filter to return only resources that match the entire given display name.
target_asset_id (str) – (optional) Unique target asset identifier
limit (int) – (optional) The maximum number of items to return.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
lifecycle_state (str) –
(optional) The current state of the target asset.

Allowed values are: “CREATING”, “UPDATING”, “NEEDS_ATTENTION”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. The default order for ‘timeCreated’ is descending. The default order for ‘displayName’ is ascending.

Allowed values are: “timeCreated”, “displayName”
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type TargetAssetCollection

Return type

Response

Example

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

list_work_request_errors(work_request_id, **kwargs)¶

Returns a paginated list of errors for a given work request.

Parameters

work_request_id (str) – (required) The ID of the asynchronous request.
opc_request_id (str) – (optional) The client request ID for tracing.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
limit (int) – (optional) The maximum number of items to return.
sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. The default order for ‘timeAccepted’ is descending.

Allowed values are: “timeAccepted”
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequestErrorCollection

Return type

Response

Example

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

list_work_request_logs(work_request_id, **kwargs)¶

Returns a paginated list of logs for a given work request.

Parameters

work_request_id (str) – (required) The ID of the asynchronous request.
opc_request_id (str) – (optional) The client request ID for tracing.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
limit (int) – (optional) The maximum number of items to return.
sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. The default order for ‘timeAccepted’ is descending.

Allowed values are: “timeAccepted”
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequestLogEntryCollection

Return type

Response

Example

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

list_work_requests(**kwargs)¶

List of work requests in a compartment.

Parameters

compartment_id (str) – (optional) The ID of the compartment in which to list resources.
work_request_id (str) – (optional) The ID of the asynchronous work request.
status (str) –
(optional) A filter to return only resources where the resource’s lifecycle state matches the given operation status.

Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “NEEDS_ATTENTION”
operation_type (str) –
(optional) A filter to return only resources where the resource’s lifecycle state matches the given operation type.

Allowed values are: “CREATE_MIGRATION”, “UPDATE_MIGRATION”, “REFRESH_MIGRATION”, “DELETE_MIGRATION”, “MOVE_MIGRATION”, “START_ASSET_REPLICATION”, “START_MIGRATION_REPLICATION”, “CREATE_REPLICATION_SCHEDULE”, “UPDATE_REPLICATION_SCHEDULE”, “DELETE_REPLICATION_SCHEDULE”, “MOVE_REPLICATION_SCHEDULE”, “CREATE_MIGRATION_PLAN”, “UPDATE_MIGRATION_PLAN”, “DELETE_MIGRATION_PLAN”, “MOVE_MIGRATION_PLAN”, “REFRESH_MIGRATION_PLAN”, “EXECUTE_MIGRATION_PLAN”, “REFRESH_MIGRATION_ASSET”, “CREATE_MIGRATION_ASSET”, “DELETE_MIGRATION_ASSET”, “CREATE_TARGET_ASSET”, “UPDATE_TARGET_ASSET”, “DELETE_TARGET_ASSET”, “PREPARE_TARGET_ASSET”
resource_id (str) – (optional) The ID of the resource affected by the work request.
opc_request_id (str) – (optional) The client request ID for tracing.
page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of the previous response.
limit (int) – (optional) The maximum number of items to return.
sort_order (str) –
(optional) The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values are: “ASC”, “DESC”
sort_by (str) –
(optional) The field to sort by. Only one sort order may be provided. The default order for ‘timeAccepted’ is descending.

Allowed values are: “timeAccepted”
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequestSummaryCollection

Return type

Response

Example

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

refresh_migration(migration_id, **kwargs)¶

Refreshes migration based on the migration ID.

Parameters

migration_id (str) – (required) Unique migration identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

refresh_migration_asset(migration_asset_id, **kwargs)¶

Refreshes the migration asset with the migration asset ID.

Parameters

migration_asset_id (str) – (required) Unique migration asset identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

refresh_migration_plan(migration_plan_id, **kwargs)¶

Refreshes the migration plan with the migration plan ID.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

start_asset_replication(migration_asset_id, **kwargs)¶

Starts replication for the asset with the migration asset ID.

Parameters

migration_asset_id (str) – (required) Unique migration asset identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

start_migration_replication(migration_id, **kwargs)¶

Starts replication for a migration or for some asset.

Parameters

migration_id (str) – (required) Unique migration identifier
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

update_migration(migration_id, update_migration_details, **kwargs)¶

Updates the migration.

Parameters

migration_id (str) – (required) Unique migration identifier
update_migration_details (oci.cloud_migrations.models.UpdateMigrationDetails) – (required) The information to be updated.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Migration

Return type

Response

Example

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

update_migration_asset(migration_asset_id, update_migration_asset_details, **kwargs)¶

Updates the migration asset.

Parameters

migration_asset_id (str) – (required) Unique migration asset identifier
update_migration_asset_details (oci.cloud_migrations.models.UpdateMigrationAssetDetails) – (required) The information to be updated.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type MigrationAsset

Return type

Response

Example

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

update_migration_plan(migration_plan_id, update_migration_plan_details, **kwargs)¶

Updates the migration plan.

Parameters

migration_plan_id (str) – (required) Unique migration plan identifier
update_migration_plan_details (oci.cloud_migrations.models.UpdateMigrationPlanDetails) – (required) The information to be updated.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

update_replication_schedule(replication_schedule_id, update_replication_schedule_details, **kwargs)¶

Updates the replication schedule.

Parameters

replication_schedule_id (str) – (required) Unique replication schedule identifier in path
update_replication_schedule_details (oci.cloud_migrations.models.UpdateReplicationScheduleDetails) – (required) The information to be updated.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

update_target_asset(target_asset_id, update_target_asset_details, **kwargs)¶

Updates the target asset.

Parameters

target_asset_id (str) – (required) Unique target asset identifier
update_target_asset_details (oci.cloud_migrations.models.UpdateTargetAssetDetails) – (required) The information to be updated.
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 that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) The client request ID for tracing.
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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