AWS Ground Station

{'tags': {'string': 'string'}}

Registers a new agent with AWS Ground Station.

See also: AWS API Documentation

Request Syntax

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',
        ]
    },
    tags={
        'string': 'string'
    }
)

type agentDetails:

dict

param agentDetails:

[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) --

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

  • (integer) --

type discoveryData:

dict

param discoveryData:

[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) --

type tags:

dict

param tags:

Tags assigned to an Agent.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'agentId': 'string'
}

Response Structure

• (dict) --

  • agentId (string) --

    UUID of registered agent.