ComputeCloudAtCustomerClient

class oci.compute_cloud_at_customer.ComputeCloudAtCustomerClient(config, **kwargs)

Use the Compute Cloud@Customer API to manage Compute Cloud@Customer infrastructures and upgrade schedules. For more information see [Compute Cloud@Customer documentation](/iaas/compute-cloud-at-customer/home.htm).

Methods

__init__(config, **kwargs) Creates a new service client
change_ccc_infrastructure_compartment(…) Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.
change_ccc_upgrade_schedule_compartment(…) Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified `OCID`__.
create_ccc_infrastructure(…) Creates a Compute Cloud@Customer infrastructure.
create_ccc_upgrade_schedule(…) Creates a new Compute Cloud@Customer upgrade schedule.
delete_ccc_infrastructure(…) Deletes a Compute Cloud@Customer infrastructure resource specified by the resource `OCID`__.
delete_ccc_upgrade_schedule(…) Deletes a Compute Cloud@Customer upgrade schedule by the specified `OCID`__.
get_ccc_infrastructure(…) Gets a Compute Cloud@Customer infrastructure using the infrastructure `OCID`__.
get_ccc_upgrade_schedule(…) Gets a Compute Cloud@Customer upgrade schedule by the specified `OCID`__.
list_ccc_infrastructures(**kwargs) Returns a list of Compute Cloud@Customer infrastructures.
list_ccc_upgrade_schedules(**kwargs) Returns a list of Compute Cloud@Customer upgrade schedules.
update_ccc_infrastructure(…) Updates Compute Cloud@Customer infrastructure resource.
update_ccc_upgrade_schedule(…) Updates the Compute Cloud@Customer upgrade schedule.
__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_ccc_infrastructure_compartment(ccc_infrastructure_id, change_ccc_infrastructure_compartment_details, **kwargs)

Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.

Parameters:
  • ccc_infrastructure_id (str) –

    (required) An `OCID`__ for a Compute Cloud@Customer Infrastructure.

  • change_ccc_infrastructure_compartment_details (oci.compute_cloud_at_customer.models.ChangeCccInfrastructureCompartmentDetails) –

    (required) Details about the compartment change operation including the destination compartment specified by the resource `OCID`__.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

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

change_ccc_upgrade_schedule_compartment(ccc_upgrade_schedule_id, change_ccc_upgrade_schedule_compartment_details, **kwargs)

Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified `OCID`__.

Parameters:
  • ccc_upgrade_schedule_id (str) –

    (required) Compute Cloud@Customer upgrade schedule `OCID`__.

  • change_ccc_upgrade_schedule_compartment_details (oci.compute_cloud_at_customer.models.ChangeCccUpgradeScheduleCompartmentDetails) –

    (required) Details about the compartment change operation including the destination compartment specified by the resource `OCID`__.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None
Return type:

Response
Example:

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

create_ccc_infrastructure(create_ccc_infrastructure_details, **kwargs)

Creates a Compute Cloud@Customer infrastructure. Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure resource.

Parameters:
  • create_ccc_infrastructure_details (oci.compute_cloud_at_customer.models.CreateCccInfrastructureDetails) – (required) Details for the new CccInfrastructure.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CccInfrastructure
Return type:

Response
Example:

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

create_ccc_upgrade_schedule(create_ccc_upgrade_schedule_details, **kwargs)

Creates a new Compute Cloud@Customer upgrade schedule.

Parameters:
  • create_ccc_upgrade_schedule_details (oci.compute_cloud_at_customer.models.CreateCccUpgradeScheduleDetails) – (required) Details for the new CCC Upgrade 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 then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CccUpgradeSchedule
Return type:

Response
Example:

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

delete_ccc_infrastructure(ccc_infrastructure_id, **kwargs)

Deletes a Compute Cloud@Customer infrastructure resource specified by the resource `OCID`__.

