IoTRoboRunner / Client / get_worker

get_worker

IoTRoboRunner.Client.get_worker(**kwargs)

Grants permission to get a worker

See also: AWS API Documentation

Request Syntax

response = client.get_worker(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

Full ARN of the worker.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'fleet': 'string',
    'site': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'name': '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
    }
}

Response Structure

• (dict) –

  • arn (string) –

    Full ARN of the worker.

  • id (string) –

    Filters access by the workers identifier

  • fleet (string) –

    Full ARN of the worker fleet.

  • site (string) –

    Site ARN.

  • createdAt (datetime) –

    Timestamp at which the resource was created.

  • updatedAt (datetime) –

    Timestamp at which the resource was last updated.

  • name (string) –

    Human friendly name of the resource.

  • 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) –

      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 will be set: cartesianCoordinates. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • cartesianCoordinates (dict) –

      Cartesian coordinates.

      • x (float) –

        X coordinate.

      • y (float) –

        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 will be set: degrees. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • degrees (float) –

      Degrees, limited on [0, 360)

Exceptions

• IoTRoboRunner.Client.exceptions.AccessDeniedException

• IoTRoboRunner.Client.exceptions.ValidationException

• IoTRoboRunner.Client.exceptions.ResourceNotFoundException

• IoTRoboRunner.Client.exceptions.ThrottlingException

• IoTRoboRunner.Client.exceptions.InternalServerException