agents

Creates, updates, deletes, gets or lists an agents resource.

Overview

Name	agents
Type	Resource
Id	aws.groundstation.agents

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
register_agent	insert	region, discoveryData, agentDetails		For use by AWS Ground Station Agent and shouldn't be called directly. Registers a new agent with AWS Ground Station.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

INSERT examples

register_agent

For use by AWS Ground Station Agent and shouldn't be called directly. Registers a new agent with AWS Ground Station.

INSERT INTO aws.groundstation.agents (
discoveryData,
agentDetails,
tags,
region
)
SELECT 
'{{ discoveryData }}' /* required */,
'{{ agentDetails }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
agent_id
;

Manifest

# Description fields are for documentation purposes
- name: agents
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agents resource.
  - name: discoveryData
    description: |
      Data for agent discovery.
    value:
      publicIpAddresses:
        - "{{ publicIpAddresses }}"
      privateIpAddresses:
        - "{{ privateIpAddresses }}"
      capabilityArns:
        - "{{ capabilityArns }}"
  - name: agentDetails
    description: |
      Detailed information about the agent.
    value:
      agentVersion: "{{ agentVersion }}"
      instanceId: "{{ instanceId }}"
      instanceType: "{{ instanceType }}"
      reservedCpuCores:
        - {{ reservedCpuCores }}
      agentCpuCores:
        - {{ agentCpuCores }}
      componentVersions:
        - componentType: "{{ componentType }}"
          versions: "{{ versions }}"
  - name: tags
    value: "{{ tags }}"