Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--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>]

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

agentId -> (string)

UUID of registered agent.