An example service, deployed with the Octane Service creator, which will echo the string
', 'operations' => [ 'CreateDestination' => 'Grants permission to create a destination
', 'CreateSite' => 'Grants permission to create a site
', 'CreateWorker' => 'Grants permission to create a worker
', 'CreateWorkerFleet' => 'Grants permission to create a worker fleet
', 'DeleteDestination' => 'Grants permission to delete a destination
', 'DeleteSite' => 'Grants permission to delete a site
', 'DeleteWorker' => 'Grants permission to delete a worker
', 'DeleteWorkerFleet' => 'Grants permission to delete a worker fleet
', 'GetDestination' => 'Grants permission to get a destination
', 'GetSite' => 'Grants permission to get a site
', 'GetWorker' => 'Grants permission to get a worker
', 'GetWorkerFleet' => 'Grants permission to get a worker fleet
', 'ListDestinations' => 'Grants permission to list destinations
', 'ListSites' => 'Grants permission to list sites
', 'ListWorkerFleets' => 'Grants permission to list worker fleets
', 'ListWorkers' => 'Grants permission to list workers
', 'UpdateDestination' => 'Grants permission to update a destination
', 'UpdateSite' => 'Grants permission to update a site
', 'UpdateWorker' => 'Grants permission to update a worker
', 'UpdateWorkerFleet' => 'Grants permission to update a worker fleet
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'User does not have sufficient access to perform this action.
', 'refs' => [], ], 'CartesianCoordinates' => [ 'base' => 'Cartesian coordinates in 3D space relative to the RoboRunner origin.
', 'refs' => [ 'PositionCoordinates$cartesianCoordinates' => 'Cartesian coordinates.
', ], ], 'ConflictException' => [ 'base' => 'Exception thrown if a resource in a create request already exists.
', 'refs' => [], ], 'CreateDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkerFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkerFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedAtTimestamp' => [ 'base' => 'Timestamp at which the resource was created.
', 'refs' => [ 'CreateDestinationResponse$createdAt' => NULL, 'CreateSiteResponse$createdAt' => NULL, 'CreateWorkerFleetResponse$createdAt' => NULL, 'CreateWorkerResponse$createdAt' => NULL, 'Destination$createdAt' => NULL, 'GetDestinationResponse$createdAt' => NULL, 'GetSiteResponse$createdAt' => NULL, 'GetWorkerFleetResponse$createdAt' => NULL, 'GetWorkerResponse$createdAt' => NULL, 'Site$createdAt' => NULL, 'Worker$createdAt' => NULL, 'WorkerFleet$createdAt' => NULL, ], ], 'DeleteDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkerFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkerFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkerResponse' => [ 'base' => NULL, 'refs' => [], ], 'Destination' => [ 'base' => 'Area within a facility where work can be performed.
', 'refs' => [ 'Destinations$member' => NULL, ], ], 'DestinationAdditionalFixedProperties' => [ 'base' => 'JSON document containing additional fixed properties regarding the destination
', 'refs' => [ 'CreateDestinationRequest$additionalFixedProperties' => NULL, 'Destination$additionalFixedProperties' => NULL, 'GetDestinationResponse$additionalFixedProperties' => NULL, 'UpdateDestinationRequest$additionalFixedProperties' => NULL, 'UpdateDestinationResponse$additionalFixedProperties' => NULL, ], ], 'DestinationArn' => [ 'base' => 'Destination ARN.
', 'refs' => [ 'CreateDestinationResponse$arn' => NULL, 'Destination$arn' => NULL, 'GetDestinationResponse$arn' => NULL, 'UpdateDestinationResponse$arn' => NULL, ], ], 'DestinationGenericIdentifier' => [ 'base' => 'Destination ARN.
', 'refs' => [ 'DeleteDestinationRequest$id' => NULL, 'GetDestinationRequest$id' => NULL, 'UpdateDestinationRequest$id' => NULL, ], ], 'DestinationId' => [ 'base' => 'Filters access by the destination\'s identifier
', 'refs' => [ 'CreateDestinationResponse$id' => NULL, 'Destination$id' => NULL, 'GetDestinationResponse$id' => NULL, 'UpdateDestinationResponse$id' => NULL, ], ], 'DestinationState' => [ 'base' => 'State of the destination.
', 'refs' => [ 'CreateDestinationRequest$state' => 'The state of the destination. Default used if not specified.
', 'CreateDestinationResponse$state' => NULL, 'Destination$state' => NULL, 'GetDestinationResponse$state' => NULL, 'ListDestinationsRequest$state' => NULL, 'UpdateDestinationRequest$state' => NULL, 'UpdateDestinationResponse$state' => NULL, ], ], 'Destinations' => [ 'base' => 'List of destinations.
', 'refs' => [ 'ListDestinationsResponse$destinations' => NULL, ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'CartesianCoordinates$x' => 'X coordinate.
', 'CartesianCoordinates$y' => 'Y coordinate.
', 'CartesianCoordinates$z' => 'Z coordinate.
', ], ], 'GetDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkerFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkerFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkerResponse' => [ 'base' => NULL, 'refs' => [], ], 'IdempotencyToken' => [ 'base' => 'Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
', 'refs' => [ 'CreateDestinationRequest$clientToken' => NULL, 'CreateSiteRequest$clientToken' => NULL, 'CreateWorkerFleetRequest$clientToken' => NULL, 'CreateWorkerRequest$clientToken' => NULL, ], ], 'InternalServerException' => [ 'base' => 'Exception thrown if something goes wrong within the service.
', 'refs' => [], ], 'ListDestinationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDestinationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListSitesPageSize' => [ 'base' => 'Maximum number of results to retrieve in a single ListSites call.
', 'refs' => [ 'ListSitesRequest$maxResults' => NULL, ], ], 'ListSitesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSitesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkerFleetsPageSize' => [ 'base' => 'Maximum number of results to retrieve in a single ListWorkerFleets call.
', 'refs' => [ 'ListWorkerFleetsRequest$maxResults' => NULL, ], ], 'ListWorkerFleetsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkerFleetsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkersPageSize' => [ 'base' => 'Maximum number of results to retrieve in a single ListWorkers call.
', 'refs' => [ 'ListWorkersRequest$maxResults' => NULL, ], ], 'ListWorkersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkersResponse' => [ 'base' => NULL, 'refs' => [], ], 'Name' => [ 'base' => 'Human friendly name of the resource.
', 'refs' => [ 'CreateDestinationRequest$name' => NULL, 'CreateSiteRequest$name' => NULL, 'CreateWorkerFleetRequest$name' => NULL, 'CreateWorkerRequest$name' => NULL, 'Destination$name' => NULL, 'GetDestinationResponse$name' => NULL, 'GetSiteResponse$name' => NULL, 'GetWorkerFleetResponse$name' => NULL, 'GetWorkerResponse$name' => NULL, 'Site$name' => 'The name of the site. Mutable after creation and unique within a given account.
', 'UpdateDestinationRequest$name' => NULL, 'UpdateDestinationResponse$name' => NULL, 'UpdateSiteRequest$name' => NULL, 'UpdateSiteResponse$name' => NULL, 'UpdateWorkerFleetRequest$name' => NULL, 'UpdateWorkerFleetResponse$name' => NULL, 'UpdateWorkerRequest$name' => NULL, 'UpdateWorkerResponse$name' => NULL, 'Worker$name' => NULL, 'WorkerFleet$name' => NULL, ], ], 'Orientation' => [ 'base' => 'Worker orientation measured in units clockwise from north.
', 'refs' => [ 'CreateWorkerRequest$orientation' => NULL, 'GetWorkerResponse$orientation' => NULL, 'UpdateWorkerRequest$orientation' => NULL, 'UpdateWorkerResponse$orientation' => NULL, 'Worker$orientation' => NULL, ], ], 'OrientationDegreesDouble' => [ 'base' => NULL, 'refs' => [ 'Orientation$degrees' => 'Degrees, limited on [0, 360)
', ], ], 'PageSize' => [ 'base' => 'Maximum number of results to retrieve in a single call.
', 'refs' => [ 'ListDestinationsRequest$maxResults' => NULL, ], ], 'PaginationToken' => [ 'base' => 'Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
', 'refs' => [ 'ListDestinationsRequest$nextToken' => NULL, 'ListDestinationsResponse$nextToken' => NULL, 'ListSitesRequest$nextToken' => NULL, 'ListSitesResponse$nextToken' => NULL, 'ListWorkerFleetsRequest$nextToken' => NULL, 'ListWorkerFleetsResponse$nextToken' => NULL, 'ListWorkersRequest$nextToken' => NULL, 'ListWorkersResponse$nextToken' => NULL, ], ], 'PositionCoordinates' => [ 'base' => 'Supported coordinates for worker position.
', 'refs' => [ 'CreateWorkerRequest$position' => NULL, 'GetWorkerResponse$position' => NULL, 'UpdateWorkerRequest$position' => NULL, 'UpdateWorkerResponse$position' => NULL, 'Worker$position' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => 'Exception thrown if a resource referenced in the request doesn\'t exist.
', 'refs' => [], ], 'ServiceQuotaExceededException' => [ 'base' => 'Exception thrown if the user\'s AWS account has reached a service limit and the operation cannot proceed.
', 'refs' => [], ], 'Site' => [ 'base' => 'Facility containing destinations, workers, activities, and tasks.
', 'refs' => [ 'Sites$member' => NULL, ], ], 'SiteArn' => [ 'base' => 'Site ARN.
', 'refs' => [ 'CreateSiteResponse$arn' => NULL, 'CreateWorkerResponse$site' => NULL, 'Destination$site' => NULL, 'GetDestinationResponse$site' => NULL, 'GetSiteResponse$arn' => NULL, 'GetWorkerFleetResponse$site' => NULL, 'GetWorkerResponse$site' => NULL, 'Site$arn' => NULL, 'UpdateSiteResponse$arn' => NULL, 'Worker$site' => NULL, 'WorkerFleet$site' => NULL, ], ], 'SiteCountryCode' => [ 'base' => 'A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
', 'refs' => [ 'CreateSiteRequest$countryCode' => NULL, 'GetSiteResponse$countryCode' => NULL, 'Site$countryCode' => NULL, 'UpdateSiteRequest$countryCode' => NULL, 'UpdateSiteResponse$countryCode' => NULL, ], ], 'SiteDescription' => [ 'base' => 'A high-level description of the site.
', 'refs' => [ 'CreateSiteRequest$description' => NULL, 'GetSiteResponse$description' => NULL, 'UpdateSiteRequest$description' => NULL, 'UpdateSiteResponse$description' => NULL, ], ], 'SiteGenericIdentifier' => [ 'base' => 'Site ARN.
', 'refs' => [ 'CreateDestinationRequest$site' => NULL, 'CreateWorkerFleetRequest$site' => NULL, 'DeleteSiteRequest$id' => NULL, 'GetSiteRequest$id' => NULL, 'ListDestinationsRequest$site' => NULL, 'ListWorkerFleetsRequest$site' => NULL, 'ListWorkersRequest$site' => NULL, 'UpdateSiteRequest$id' => NULL, ], ], 'SiteId' => [ 'base' => 'Filters access by the site\'s identifier
', 'refs' => [ 'CreateSiteResponse$id' => NULL, 'GetSiteResponse$id' => NULL, 'UpdateSiteResponse$id' => NULL, ], ], 'Sites' => [ 'base' => 'List of facilities.
', 'refs' => [ 'ListSitesResponse$sites' => NULL, ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'ThrottlingException' => [ 'base' => 'Exception thrown if the api has been called too quickly be the client.
', 'refs' => [], ], 'UpdateDestinationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDestinationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkerFleetRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkerFleetResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkerRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkerResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatedAtTimestamp' => [ 'base' => 'Timestamp at which the resource was last updated.
', 'refs' => [ 'CreateDestinationResponse$updatedAt' => NULL, 'CreateSiteResponse$updatedAt' => NULL, 'CreateWorkerFleetResponse$updatedAt' => NULL, 'CreateWorkerResponse$updatedAt' => NULL, 'Destination$updatedAt' => NULL, 'GetDestinationResponse$updatedAt' => NULL, 'GetSiteResponse$updatedAt' => NULL, 'GetWorkerFleetResponse$updatedAt' => NULL, 'GetWorkerResponse$updatedAt' => NULL, 'UpdateDestinationResponse$updatedAt' => NULL, 'UpdateSiteResponse$updatedAt' => NULL, 'UpdateWorkerFleetResponse$updatedAt' => NULL, 'UpdateWorkerResponse$updatedAt' => NULL, 'Worker$updatedAt' => NULL, 'WorkerFleet$updatedAt' => NULL, ], ], 'ValidationException' => [ 'base' => 'Exception thrown if an invalid parameter is provided to an API.
', 'refs' => [], ], 'VendorAdditionalFixedPropertiesJson' => [ 'base' => 'JSON blob containing unstructured vendor properties that are fixed and won\'t change during regular operation.
', 'refs' => [ 'VendorProperties$vendorAdditionalFixedProperties' => NULL, ], ], 'VendorAdditionalTransientPropertiesJson' => [ 'base' => 'JSON blob containing unstructured vendor properties that are transient and may change during regular operation.
', 'refs' => [ 'VendorProperties$vendorAdditionalTransientProperties' => NULL, ], ], 'VendorProperties' => [ 'base' => 'Properties of the worker that are provided by the vendor FMS.
', 'refs' => [ 'CreateWorkerRequest$vendorProperties' => NULL, 'GetWorkerResponse$vendorProperties' => NULL, 'UpdateWorkerRequest$vendorProperties' => NULL, 'UpdateWorkerResponse$vendorProperties' => NULL, 'Worker$vendorProperties' => NULL, ], ], 'VendorWorkerId' => [ 'base' => 'The worker ID defined by the vendor FMS.
', 'refs' => [ 'VendorProperties$vendorWorkerId' => NULL, ], ], 'VendorWorkerIpAddress' => [ 'base' => 'The worker IP address defined by the vendor FMS.
', 'refs' => [ 'VendorProperties$vendorWorkerIpAddress' => NULL, ], ], 'Worker' => [ 'base' => 'A unit capable of performing tasks.
', 'refs' => [ 'Workers$member' => NULL, ], ], 'WorkerAdditionalFixedPropertiesJson' => [ 'base' => 'JSON blob containing unstructured worker properties that are fixed and won\'t change during regular operation.
', 'refs' => [ 'CreateWorkerRequest$additionalFixedProperties' => NULL, 'GetWorkerResponse$additionalFixedProperties' => NULL, 'UpdateWorkerRequest$additionalFixedProperties' => NULL, 'UpdateWorkerResponse$additionalFixedProperties' => NULL, 'Worker$additionalFixedProperties' => NULL, ], ], 'WorkerAdditionalTransientPropertiesJson' => [ 'base' => 'JSON blob containing unstructured worker properties that are transient and may change during regular operation.
', 'refs' => [ 'CreateWorkerRequest$additionalTransientProperties' => NULL, 'GetWorkerResponse$additionalTransientProperties' => NULL, 'UpdateWorkerRequest$additionalTransientProperties' => NULL, 'UpdateWorkerResponse$additionalTransientProperties' => NULL, 'Worker$additionalTransientProperties' => NULL, ], ], 'WorkerArn' => [ 'base' => 'Full ARN of the worker.
', 'refs' => [ 'CreateWorkerResponse$arn' => NULL, 'GetWorkerResponse$arn' => NULL, 'UpdateWorkerResponse$arn' => NULL, 'Worker$arn' => NULL, ], ], 'WorkerFleet' => [ 'base' => 'A collection of workers organized within a facility.
', 'refs' => [ 'WorkerFleets$member' => NULL, ], ], 'WorkerFleetAdditionalFixedProperties' => [ 'base' => 'JSON blob containing additional fixed properties regarding the worker fleet
', 'refs' => [ 'CreateWorkerFleetRequest$additionalFixedProperties' => NULL, 'GetWorkerFleetResponse$additionalFixedProperties' => NULL, 'UpdateWorkerFleetRequest$additionalFixedProperties' => NULL, 'UpdateWorkerFleetResponse$additionalFixedProperties' => NULL, 'WorkerFleet$additionalFixedProperties' => NULL, ], ], 'WorkerFleetArn' => [ 'base' => 'Full ARN of the worker fleet.
', 'refs' => [ 'CreateWorkerFleetResponse$arn' => NULL, 'GetWorkerFleetResponse$arn' => NULL, 'GetWorkerResponse$fleet' => NULL, 'UpdateWorkerFleetResponse$arn' => NULL, 'UpdateWorkerResponse$fleet' => NULL, 'Worker$fleet' => NULL, 'WorkerFleet$arn' => NULL, ], ], 'WorkerFleetGenericIdentifier' => [ 'base' => 'Full ARN of the worker fleet.
', 'refs' => [ 'CreateWorkerRequest$fleet' => NULL, 'DeleteWorkerFleetRequest$id' => NULL, 'GetWorkerFleetRequest$id' => NULL, 'ListWorkersRequest$fleet' => NULL, 'UpdateWorkerFleetRequest$id' => NULL, ], ], 'WorkerFleetId' => [ 'base' => 'Filters access by the worker fleet\'s identifier
', 'refs' => [ 'CreateWorkerFleetResponse$id' => NULL, 'GetWorkerFleetResponse$id' => NULL, 'UpdateWorkerFleetResponse$id' => NULL, 'WorkerFleet$id' => NULL, ], ], 'WorkerFleets' => [ 'base' => 'List of worker fleets.
', 'refs' => [ 'ListWorkerFleetsResponse$workerFleets' => NULL, ], ], 'WorkerGenericIdentifier' => [ 'base' => 'Full ARN of the worker.
', 'refs' => [ 'DeleteWorkerRequest$id' => NULL, 'GetWorkerRequest$id' => NULL, 'UpdateWorkerRequest$id' => NULL, ], ], 'WorkerId' => [ 'base' => 'Filters access by the workers identifier
', 'refs' => [ 'CreateWorkerResponse$id' => NULL, 'GetWorkerResponse$id' => NULL, 'UpdateWorkerResponse$id' => NULL, 'Worker$id' => NULL, ], ], 'Workers' => [ 'base' => 'List of workers.
', 'refs' => [ 'ListWorkersResponse$workers' => NULL, ], ], ],];