AWS IoT RoboRunner 2018-05-10
- Client: Aws\IoTRoboRunner\IoTRoboRunnerClient
- Service ID: iot-roborunner
- Version: 2018-05-10
This page describes the parameters and results for the operations of the AWS IoT RoboRunner (2018-05-10), and shows how to use the Aws\IoTRoboRunner\IoTRoboRunnerClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateDestination ( array $params = [] )
Grants permission to create a destination
- CreateSite ( array $params = [] )
Grants permission to create a site
- CreateWorker ( array $params = [] )
Grants permission to create a worker
- CreateWorkerFleet ( array $params = [] )
Grants permission to create a worker fleet
- DeleteDestination ( array $params = [] )
Grants permission to delete a destination
- DeleteSite ( array $params = [] )
Grants permission to delete a site
- DeleteWorker ( array $params = [] )
Grants permission to delete a worker
- DeleteWorkerFleet ( array $params = [] )
Grants permission to delete a worker fleet
- GetDestination ( array $params = [] )
Grants permission to get a destination
- GetSite ( array $params = [] )
Grants permission to get a site
- GetWorker ( array $params = [] )
Grants permission to get a worker
- GetWorkerFleet ( array $params = [] )
Grants permission to get a worker fleet
- ListDestinations ( array $params = [] )
Grants permission to list destinations
- ListSites ( array $params = [] )
Grants permission to list sites
- ListWorkerFleets ( array $params = [] )
Grants permission to list worker fleets
- ListWorkers ( array $params = [] )
Grants permission to list workers
- UpdateDestination ( array $params = [] )
Grants permission to update a destination
- UpdateSite ( array $params = [] )
Grants permission to update a site
- UpdateWorker ( array $params = [] )
Grants permission to update a worker
- UpdateWorkerFleet ( array $params = [] )
Grants permission to update a worker fleet
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateDestination
$result = $client->createDestination([/* ... */]); $promise = $client->createDestinationAsync([/* ... */]);
Grants permission to create a destination
Parameter Syntax
$result = $client->createDestination([
'additionalFixedProperties' => '<string>',
'clientToken' => '<string>',
'name' => '<string>', // REQUIRED
'site' => '<string>', // REQUIRED
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
]);
Parameter Details
Members
- additionalFixedProperties
-
- Type: string
JSON document containing additional fixed properties regarding the destination
- clientToken
-
- Type: string
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- site
-
- Required: Yes
- Type: string
Site ARN.
- state
-
- Type: string
The state of the destination. Default used if not specified.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
Destination ARN.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the destination's identifier
- state
-
- Required: Yes
- Type: string
State of the destination.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
-
ServiceQuotaExceededException:
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
CreateSite
$result = $client->createSite([/* ... */]); $promise = $client->createSiteAsync([/* ... */]);
Grants permission to create a site
Parameter Syntax
$result = $client->createSite([
'clientToken' => '<string>',
'countryCode' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- clientToken
-
- Type: string
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
- countryCode
-
- Required: Yes
- Type: string
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
- description
-
- Type: string
A high-level description of the site.
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
Site ARN.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the site's identifier
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
-
ServiceQuotaExceededException:
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
CreateWorker
$result = $client->createWorker([/* ... */]); $promise = $client->createWorkerAsync([/* ... */]);
Grants permission to create a worker
Parameter Syntax
$result = $client->createWorker([
'additionalFixedProperties' => '<string>',
'additionalTransientProperties' => '<string>',
'clientToken' => '<string>',
'fleet' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
'orientation' => [
'degrees' => <float>,
],
'position' => [
'cartesianCoordinates' => [
'x' => <float>, // REQUIRED
'y' => <float>, // REQUIRED
'z' => <float>,
],
],
'vendorProperties' => [
'vendorAdditionalFixedProperties' => '<string>',
'vendorAdditionalTransientProperties' => '<string>',
'vendorWorkerId' => '<string>', // REQUIRED
'vendorWorkerIpAddress' => '<string>',
],
]);
Parameter Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
- additionalTransientProperties
-
- Type: string
JSON blob containing unstructured worker properties that are transient and may change during regular operation.
- clientToken
-
- Type: string
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
- fleet
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- orientation
-
- Type: Orientation structure
Worker orientation measured in units clockwise from north.
- position
-
- Type: PositionCoordinates structure
Supported coordinates for worker position.
- vendorProperties
-
- Type: VendorProperties structure
Properties of the worker that are provided by the vendor FMS.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'site' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the workers identifier
- site
-
- Required: Yes
- Type: string
Site ARN.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
-
ServiceQuotaExceededException:
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
CreateWorkerFleet
$result = $client->createWorkerFleet([/* ... */]); $promise = $client->createWorkerFleetAsync([/* ... */]);
Grants permission to create a worker fleet
Parameter Syntax
$result = $client->createWorkerFleet([
'additionalFixedProperties' => '<string>',
'clientToken' => '<string>',
'name' => '<string>', // REQUIRED
'site' => '<string>', // REQUIRED
]);
Parameter Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing additional fixed properties regarding the worker fleet
- clientToken
-
- Type: string
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- site
-
- Required: Yes
- Type: string
Site ARN.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the worker fleet's identifier
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
-
ServiceQuotaExceededException:
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
DeleteDestination
$result = $client->deleteDestination([/* ... */]); $promise = $client->deleteDestinationAsync([/* ... */]);
Grants permission to delete a destination
Parameter Syntax
$result = $client->deleteDestination([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
DeleteSite
$result = $client->deleteSite([/* ... */]); $promise = $client->deleteSiteAsync([/* ... */]);
Grants permission to delete a site
Parameter Syntax
$result = $client->deleteSite([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
DeleteWorker
$result = $client->deleteWorker([/* ... */]); $promise = $client->deleteWorkerAsync([/* ... */]);
Grants permission to delete a worker
Parameter Syntax
$result = $client->deleteWorker([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
DeleteWorkerFleet
$result = $client->deleteWorkerFleet([/* ... */]); $promise = $client->deleteWorkerFleetAsync([/* ... */]);
Grants permission to delete a worker fleet
Parameter Syntax
$result = $client->deleteWorkerFleet([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Exception thrown if a resource in a create request already exists.
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
GetDestination
$result = $client->getDestination([/* ... */]); $promise = $client->getDestinationAsync([/* ... */]);
Grants permission to get a destination
Parameter Syntax
$result = $client->getDestination([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'additionalFixedProperties' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'name' => '<string>',
'site' => '<string>',
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- additionalFixedProperties
-
- Type: string
JSON document containing additional fixed properties regarding the destination
- arn
-
- Required: Yes
- Type: string
Destination ARN.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the destination's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- site
-
- Required: Yes
- Type: string
Site ARN.
- state
-
- Required: Yes
- Type: string
State of the destination.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
GetSite
$result = $client->getSite([/* ... */]); $promise = $client->getSiteAsync([/* ... */]);
Grants permission to get a site
Parameter Syntax
$result = $client->getSite([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'arn' => '<string>',
'countryCode' => '<string>',
'createdAt' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
Site ARN.
- countryCode
-
- Required: Yes
- Type: string
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- description
-
- Type: string
A high-level description of the site.
- id
-
- Required: Yes
- Type: string
Filters access by the site's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
GetWorker
$result = $client->getWorker([/* ... */]); $promise = $client->getWorkerAsync([/* ... */]);
Grants permission to get a worker
Parameter Syntax
$result = $client->getWorker([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'additionalFixedProperties' => '<string>',
'additionalTransientProperties' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'fleet' => '<string>',
'id' => '<string>',
'name' => '<string>',
'orientation' => [
'degrees' => <float>,
],
'position' => [
'cartesianCoordinates' => [
'x' => <float>,
'y' => <float>,
'z' => <float>,
],
],
'site' => '<string>',
'updatedAt' => <DateTime>,
'vendorProperties' => [
'vendorAdditionalFixedProperties' => '<string>',
'vendorAdditionalTransientProperties' => '<string>',
'vendorWorkerId' => '<string>',
'vendorWorkerIpAddress' => '<string>',
],
]
Result Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
- additionalTransientProperties
-
- Type: string
JSON blob containing unstructured worker properties that are transient and may change during regular operation.
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- fleet
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- id
-
- Required: Yes
- Type: string
Filters access by the workers identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- orientation
-
- Type: Orientation structure
Worker orientation measured in units clockwise from north.
- position
-
- Type: PositionCoordinates structure
Supported coordinates for worker position.
- site
-
- Required: Yes
- Type: string
Site ARN.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
- vendorProperties
-
- Type: VendorProperties structure
Properties of the worker that are provided by the vendor FMS.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
GetWorkerFleet
$result = $client->getWorkerFleet([/* ... */]); $promise = $client->getWorkerFleetAsync([/* ... */]);
Grants permission to get a worker fleet
Parameter Syntax
$result = $client->getWorkerFleet([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'additionalFixedProperties' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'name' => '<string>',
'site' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing additional fixed properties regarding the worker fleet
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the worker fleet's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- site
-
- Required: Yes
- Type: string
Site ARN.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
ListDestinations
$result = $client->listDestinations([/* ... */]); $promise = $client->listDestinationsAsync([/* ... */]);
Grants permission to list destinations
Parameter Syntax
$result = $client->listDestinations([
'maxResults' => <integer>,
'nextToken' => '<string>',
'site' => '<string>', // REQUIRED
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Maximum number of results to retrieve in a single call.
- nextToken
-
- Type: string
Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
- site
-
- Required: Yes
- Type: string
Site ARN.
- state
-
- Type: string
State of the destination.
Result Syntax
[
'destinations' => [
[
'additionalFixedProperties' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'name' => '<string>',
'site' => '<string>',
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- destinations
-
- Type: Array of Destination structures
List of destinations.
- nextToken
-
- Type: string
Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
ListSites
$result = $client->listSites([/* ... */]); $promise = $client->listSitesAsync([/* ... */]);
Grants permission to list sites
Parameter Syntax
$result = $client->listSites([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'sites' => [
[
'arn' => '<string>',
'countryCode' => '<string>',
'createdAt' => <DateTime>,
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
- sites
-
- Type: Array of Site structures
List of facilities.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
ListWorkerFleets
$result = $client->listWorkerFleets([/* ... */]); $promise = $client->listWorkerFleetsAsync([/* ... */]);
Grants permission to list worker fleets
Parameter Syntax
$result = $client->listWorkerFleets([
'maxResults' => <integer>,
'nextToken' => '<string>',
'site' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'workerFleets' => [
[
'additionalFixedProperties' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'id' => '<string>',
'name' => '<string>',
'site' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
- workerFleets
-
- Type: Array of WorkerFleet structures
List of worker fleets.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
ListWorkers
$result = $client->listWorkers([/* ... */]); $promise = $client->listWorkersAsync([/* ... */]);
Grants permission to list workers
Parameter Syntax
$result = $client->listWorkers([
'fleet' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
'site' => '<string>', // REQUIRED
]);
Parameter Details
Members
- fleet
-
- Type: string
Full ARN of the worker fleet.
- maxResults
-
- Type: int
Maximum number of results to retrieve in a single ListWorkers call.
- nextToken
-
- Type: string
Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
- site
-
- Required: Yes
- Type: string
Site ARN.
Result Syntax
[
'nextToken' => '<string>',
'workers' => [
[
'additionalFixedProperties' => '<string>',
'additionalTransientProperties' => '<string>',
'arn' => '<string>',
'createdAt' => <DateTime>,
'fleet' => '<string>',
'id' => '<string>',
'name' => '<string>',
'orientation' => [
'degrees' => <float>,
],
'position' => [
'cartesianCoordinates' => [
'x' => <float>,
'y' => <float>,
'z' => <float>,
],
],
'site' => '<string>',
'updatedAt' => <DateTime>,
'vendorProperties' => [
'vendorAdditionalFixedProperties' => '<string>',
'vendorAdditionalTransientProperties' => '<string>',
'vendorWorkerId' => '<string>',
'vendorWorkerIpAddress' => '<string>',
],
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
- workers
-
- Type: Array of Worker structures
List of workers.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
UpdateDestination
$result = $client->updateDestination([/* ... */]); $promise = $client->updateDestinationAsync([/* ... */]);
Grants permission to update a destination
Parameter Syntax
$result = $client->updateDestination([
'additionalFixedProperties' => '<string>',
'id' => '<string>', // REQUIRED
'name' => '<string>',
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
]);
Parameter Details
Members
Result Syntax
[
'additionalFixedProperties' => '<string>',
'arn' => '<string>',
'id' => '<string>',
'name' => '<string>',
'state' => 'ENABLED|DISABLED|DECOMMISSIONED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- additionalFixedProperties
-
- Type: string
JSON document containing additional fixed properties regarding the destination
- arn
-
- Required: Yes
- Type: string
Destination ARN.
- id
-
- Required: Yes
- Type: string
Filters access by the destination's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- state
-
- Required: Yes
- Type: string
State of the destination.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
UpdateSite
$result = $client->updateSite([/* ... */]); $promise = $client->updateSiteAsync([/* ... */]);
Grants permission to update a site
Parameter Syntax
$result = $client->updateSite([
'countryCode' => '<string>',
'description' => '<string>',
'id' => '<string>', // REQUIRED
'name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'arn' => '<string>',
'countryCode' => '<string>',
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
Site ARN.
- countryCode
-
- Type: string
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
- description
-
- Type: string
A high-level description of the site.
- id
-
- Required: Yes
- Type: string
Filters access by the site's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
UpdateWorker
$result = $client->updateWorker([/* ... */]); $promise = $client->updateWorkerAsync([/* ... */]);
Grants permission to update a worker
Parameter Syntax
$result = $client->updateWorker([
'additionalFixedProperties' => '<string>',
'additionalTransientProperties' => '<string>',
'id' => '<string>', // REQUIRED
'name' => '<string>',
'orientation' => [
'degrees' => <float>,
],
'position' => [
'cartesianCoordinates' => [
'x' => <float>, // REQUIRED
'y' => <float>, // REQUIRED
'z' => <float>,
],
],
'vendorProperties' => [
'vendorAdditionalFixedProperties' => '<string>',
'vendorAdditionalTransientProperties' => '<string>',
'vendorWorkerId' => '<string>', // REQUIRED
'vendorWorkerIpAddress' => '<string>',
],
]);
Parameter Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
- additionalTransientProperties
-
- Type: string
JSON blob containing unstructured worker properties that are transient and may change during regular operation.
- id
-
- Required: Yes
- Type: string
Full ARN of the worker.
- name
-
- Type: string
Human friendly name of the resource.
- orientation
-
- Type: Orientation structure
Worker orientation measured in units clockwise from north.
- position
-
- Type: PositionCoordinates structure
Supported coordinates for worker position.
- vendorProperties
-
- Type: VendorProperties structure
Properties of the worker that are provided by the vendor FMS.
Result Syntax
[
'additionalFixedProperties' => '<string>',
'additionalTransientProperties' => '<string>',
'arn' => '<string>',
'fleet' => '<string>',
'id' => '<string>',
'name' => '<string>',
'orientation' => [
'degrees' => <float>,
],
'position' => [
'cartesianCoordinates' => [
'x' => <float>,
'y' => <float>,
'z' => <float>,
],
],
'updatedAt' => <DateTime>,
'vendorProperties' => [
'vendorAdditionalFixedProperties' => '<string>',
'vendorAdditionalTransientProperties' => '<string>',
'vendorWorkerId' => '<string>',
'vendorWorkerIpAddress' => '<string>',
],
]
Result Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
- additionalTransientProperties
-
- Type: string
JSON blob containing unstructured worker properties that are transient and may change during regular operation.
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker.
- fleet
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- id
-
- Required: Yes
- Type: string
Filters access by the workers identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- orientation
-
- Type: Orientation structure
Worker orientation measured in units clockwise from north.
- position
-
- Type: PositionCoordinates structure
Supported coordinates for worker position.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
- vendorProperties
-
- Type: VendorProperties structure
Properties of the worker that are provided by the vendor FMS.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
UpdateWorkerFleet
$result = $client->updateWorkerFleet([/* ... */]); $promise = $client->updateWorkerFleetAsync([/* ... */]);
Grants permission to update a worker fleet
Parameter Syntax
$result = $client->updateWorkerFleet([
'additionalFixedProperties' => '<string>',
'id' => '<string>', // REQUIRED
'name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'additionalFixedProperties' => '<string>',
'arn' => '<string>',
'id' => '<string>',
'name' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing additional fixed properties regarding the worker fleet
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- id
-
- Required: Yes
- Type: string
Filters access by the worker fleet's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
Errors
-
User does not have sufficient access to perform this action.
-
Exception thrown if an invalid parameter is provided to an API.
-
Exception thrown if a resource referenced in the request doesn't exist.
-
Exception thrown if the api has been called too quickly be the client.
-
Exception thrown if something goes wrong within the service.
Shapes
AccessDeniedException
Description
User does not have sufficient access to perform this action.
Members
CartesianCoordinates
Description
Cartesian coordinates in 3D space relative to the RoboRunner origin.
Members
ConflictException
Description
Exception thrown if a resource in a create request already exists.
Members
Destination
Description
Area within a facility where work can be performed.
Members
- additionalFixedProperties
-
- Type: string
JSON document containing additional fixed properties regarding the destination
- arn
-
- Required: Yes
- Type: string
Destination ARN.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the destination's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- site
-
- Required: Yes
- Type: string
Site ARN.
- state
-
- Required: Yes
- Type: string
State of the destination.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
InternalServerException
Description
Exception thrown if something goes wrong within the service.
Members
Orientation
Description
Worker orientation measured in units clockwise from north.
Members
PositionCoordinates
Description
Supported coordinates for worker position.
Members
- cartesianCoordinates
-
- Type: CartesianCoordinates structure
Cartesian coordinates.
ResourceNotFoundException
Description
Exception thrown if a resource referenced in the request doesn't exist.
Members
ServiceQuotaExceededException
Description
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
Members
Site
Description
Facility containing destinations, workers, activities, and tasks.
Members
- arn
-
- Required: Yes
- Type: string
Site ARN.
- countryCode
-
- Required: Yes
- Type: string
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- name
-
- Required: Yes
- Type: string
The name of the site. Mutable after creation and unique within a given account.
ThrottlingException
Description
Exception thrown if the api has been called too quickly be the client.
Members
ValidationException
Description
Exception thrown if an invalid parameter is provided to an API.
Members
VendorProperties
Description
Properties of the worker that are provided by the vendor FMS.
Members
- vendorAdditionalFixedProperties
-
- Type: string
JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.
- vendorAdditionalTransientProperties
-
- Type: string
JSON blob containing unstructured vendor properties that are transient and may change during regular operation.
- vendorWorkerId
-
- Required: Yes
- Type: string
The worker ID defined by the vendor FMS.
- vendorWorkerIpAddress
-
- Type: string
The worker IP address defined by the vendor FMS.
Worker
Description
A unit capable of performing tasks.
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
- additionalTransientProperties
-
- Type: string
JSON blob containing unstructured worker properties that are transient and may change during regular operation.
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- fleet
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- id
-
- Required: Yes
- Type: string
Filters access by the workers identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- orientation
-
- Type: Orientation structure
Worker orientation measured in units clockwise from north.
- position
-
- Type: PositionCoordinates structure
Supported coordinates for worker position.
- site
-
- Required: Yes
- Type: string
Site ARN.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.
- vendorProperties
-
- Type: VendorProperties structure
Properties of the worker that are provided by the vendor FMS.
WorkerFleet
Description
A collection of workers organized within a facility.
Members
- additionalFixedProperties
-
- Type: string
JSON blob containing additional fixed properties regarding the worker fleet
- arn
-
- Required: Yes
- Type: string
Full ARN of the worker fleet.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was created.
- id
-
- Required: Yes
- Type: string
Filters access by the worker fleet's identifier
- name
-
- Required: Yes
- Type: string
Human friendly name of the resource.
- site
-
- Required: Yes
- Type: string
Site ARN.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Timestamp at which the resource was last updated.