Parameters:
  • ccc_infrastructure_id (str) –

    (required) An `OCID`__ for a Compute Cloud@Customer Infrastructure.

  • 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 `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • 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_ccc_infrastructure API.

delete_ccc_upgrade_schedule(ccc_upgrade_schedule_id, **kwargs)

Deletes a Compute Cloud@Customer upgrade schedule by the specified `OCID`__.

Parameters:
  • ccc_upgrade_schedule_id (str) –

    (required) Compute Cloud@Customer upgrade schedule `OCID`__.

  • 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 `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • 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_ccc_upgrade_schedule API.

get_ccc_infrastructure(ccc_infrastructure_id, **kwargs)

Gets a Compute Cloud@Customer infrastructure using the infrastructure `OCID`__.

Parameters:
  • ccc_infrastructure_id (str) –

    (required) An `OCID`__ for a Compute Cloud@Customer Infrastructure.

  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CccInfrastructure
Return type:

Response
Example:

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

get_ccc_upgrade_schedule(ccc_upgrade_schedule_id, **kwargs)

Gets a Compute Cloud@Customer upgrade schedule by the specified `OCID`__.

Parameters:
  • ccc_upgrade_schedule_id (str) –

    (required) Compute Cloud@Customer upgrade schedule `OCID`__.

  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CccUpgradeSchedule
Return type:

Response
Example:

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

list_ccc_infrastructures(**kwargs)

Returns a list of Compute Cloud@Customer infrastructures.

Parameters:
  • compartment_id (str) –

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

  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and sub-compartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
  • access_level (str) –

    (optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • lifecycle_state (str) –

    (optional) A filter used to return only resources that match the given lifecycleState.

    Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • display_name_contains (str) – (optional) A filter to return only resources whose display name contains the substring.
  • ccc_infrastructure_id (str) –

    (optional) An `OCID`__ for a Compute Cloud@Customer Infrastructure.

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CccInfrastructureCollection
Return type:

Response
Example:

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

list_ccc_upgrade_schedules(**kwargs)

Returns a list of Compute Cloud@Customer upgrade schedules.

Parameters:
  • ccc_upgrade_schedule_id (str) –

    (optional) Compute Cloud@Customer upgrade schedule `OCID`__.

  • compartment_id (str) –

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

  • compartment_id_in_subtree (bool) – (optional) Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and sub-compartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
  • access_level (str) –

    (optional) Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

    Allowed values are: “RESTRICTED”, “ACCESSIBLE”

  • lifecycle_state (str) –

    (optional) A filter to return resources only when their lifecycleState matches the given lifecycleState.

    Allowed values are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED”, “FAILED”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • display_name_contains (str) – (optional) A filter to return only resources whose display name contains the substring.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.
  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • opc_request_id (str) –

    (optional) The client request `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

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

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type CccUpgradeScheduleCollection
Return type:

Response
Example:

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

update_ccc_infrastructure(ccc_infrastructure_id, update_ccc_infrastructure_details, **kwargs)

Updates Compute Cloud@Customer infrastructure resource.

Parameters:
  • ccc_infrastructure_id (str) –

    (required) An `OCID`__ for a Compute Cloud@Customer Infrastructure.

  • update_ccc_infrastructure_details (oci.compute_cloud_at_customer.models.UpdateCccInfrastructureDetails) – (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 `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • 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 CccInfrastructure
Return type:

Response
Example:

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

update_ccc_upgrade_schedule(ccc_upgrade_schedule_id, update_ccc_upgrade_schedule_details, **kwargs)

Updates the Compute Cloud@Customer upgrade schedule.

Parameters:
  • ccc_upgrade_schedule_id (str) –

    (required) Compute Cloud@Customer upgrade schedule `OCID`__.

  • update_ccc_upgrade_schedule_details (oci.compute_cloud_at_customer.models.UpdateCccUpgradeScheduleDetails) – (required) The information to be updated in the Compute Cloud@Customer upgrade schedule.
  • 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 `OCID`__ for tracing.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • 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 CccUpgradeSchedule
Return type:

Response
Example:

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