Skip to content

update_agent_context async

update_agent_context(
    profile_arn: AgentProfileArn,
    id: UUID,
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    client_token: Optional[str] = None,
    title: Optional[SensitiveString] = None,
    content: Optional[ContextContent] = None,
) -> UpdateAgentContextResponse

Updates an existing context associated with a profile.

Parameters:

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • profile_arn (AgentProfileArn) –

    The Amazon Resource Name (ARN) of the profile containing the context.

  • id (UUID) –

    The unique identifier of the context to update.

  • title (Optional[SensitiveString], default: None ) –

    The updated title of the context.

  • content (Optional[ContextContent], default: None ) –

    The updated typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.

Raises:

Source code in docs_src/capo_wellarchitected/_services/async_well_architected.py
async def update_agent_context(
    self,
    profile_arn: "capo_wellarchitected.types.agent_profile_arn.AgentProfileArn",
    id: "capo_wellarchitected.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    client_token: Optional[str] = None,
    title: Optional[
        "capo_wellarchitected.types.sensitive_string.SensitiveString"
    ] = None,
    content: Optional[
        "capo_wellarchitected.types.context_content.ContextContent"
    ] = None,
) -> "capo_wellarchitected.types.update_agent_context_response.UpdateAgentContextResponse":
    """<p>Updates an existing context associated with a profile.</p>

    Args:
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
        profile_arn: <p>The Amazon Resource Name (ARN) of the profile containing the context.</p>
        id: <p>The unique identifier of the context to update.</p>
        title: <p>The updated title of the context.</p>
        content: <p>The updated typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wellarchitected.types.update_agent_context_request.UpdateAgentContextRequest]",
    ) -> AsyncOperationResponse[
        "capo_wellarchitected.types.update_agent_context_response.UpdateAgentContextResponse"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.update_agent_context

        (
            output,
            http_response,
        ) = await capo_wellarchitected._operations.well_architected_api_service_lambda.update_agent_context.async_update_agent_context(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_wellarchitected.types.update_agent_context_request.UpdateAgentContextRequest",
    ) -> dict[str, Any]:
        import capo_wellarchitected.types.update_agent_context_request

        return capo_wellarchitected.types.update_agent_context_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_wellarchitected.types.update_agent_context_response.UpdateAgentContextResponse",
    ) -> dict[str, Any]:
        import capo_wellarchitected.types.update_agent_context_response

        return capo_wellarchitected.types.update_agent_context_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAgentContext",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_wellarchitected.types.update_agent_context_request.UpdateAgentContextRequest = {
        "profile_arn": profile_arn,
        "id": id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if title is not None:
        input_["title"] = title
    if content is not None:
        input_["content"] = content

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