Skip to content

update_exadb_vm_cluster async

update_exadb_vm_cluster(
    exadb_vm_cluster_id: ResourceIdOrArn,
    *,
    config_overrides: Optional[AsyncodbClientConfig] = None,
    data_collection_options: Optional[DataCollectionOptions] = None,
    display_name: Optional[ResourceDisplayName] = None,
    enabled_ecpu_count: Optional[int] = None,
    grid_image_id: Optional[str] = None,
    license_model: Optional[LicenseModel] = None,
    ssh_public_keys: Optional[StringList] = None,
    system_version: Optional[str] = None,
    total_ecpu_count: Optional[int] = None,
    update_action: Optional[UpdateAction] = None,
    vm_file_system_storage_total_size_in_g_bs: Optional[int] = None,
) -> UpdateExadbVmClusterOutput

Updates the specified Exascale VM cluster.

Parameters:

  • exadb_vm_cluster_id (ResourceIdOrArn) –

    The unique identifier of the Exascale VM cluster to update.

  • data_collection_options (Optional[DataCollectionOptions], default: None ) –

    The set of preferences for the various diagnostic collection options for the Exascale VM cluster.

  • display_name (Optional[ResourceDisplayName], default: None ) –

    A new user-friendly name for the Exascale VM cluster.

  • enabled_ecpu_count (Optional[int], default: None ) –

    The number of ECPUs to enable for the Exascale VM cluster.

  • grid_image_id (Optional[str], default: None ) –

    The Grid Infrastructure software image ID for the Exascale VM cluster.

  • license_model (Optional[LicenseModel], default: None ) –

    The Oracle license model to apply to the Exascale VM cluster.

  • ssh_public_keys (Optional[StringList], default: None ) –

    The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.

  • system_version (Optional[str], default: None ) –

    The version of the operating system of the image for the Exascale VM cluster.

  • total_ecpu_count (Optional[int], default: None ) –

    The total number of ECPUs for the Exascale VM cluster.

  • update_action (Optional[UpdateAction], default: None ) –

    The update action to perform on the Exascale VM cluster.

  • vm_file_system_storage_total_size_in_g_bs (Optional[int], default: None ) –

    The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

  • ConflictException –

    Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

  • InternalServerException –

    Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

  • ResourceNotFoundException –

    The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The request has failed validation because it is missing required fields or has invalid inputs.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_odb/_services/async_odb.py
async def update_exadb_vm_cluster(
    self,
    exadb_vm_cluster_id: "capo_odb.types.resource_id_or_arn.ResourceIdOrArn",
    *,
    config_overrides: Optional[AsyncodbClientConfig] = None,
    data_collection_options: Optional[
        "capo_odb.types.data_collection_options.DataCollectionOptions"
    ] = None,
    display_name: Optional[
        "capo_odb.types.resource_display_name.ResourceDisplayName"
    ] = None,
    enabled_ecpu_count: Optional[int] = None,
    grid_image_id: Optional[str] = None,
    license_model: Optional["capo_odb.types.license_model.LicenseModel"] = None,
    ssh_public_keys: Optional["capo_odb.types.string_list.StringList"] = None,
    system_version: Optional[str] = None,
    total_ecpu_count: Optional[int] = None,
    update_action: Optional["capo_odb.types.update_action.UpdateAction"] = None,
    vm_file_system_storage_total_size_in_g_bs: Optional[int] = None,
) -> "capo_odb.types.update_exadb_vm_cluster_output.UpdateExadbVmClusterOutput":
    """<p>Updates the specified Exascale VM cluster.</p>

    Args:
        exadb_vm_cluster_id: <p>The unique identifier of the Exascale VM cluster to update.</p>
        data_collection_options: <p>The set of preferences for the various diagnostic collection options for the Exascale VM cluster.</p>
        display_name: <p>A new user-friendly name for the Exascale VM cluster.</p>
        enabled_ecpu_count: <p>The number of ECPUs to enable for the Exascale VM cluster.</p>
        grid_image_id: <p>The Grid Infrastructure software image ID for the Exascale VM cluster.</p>
        license_model: <p>The Oracle license model to apply to the Exascale VM cluster.</p>
        ssh_public_keys: <p>The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.</p>
        system_version: <p>The version of the operating system of the image for the Exascale VM cluster.</p>
        total_ecpu_count: <p>The total number of ECPUs for the Exascale VM cluster.</p>
        update_action: <p>The update action to perform on the Exascale VM cluster.</p>
        vm_file_system_storage_total_size_in_g_bs: <p>The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_odb.types.update_exadb_vm_cluster_input.UpdateExadbVmClusterInput]",
    ) -> AsyncOperationResponse[
        "capo_odb.types.update_exadb_vm_cluster_output.UpdateExadbVmClusterOutput"
    ]:
        import capo_odb._operations.odb.update_exadb_vm_cluster

        (
            output,
            http_response,
        ) = await capo_odb._operations.odb.update_exadb_vm_cluster.async_update_exadb_vm_cluster(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateExadbVmCluster")
    )
    input_: capo_odb.types.update_exadb_vm_cluster_input.UpdateExadbVmClusterInput = {
        "exadb_vm_cluster_id": exadb_vm_cluster_id
    }
    if data_collection_options is not None:
        input_["data_collection_options"] = data_collection_options
    if display_name is not None:
        input_["display_name"] = display_name
    if enabled_ecpu_count is not None:
        input_["enabled_ecpu_count"] = enabled_ecpu_count
    if grid_image_id is not None:
        input_["grid_image_id"] = grid_image_id
    if license_model is not None:
        input_["license_model"] = license_model
    if ssh_public_keys is not None:
        input_["ssh_public_keys"] = ssh_public_keys
    if system_version is not None:
        input_["system_version"] = system_version
    if total_ecpu_count is not None:
        input_["total_ecpu_count"] = total_ecpu_count
    if update_action is not None:
        input_["update_action"] = update_action
    if vm_file_system_storage_total_size_in_g_bs is not None:
        input_["vm_file_system_storage_total_size_in_g_bs"] = (
            vm_file_system_storage_total_size_in_g_bs
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output