Skip to content

update_agent_space async

update_agent_space(
    agent_space_id: AgentSpaceId,
    *,
    config_overrides: Optional[AsyncDevOpsAgentClientConfig] = None,
    name: Optional[AgentSpaceName] = None,
    description: Optional[Description] = None,
    locale: Optional[Locale] = None,
    preferences: Optional[AgentSpacePreferences] = None,
) -> UpdateAgentSpaceOutput

Updates the information of an existing AgentSpace.

Parameters:

  • agent_space_id (AgentSpaceId) –

    The unique identifier of the AgentSpace

  • name (Optional[AgentSpaceName], default: None ) –

    The updated name of the AgentSpace.

  • description (Optional[Description], default: None ) –

    The updated description of the AgentSpace.

  • locale (Optional[Locale], default: None ) –

    The updated locale for the AgentSpace, which determines the language used in agent responses.

  • preferences (Optional[AgentSpacePreferences], default: None ) –

    The preferences to configure on the agent space. When provided, this replaces the full set of configured preferences; preferences not included revert to their default values. When omitted, the current preferences are left unchanged.

Raises:

Source code in docs_src/capo_devops_agent/_services/async_dev_ops_agent.py
async def update_agent_space(
    self,
    agent_space_id: "capo_devops_agent.types.agent_space_id.AgentSpaceId",
    *,
    config_overrides: Optional[AsyncDevOpsAgentClientConfig] = None,
    name: Optional[
        "capo_devops_agent.types.agent_space_name.AgentSpaceName"
    ] = None,
    description: Optional["capo_devops_agent.types.description.Description"] = None,
    locale: Optional["capo_devops_agent.types.locale.Locale"] = None,
    preferences: Optional[
        "capo_devops_agent.types.agent_space_preferences.AgentSpacePreferences"
    ] = None,
) -> "capo_devops_agent.types.update_agent_space_output.UpdateAgentSpaceOutput":
    """<p>Updates the information of an existing AgentSpace.</p>

    Args:
        agent_space_id: <p>The unique identifier of the AgentSpace</p>
        name: <p>The updated name of the AgentSpace.</p>
        description: <p>The updated description of the AgentSpace.</p>
        locale: <p>The updated locale for the AgentSpace, which determines the language used in agent responses.</p>
        preferences: <p>The preferences to configure on the agent space. When provided, this replaces the full set of configured preferences; preferences not included revert to their default values. When omitted, the current preferences are left unchanged.</p>

    Raises:
        capo_devops_agent.errors.access_denied_exception.AccessDeniedException: <p>Access to the requested resource is denied due to insufficient permissions.</p>
        capo_devops_agent.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_devops_agent.errors.content_size_exceeded_exception.ContentSizeExceededException: <p>This exception is thrown when the content size exceeds the allowed limit.</p>
        capo_devops_agent.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an unexpected error occurs in the processing of a request.</p>
        capo_devops_agent.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters provided in the request are invalid.</p>
        capo_devops_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_devops_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed the service quota limit.</p>
        capo_devops_agent.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please slow down and try again.</p>
        capo_devops_agent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_devops_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_devops_agent.types.update_agent_space_input.UpdateAgentSpaceInput]",
    ) -> AsyncOperationResponse[
        "capo_devops_agent.types.update_agent_space_output.UpdateAgentSpaceOutput"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.update_agent_space

        (
            output,
            http_response,
        ) = await capo_devops_agent._operations.dev_ops_agent.update_agent_space.async_update_agent_space(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_devops_agent.types.update_agent_space_input.UpdateAgentSpaceInput",
    ) -> dict[str, Any]:
        import capo_devops_agent.types.update_agent_space_input

        return capo_devops_agent.types.update_agent_space_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_devops_agent.types.update_agent_space_output.UpdateAgentSpaceOutput",
    ) -> dict[str, Any]:
        import capo_devops_agent.types.update_agent_space_output

        return capo_devops_agent.types.update_agent_space_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAgentSpace",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_devops_agent.types.update_agent_space_input.UpdateAgentSpaceInput = {
        "agent_space_id": agent_space_id
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if locale is not None:
        input_["locale"] = locale
    if preferences is not None:
        input_["preferences"] = preferences

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