Skip to content

get_agent_configuration

get_agent_configuration(
    agent_id: Uuid, *, config_overrides: Optional[GroundStationClientConfig] = None
) -> GetAgentConfigurationResponse

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

Gets the latest configuration information for a registered agent.

Parameters:

  • agent_id (Uuid) –

    UUID of agent to get configuration information for.

Raises:

Source code in docs_src/capo_groundstation/_services/ground_station.py
def get_agent_configuration(
    self,
    agent_id: "capo_groundstation.types.uuid.Uuid",
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
) -> "capo_groundstation.types.get_agent_configuration_response.GetAgentConfigurationResponse":
    """<note> <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p> </note> <p>Gets the latest configuration information for a registered agent.</p>

    Args:
        agent_id: <p>UUID of agent to get configuration information for.</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.get_agent_configuration_request.GetAgentConfigurationRequest]",
    ) -> OperationResponse[
        "capo_groundstation.types.get_agent_configuration_response.GetAgentConfigurationResponse"
    ]:
        import capo_groundstation._operations.ground_station.get_agent_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAgentConfiguration")
    )
    input_: capo_groundstation.types.get_agent_configuration_request.GetAgentConfigurationRequest = {
        "agent_id": agent_id
    }

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