GroundStation / Client / register_agent

register_agent

GroundStation.Client.register_agent(**kwargs)

Note

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

Registers a new agent with AWS Ground Station.

See also: AWS API Documentation

Request Syntax

response = client.register_agent(
    agentDetails={
        'agentCpuCores': [
            123,
        ],
        'agentVersion': 'string',
        'componentVersions': [
            {
                'componentType': 'string',
                'versions': [
                    'string',
                ]
            },
        ],
        'instanceId': 'string',
        'instanceType': 'string',
        'reservedCpuCores': [
            123,
        ]
    },
    discoveryData={
        'capabilityArns': [
            'string',
        ],
        'privateIpAddresses': [
            'string',
        ],
        'publicIpAddresses': [
            'string',
        ]
    }
)

Parameters:

• agentDetails (dict) –

  [REQUIRED]

  Detailed information about the agent being registered.

  • agentCpuCores (list) –

    List of CPU cores reserved for the agent.

    • (integer) –

  • agentVersion (string) – [REQUIRED]

    Current agent version.

  • componentVersions (list) – [REQUIRED]

    List of versions being used by agent components.

    • (dict) –

      Version information for agent components.

      • componentType (string) – [REQUIRED]

        Component type.

      • versions (list) – [REQUIRED]

        List of versions.

        • (string) –

  • instanceId (string) – [REQUIRED]

    ID of EC2 instance agent is running on.

  • instanceType (string) – [REQUIRED]

    Type of EC2 instance agent is running on.

  • reservedCpuCores (list) –

    Note

    This field should not be used. Use agentCpuCores instead.

    List of CPU cores reserved for processes other than the agent running on the EC2 instance.

    • (integer) –

• discoveryData (dict) –

  [REQUIRED]

  Data for associating an agent with the capabilities it is managing.

  • capabilityArns (list) – [REQUIRED]

    List of capabilities to associate with agent.

    • (string) –

  • privateIpAddresses (list) – [REQUIRED]

    List of private IP addresses to associate with agent.

    • (string) –

  • publicIpAddresses (list) – [REQUIRED]

    List of public IP addresses to associate with agent.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'agentId': 'string'
}

Response Structure

• (dict) –

  • agentId (string) –

    UUID of registered agent.

Exceptions

• GroundStation.Client.exceptions.InvalidParameterException

• GroundStation.Client.exceptions.DependencyException

• GroundStation.Client.exceptions.ResourceNotFoundException