Skip to content

update_cluster_scheduler_config async

update_cluster_scheduler_config(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    cluster_scheduler_config_id: Optional[ClusterSchedulerConfigId] = None,
    target_version: Optional[Integer] = None,
    scheduler_config: Optional[SchedulerConfig] = None,
    description: Optional[EntityDescription] = None,
) -> UpdateClusterSchedulerConfigResponse

Update the cluster policy configuration.

Parameters:

Raises:

  • ConflictException –

    There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

  • ResourceLimitExceeded –

    You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

  • ResourceNotFound –

    Resource being access is not found.

  • UnknownServiceError –

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

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def update_cluster_scheduler_config(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    cluster_scheduler_config_id: Optional[
        "capo_sagemaker.types.cluster_scheduler_config_id.ClusterSchedulerConfigId"
    ] = None,
    target_version: Optional["capo_sagemaker.types.integer.Integer"] = None,
    scheduler_config: Optional[
        "capo_sagemaker.types.scheduler_config.SchedulerConfig"
    ] = None,
    description: Optional[
        "capo_sagemaker.types.entity_description.EntityDescription"
    ] = None,
) -> "capo_sagemaker.types.update_cluster_scheduler_config_response.UpdateClusterSchedulerConfigResponse":
    """<p>Update the cluster policy configuration.</p>

    Args:
        cluster_scheduler_config_id: <p>ID of the cluster policy.</p>
        target_version: <p>Target version.</p>
        scheduler_config: <p>Cluster policy configuration.</p>
        description: <p>Description of the cluster policy.</p>

    Raises:
        capo_sagemaker.errors.conflict_exception.ConflictException: <p>There was a conflict when you attempted to modify a SageMaker entity such as an <code>Experiment</code> or <code>Artifact</code>.</p>
        capo_sagemaker.errors.resource_limit_exceeded.ResourceLimitExceeded: <p> You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. </p>
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.update_cluster_scheduler_config_request.UpdateClusterSchedulerConfigRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.update_cluster_scheduler_config_response.UpdateClusterSchedulerConfigResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.update_cluster_scheduler_config

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.update_cluster_scheduler_config.async_update_cluster_scheduler_config(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateClusterSchedulerConfig")
    )
    input_: capo_sagemaker.types.update_cluster_scheduler_config_request.UpdateClusterSchedulerConfigRequest = {}
    if cluster_scheduler_config_id is not None:
        input_["cluster_scheduler_config_id"] = cluster_scheduler_config_id
    if target_version is not None:
        input_["target_version"] = target_version
    if scheduler_config is not None:
        input_["scheduler_config"] = scheduler_config
    if description is not None:
        input_["description"] = description

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