register_agent ¶

register_agent(
    discovery_data: DiscoveryData,
    agent_details: AgentDetails,
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
    tags: Optional[TagsMap] = None,
) -> RegisterAgentResponse

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

Registers a new agent with AWS Ground Station.

Parameters:

discovery_data (DiscoveryData) –

Data for associating an agent with the capabilities it is managing.
agent_details (AgentDetails) –

Detailed information about the agent being registered.
tags (Optional[TagsMap], default: None ) –

Tags assigned to an 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 register_agent(
    self,
    discovery_data: "capo_groundstation.types.discovery_data.DiscoveryData",
    agent_details: "capo_groundstation.types.agent_details.AgentDetails",
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
    tags: Optional["capo_groundstation.types.tags_map.TagsMap"] = None,
) -> "capo_groundstation.types.register_agent_response.RegisterAgentResponse":
    """<note> <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p> </note> <p> Registers a new agent with AWS Ground Station. </p>

    Args:
        discovery_data: <p>Data for associating an agent with the capabilities it is managing.</p>
        agent_details: <p>Detailed information about the agent being registered.</p>
        tags: <p>Tags assigned to an <code>Agent</code>.</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.register_agent_request.RegisterAgentRequest]",
    ) -> OperationResponse[
        "capo_groundstation.types.register_agent_response.RegisterAgentResponse"
    ]:
        import capo_groundstation._operations.ground_station.register_agent

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RegisterAgent")
    )
    input_: capo_groundstation.types.register_agent_request.RegisterAgentRequest = {
        "discovery_data": discovery_data,
        "agent_details": agent_details,
    }
    if tags is not None:
        input_["tags"] = tags

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