Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

register_agent

register_agent(**kwargs)

Registers a new agent with AWS Groundstation.

See also: AWS API Documentation

Request Syntax

response = client.register_agent(
    agentDetails={
        'agentVersion': 'string',
        'componentVersions': [
            {
                'componentType': 'LAMINAR_FLOW'|'PRISM'|'DIGITIZER',
                '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.

    • 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) -- [REQUIRED]

      Number of Cpu cores reserved for agent.

      • (integer) --
  • discoveryData (dict) --

    [REQUIRED]

    Data for associating and 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