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 . iot-roborunner ]

create-worker

Description

Grants permission to create a worker

See also: AWS API Documentation

Synopsis

  create-worker
[--client-token <value>]
--name <value>
--fleet <value>
[--additional-transient-properties <value>]
[--additional-fixed-properties <value>]
[--vendor-properties <value>]
[--position <value>]
[--orientation <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

--client-token (string)

Token used for detecting replayed requests. Replayed requests will not be performed multiple times.

--name (string)

Human friendly name of the resource.

--fleet (string)

Full ARN of the worker fleet.

--additional-transient-properties (string)

JSON blob containing unstructured worker properties that are transient and may change during regular operation.

--additional-fixed-properties (string)

JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

--vendor-properties (structure)

Properties of the worker that are provided by the vendor FMS.

vendorWorkerId -> (string)

The worker ID defined by the vendor FMS.

vendorWorkerIpAddress -> (string)

The worker IP address defined by the vendor FMS.

vendorAdditionalTransientProperties -> (string)

JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

vendorAdditionalFixedProperties -> (string)

JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

Shorthand Syntax:

vendorWorkerId=string,vendorWorkerIpAddress=string,vendorAdditionalTransientProperties=string,vendorAdditionalFixedProperties=string

JSON Syntax:

{
  "vendorWorkerId": "string",
  "vendorWorkerIpAddress": "string",
  "vendorAdditionalTransientProperties": "string",
  "vendorAdditionalFixedProperties": "string"
}

--position (tagged union structure)

Supported coordinates for worker position.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cartesianCoordinates.

cartesianCoordinates -> (structure)

Cartesian coordinates.

x -> (double)

X coordinate.

y -> (double)

Y coordinate.

z -> (double)

Z coordinate.

Shorthand Syntax:

cartesianCoordinates={x=double,y=double,z=double}

JSON Syntax:

{
  "cartesianCoordinates": {
    "x": double,
    "y": double,
    "z": double
  }
}

--orientation (tagged union structure)

Worker orientation measured in units clockwise from north.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: degrees.

degrees -> (double)

Degrees, limited on [0, 360)

Shorthand Syntax:

degrees=double

JSON Syntax:

{
  "degrees": double
}

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

arn -> (string)

Full ARN of the worker.

id -> (string)

Filters access by the workers identifier

createdAt -> (timestamp)

Timestamp at which the resource was created.

updatedAt -> (timestamp)

Timestamp at which the resource was last updated.

site -> (string)

Site ARN.