[ aws . groundstation ]

register-agent

Description

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

Synopsis

  register-agent
--agent-details <value>
--discovery-data <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--agent-details (structure)

Detailed information about the agent being registered.

agentCpuCores -> (list)

List of CPU cores reserved for the agent.

(integer)

agentVersion -> (string)

Current agent version.

componentVersions -> (list)

List of versions being used by agent components.

(structure)

Version information for agent components.

componentType -> (string)

Component type.

versions -> (list)

List of versions.

(string)

instanceId -> (string)

ID of EC2 instance agent is running on.

instanceType -> (string)

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)

JSON Syntax:

{
  "agentCpuCores": [integer, ...],
  "agentVersion": "string",
  "componentVersions": [
    {
      "componentType": "string",
      "versions": ["string", ...]
    }
    ...
  ],
  "instanceId": "string",
  "instanceType": "string",
  "reservedCpuCores": [integer, ...]
}

--discovery-data (structure)

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

capabilityArns -> (list)

List of capabilities to associate with agent.

(string)

privateIpAddresses -> (list)

List of private IP addresses to associate with agent.

(string)

publicIpAddresses -> (list)

List of public IP addresses to associate with agent.

(string)

Shorthand Syntax:

capabilityArns=string,string,privateIpAddresses=string,string,publicIpAddresses=string,string

JSON Syntax:

{
  "capabilityArns": ["string", ...],
  "privateIpAddresses": ["string", ...],
  "publicIpAddresses": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

agentId -> (string)

UUID of registered agent.