IoTRoboRunner / Client / create_worker

create_worker

IoTRoboRunner.Client.create_worker(**kwargs)

Grants permission to create a worker

See also: AWS API Documentation

Request Syntax

response = client.create_worker(
    clientToken='string',
    name='string',
    fleet='string',
    additionalTransientProperties='string',
    additionalFixedProperties='string',
    vendorProperties={
        'vendorWorkerId': 'string',
        'vendorWorkerIpAddress': 'string',
        'vendorAdditionalTransientProperties': 'string',
        'vendorAdditionalFixedProperties': 'string'
    },
    position={
        'cartesianCoordinates': {
            'x': 123.0,
            'y': 123.0,
            'z': 123.0
        }
    },
    orientation={
        'degrees': 123.0
    }
)

Parameters:

• clientToken (string) –

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

  This field is autopopulated if not provided.

• name (string) –

  [REQUIRED]

  Human friendly name of the resource.

• fleet (string) –

  [REQUIRED]

  Full ARN of the worker fleet.

• additionalTransientProperties (string) – JSON blob containing unstructured worker properties that are transient and may change during regular operation.

• additionalFixedProperties (string) – JSON blob containing unstructured worker properties that are fixed and won’t change during regular operation.

• vendorProperties (dict) –

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

  • vendorWorkerId (string) – [REQUIRED]

    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.

• position (dict) –

  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 (dict) –

    Cartesian coordinates.

    • x (float) – [REQUIRED]

      X coordinate.

    • y (float) – [REQUIRED]

      Y coordinate.

    • z (float) –

      Z coordinate.

• orientation (dict) –

  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 (float) –

    Degrees, limited on [0, 360)

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'site': 'string'
}

Response Structure

• (dict) –

  • arn (string) –

    Full ARN of the worker.

  • id (string) –

    Filters access by the workers identifier

  • createdAt (datetime) –

    Timestamp at which the resource was created.

  • updatedAt (datetime) –

    Timestamp at which the resource was last updated.

  • site (string) –

    Site ARN.

Exceptions

• IoTRoboRunner.Client.exceptions.ConflictException

• IoTRoboRunner.Client.exceptions.AccessDeniedException

• IoTRoboRunner.Client.exceptions.ValidationException

• IoTRoboRunner.Client.exceptions.ResourceNotFoundException

• IoTRoboRunner.Client.exceptions.ThrottlingException

• IoTRoboRunner.Client.exceptions.InternalServerException

• IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException