update_agent_status ¶

update_agent_status(
    agent_id: Uuid,
    task_id: Uuid,
    aggregate_status: AggregateStatus,
    component_statuses: ComponentStatusList,
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
) -> UpdateAgentStatusResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

Update the status of the agent.

Parameters:

agent_id (Uuid) –

UUID of agent to update.
task_id (Uuid) –

GUID of agent task.
aggregate_status (AggregateStatus) –

Aggregate status for agent.
component_statuses (ComponentStatusList) –

List of component statuses for agent.

Raises:

DependencyException –

Dependency encountered an error.
InvalidParameterException –

One or more parameters are not valid.
ResourceNotFoundException –

Resource was not found.
UnknownServiceError –

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

Source code in docs_src/capo_groundstation/_services/ground_station.py

def update_agent_status(
    self,
    agent_id: "capo_groundstation.types.uuid.Uuid",
    task_id: "capo_groundstation.types.uuid.Uuid",
    aggregate_status: "capo_groundstation.types.aggregate_status.AggregateStatus",
    component_statuses: "capo_groundstation.types.component_status_list.ComponentStatusList",
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
) -> "capo_groundstation.types.update_agent_status_response.UpdateAgentStatusResponse":
    """<note> <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p> </note> <p>Update the status of the agent.</p>

    Args:
        agent_id: <p>UUID of agent to update.</p>
        task_id: <p>GUID of agent task.</p>
        aggregate_status: <p>Aggregate status for agent.</p>
        component_statuses: <p>List of component statuses for agent.</p>

    Raises:
        capo_groundstation.errors.dependency_exception.DependencyException: <p>Dependency encountered an error.</p>
        capo_groundstation.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_groundstation.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
        capo_groundstation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_groundstation.types.update_agent_status_request.UpdateAgentStatusRequest]",
    ) -> OperationResponse[
        "capo_groundstation.types.update_agent_status_response.UpdateAgentStatusResponse"
    ]:
        import capo_groundstation._operations.ground_station.update_agent_status

        output, http_response = (
            capo_groundstation._operations.ground_station.update_agent_status.update_agent_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAgentStatus")
    )
    input_: capo_groundstation.types.update_agent_status_request.UpdateAgentStatusRequest = {
        "agent_id": agent_id,
        "task_id": task_id,
        "aggregate_status": aggregate_status,
        "component_statuses": component_statuses,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output