Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListWorkers

List workers.

Request Syntax


GET /listWorkers?fleet=fleet&maxResults=maxResults&nextToken=nextToken&site=site HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

fleet

Worker fleet ARN.

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:aws:iotroborunner:[\w-]+:\w+:site/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/worker-fleet/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

maxResults

Maximum number of results to retrieve in a single call.

Valid Range: Minimum value of 1. Maximum value of 25.

nextToken

Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [a-zA-Z0-9_.-/+=]*

site

Facility ARN.

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ^arn:aws:iotroborunner:[\w-]+:\w+:site/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "workers": [ 
      { 
         "additionalFixedProperties": "string",
         "additionalTransientProperties": "string",
         "arn": "string",
         "createdAt": number,
         "fleet": "string",
         "id": "string",
         "name": "string",
         "orientation": { ... },
         "position": { ... },
         "site": "string",
         "updatedAt": number,
         "vendorProperties": { 
            "vendorAdditionalFixedProperties": "string",
            "vendorAdditionalTransientProperties": "string",
            "vendorWorkerId": "string",
            "vendorWorkerIpAddress": "string"
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [a-zA-Z0-9_.-/+=]*

workers

List of workers.

Type: Array of Worker objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Exception thrown if the user does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Exception thrown if something goes wrong within Iot RoboRunner.

HTTP Status Code: 500

ResourceNotFoundException

Exception thrown if a resource referenced in the request doesn't exist.

HTTP Status Code: 404

ThrottlingException

Exception thrown if the API is called too quickly.

HTTP Status Code: 429

ValidationException

Exception thrown if the API parameters do not pass validation.

HTTP Status Code: 400