Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

ListWorkers

class IoTRoboRunner.Paginator.ListWorkers
paginator = client.get_paginator('list_workers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTRoboRunner.Client.list_workers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    site='string',
    fleet='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • fleet (string) -- Full ARN of the worker fleet.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • workers (list) --

      List of workers.

      • (dict) --

        A unit capable of performing tasks.

        • arn (string) --

          Full ARN of the worker.

        • id (string) --

          Filters access by the workers identifier

        • fleet (string) --

          Full ARN of the worker fleet.

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

        • site (string) --

          Site ARN.

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

    • NextToken (string) --

      A token to resume pagination.