Skip to content

update_context async

update_context(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    context_name: Optional[ContextName] = None,
    description: Optional[ExperimentDescription] = None,
    properties: Optional[LineageEntityParameters] = None,
    properties_to_remove: Optional[ListLineageEntityParameterKey] = None,
) -> UpdateContextResponse

Updates a context.

Parameters:

Raises:

  • ConflictException –

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

  • 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_context(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    context_name: Optional["capo_sagemaker.types.context_name.ContextName"] = None,
    description: Optional[
        "capo_sagemaker.types.experiment_description.ExperimentDescription"
    ] = None,
    properties: Optional[
        "capo_sagemaker.types.lineage_entity_parameters.LineageEntityParameters"
    ] = None,
    properties_to_remove: Optional[
        "capo_sagemaker.types.list_lineage_entity_parameter_key.ListLineageEntityParameterKey"
    ] = None,
) -> "capo_sagemaker.types.update_context_response.UpdateContextResponse":
    """<p>Updates a context.</p>

    Args:
        context_name: <p>The name of the context to update.</p>
        description: <p>The new description for the context.</p>
        properties: <p>The new list of properties. Overwrites the current property list.</p>
        properties_to_remove: <p>A list of properties to remove.</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_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_context_request.UpdateContextRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.update_context_response.UpdateContextResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.update_context

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateContext")
    )
    input_: capo_sagemaker.types.update_context_request.UpdateContextRequest = {}
    if context_name is not None:
        input_["context_name"] = context_name
    if description is not None:
        input_["description"] = description
    if properties is not None:
        input_["properties"] = properties
    if properties_to_remove is not None:
        input_["properties_to_remove"] = properties_to_remove

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