Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateDestination
- CreateSite
- CreateWorker
- CreateWorkerFleet
- DeleteDestination
- DeleteSite
- DeleteWorker
- DeleteWorkerFleet
- GetDestination
- GetSite
- GetWorker
- GetWorkerFleet
- ListDestinations (Paginated)
- ListSites (Paginated)
- ListWorkerFleets (Paginated)
- ListWorkers (Paginated)
- UpdateDestination
- UpdateSite
- UpdateWorker
- UpdateWorkerFleet
- Types
Derived from API version 2018-05-10
of the AWS service descriptions, licensed under Apache 2.0.
An example service, deployed with the Octane Service creator, which will echo the string
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateDestination = CreateDestination' (Maybe Text) (Maybe Text) (Maybe DestinationState) Text Text
- newCreateDestination :: Text -> Text -> CreateDestination
- data CreateDestinationResponse = CreateDestinationResponse' Int Text Text POSIX POSIX DestinationState
- newCreateDestinationResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> DestinationState -> CreateDestinationResponse
- data CreateSite = CreateSite' (Maybe Text) (Maybe Text) Text Text
- newCreateSite :: Text -> Text -> CreateSite
- data CreateSiteResponse = CreateSiteResponse' Int Text Text POSIX POSIX
- newCreateSiteResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> CreateSiteResponse
- data CreateWorker = CreateWorker' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Text Text
- newCreateWorker :: Text -> Text -> CreateWorker
- data CreateWorkerResponse = CreateWorkerResponse' Int Text Text POSIX POSIX Text
- newCreateWorkerResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> Text -> CreateWorkerResponse
- data CreateWorkerFleet = CreateWorkerFleet' (Maybe Text) (Maybe Text) Text Text
- newCreateWorkerFleet :: Text -> Text -> CreateWorkerFleet
- data CreateWorkerFleetResponse = CreateWorkerFleetResponse' Int Text Text POSIX POSIX
- newCreateWorkerFleetResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> CreateWorkerFleetResponse
- data DeleteDestination = DeleteDestination' Text
- newDeleteDestination :: Text -> DeleteDestination
- data DeleteDestinationResponse = DeleteDestinationResponse' Int
- newDeleteDestinationResponse :: Int -> DeleteDestinationResponse
- data DeleteSite = DeleteSite' Text
- newDeleteSite :: Text -> DeleteSite
- data DeleteSiteResponse = DeleteSiteResponse' Int
- newDeleteSiteResponse :: Int -> DeleteSiteResponse
- data DeleteWorker = DeleteWorker' Text
- newDeleteWorker :: Text -> DeleteWorker
- data DeleteWorkerResponse = DeleteWorkerResponse' Int
- newDeleteWorkerResponse :: Int -> DeleteWorkerResponse
- data DeleteWorkerFleet = DeleteWorkerFleet' Text
- newDeleteWorkerFleet :: Text -> DeleteWorkerFleet
- data DeleteWorkerFleetResponse = DeleteWorkerFleetResponse' Int
- newDeleteWorkerFleetResponse :: Int -> DeleteWorkerFleetResponse
- data GetDestination = GetDestination' Text
- newGetDestination :: Text -> GetDestination
- data GetDestinationResponse = GetDestinationResponse' (Maybe Text) Int Text Text Text Text POSIX POSIX DestinationState
- newGetDestinationResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DestinationState -> GetDestinationResponse
- data GetSite = GetSite' Text
- newGetSite :: Text -> GetSite
- data GetSiteResponse = GetSiteResponse' (Maybe Text) Int Text Text Text Text POSIX POSIX
- newGetSiteResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> GetSiteResponse
- data GetWorker = GetWorker' Text
- newGetWorker :: Text -> GetWorker
- data GetWorkerResponse = GetWorkerResponse' (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Int Text Text Text Text POSIX POSIX Text
- newGetWorkerResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> Text -> GetWorkerResponse
- data GetWorkerFleet = GetWorkerFleet' Text
- newGetWorkerFleet :: Text -> GetWorkerFleet
- data GetWorkerFleetResponse = GetWorkerFleetResponse' (Maybe Text) Int Text Text Text Text POSIX POSIX
- newGetWorkerFleetResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> GetWorkerFleetResponse
- data ListDestinations = ListDestinations' (Maybe Natural) (Maybe Text) (Maybe DestinationState) Text
- newListDestinations :: Text -> ListDestinations
- data ListDestinationsResponse = ListDestinationsResponse' (Maybe [Destination]) (Maybe Text) Int
- newListDestinationsResponse :: Int -> ListDestinationsResponse
- data ListSites = ListSites' (Maybe Natural) (Maybe Text)
- newListSites :: ListSites
- data ListSitesResponse = ListSitesResponse' (Maybe Text) (Maybe [Site]) Int
- newListSitesResponse :: Int -> ListSitesResponse
- data ListWorkerFleets = ListWorkerFleets' (Maybe Natural) (Maybe Text) Text
- newListWorkerFleets :: Text -> ListWorkerFleets
- data ListWorkerFleetsResponse = ListWorkerFleetsResponse' (Maybe Text) (Maybe [WorkerFleet]) Int
- newListWorkerFleetsResponse :: Int -> ListWorkerFleetsResponse
- data ListWorkers = ListWorkers' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newListWorkers :: Text -> ListWorkers
- data ListWorkersResponse = ListWorkersResponse' (Maybe Text) (Maybe [Worker]) Int
- newListWorkersResponse :: Int -> ListWorkersResponse
- data UpdateDestination = UpdateDestination' (Maybe Text) (Maybe Text) (Maybe DestinationState) Text
- newUpdateDestination :: Text -> UpdateDestination
- data UpdateDestinationResponse = UpdateDestinationResponse' (Maybe Text) Int Text Text Text POSIX DestinationState
- newUpdateDestinationResponse :: Int -> Text -> Text -> Text -> UTCTime -> DestinationState -> UpdateDestinationResponse
- data UpdateSite = UpdateSite' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateSite :: Text -> UpdateSite
- data UpdateSiteResponse = UpdateSiteResponse' (Maybe Text) (Maybe Text) Int Text Text Text POSIX
- newUpdateSiteResponse :: Int -> Text -> Text -> Text -> UTCTime -> UpdateSiteResponse
- data UpdateWorker = UpdateWorker' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Text
- newUpdateWorker :: Text -> UpdateWorker
- data UpdateWorkerResponse = UpdateWorkerResponse' (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Int Text Text Text POSIX Text
- newUpdateWorkerResponse :: Int -> Text -> Text -> Text -> UTCTime -> Text -> UpdateWorkerResponse
- data UpdateWorkerFleet = UpdateWorkerFleet' (Maybe Text) (Maybe Text) Text
- newUpdateWorkerFleet :: Text -> UpdateWorkerFleet
- data UpdateWorkerFleetResponse = UpdateWorkerFleetResponse' (Maybe Text) Int Text Text Text POSIX
- newUpdateWorkerFleetResponse :: Int -> Text -> Text -> Text -> UTCTime -> UpdateWorkerFleetResponse
- newtype DestinationState where
- DestinationState' { }
- pattern DestinationState_DECOMMISSIONED :: DestinationState
- pattern DestinationState_DISABLED :: DestinationState
- pattern DestinationState_ENABLED :: DestinationState
- data CartesianCoordinates = CartesianCoordinates' (Maybe Double) Double Double
- newCartesianCoordinates :: Double -> Double -> CartesianCoordinates
- data Destination = Destination' (Maybe Text) Text Text Text Text POSIX POSIX DestinationState
- newDestination :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DestinationState -> Destination
- data Orientation = Orientation' (Maybe Double)
- newOrientation :: Orientation
- data PositionCoordinates = PositionCoordinates' (Maybe CartesianCoordinates)
- newPositionCoordinates :: PositionCoordinates
- data Site = Site' Text Text Text POSIX
- newSite :: Text -> Text -> Text -> UTCTime -> Site
- data VendorProperties = VendorProperties' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newVendorProperties :: Text -> VendorProperties
- data Worker = Worker' (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Text Text Text POSIX POSIX Text Text
- newWorker :: Text -> Text -> Text -> UTCTime -> UTCTime -> Text -> Text -> Worker
- data WorkerFleet = WorkerFleet' (Maybe Text) Text Text Text Text POSIX POSIX
- newWorkerFleet :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> WorkerFleet
Service Configuration
defaultService :: Service Source #
API version 2018-05-10
of the Amazon IoT RoboRunner SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTRoboRunner
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
User does not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Exception thrown if a resource in a create request already exists.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Exception thrown if something goes wrong within the service.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Exception thrown if a resource referenced in the request doesn't exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Exception thrown if the api has been called too quickly be the client.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Exception thrown if an invalid parameter is provided to an API.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateDestination
data CreateDestination Source #
See: newCreateDestination
smart constructor.
Instances
Create a value of CreateDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDestination
, createDestination_additionalFixedProperties
- Undocumented member.
$sel:clientToken:CreateDestination'
, createDestination_clientToken
- Undocumented member.
CreateDestination
, createDestination_state
- The state of the destination. Default used if not specified.
CreateDestination
, createDestination_name
- Undocumented member.
CreateDestination
, createDestination_site
- Undocumented member.
data CreateDestinationResponse Source #
See: newCreateDestinationResponse
smart constructor.
Instances
newCreateDestinationResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> DestinationState | |
-> CreateDestinationResponse |
Create a value of CreateDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateDestinationResponse'
, createDestinationResponse_httpStatus
- The response's http status code.
CreateDestinationResponse
, createDestinationResponse_arn
- Undocumented member.
CreateDestinationResponse
, createDestinationResponse_id
- Undocumented member.
CreateDestinationResponse
, createDestinationResponse_createdAt
- Undocumented member.
CreateDestinationResponse
, createDestinationResponse_updatedAt
- Undocumented member.
CreateDestination
, createDestinationResponse_state
- Undocumented member.
CreateSite
data CreateSite Source #
See: newCreateSite
smart constructor.
Instances
Create a value of CreateSite
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateSite'
, createSite_clientToken
- Undocumented member.
$sel:description:CreateSite'
, createSite_description
- Undocumented member.
CreateSite
, createSite_name
- Undocumented member.
CreateSite
, createSite_countryCode
- Undocumented member.
data CreateSiteResponse Source #
See: newCreateSiteResponse
smart constructor.
Instances
newCreateSiteResponse Source #
Create a value of CreateSiteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateSiteResponse'
, createSiteResponse_httpStatus
- The response's http status code.
CreateSiteResponse
, createSiteResponse_arn
- Undocumented member.
CreateSiteResponse
, createSiteResponse_id
- Undocumented member.
CreateSiteResponse
, createSiteResponse_createdAt
- Undocumented member.
CreateSiteResponse
, createSiteResponse_updatedAt
- Undocumented member.
CreateWorker
data CreateWorker Source #
See: newCreateWorker
smart constructor.
CreateWorker' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Text Text |
Instances
Create a value of CreateWorker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorker
, createWorker_additionalFixedProperties
- Undocumented member.
CreateWorker
, createWorker_additionalTransientProperties
- Undocumented member.
$sel:clientToken:CreateWorker'
, createWorker_clientToken
- Undocumented member.
CreateWorker
, createWorker_orientation
- Undocumented member.
CreateWorker
, createWorker_position
- Undocumented member.
CreateWorker
, createWorker_vendorProperties
- Undocumented member.
CreateWorker
, createWorker_name
- Undocumented member.
CreateWorker
, createWorker_fleet
- Undocumented member.
data CreateWorkerResponse Source #
See: newCreateWorkerResponse
smart constructor.
Instances
newCreateWorkerResponse Source #
Create a value of CreateWorkerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWorkerResponse'
, createWorkerResponse_httpStatus
- The response's http status code.
CreateWorkerResponse
, createWorkerResponse_arn
- Undocumented member.
CreateWorkerResponse
, createWorkerResponse_id
- Undocumented member.
CreateWorkerResponse
, createWorkerResponse_createdAt
- Undocumented member.
CreateWorkerResponse
, createWorkerResponse_updatedAt
- Undocumented member.
CreateWorkerResponse
, createWorkerResponse_site
- Undocumented member.
CreateWorkerFleet
data CreateWorkerFleet Source #
See: newCreateWorkerFleet
smart constructor.
Instances
Create a value of CreateWorkerFleet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorkerFleet
, createWorkerFleet_additionalFixedProperties
- Undocumented member.
$sel:clientToken:CreateWorkerFleet'
, createWorkerFleet_clientToken
- Undocumented member.
CreateWorkerFleet
, createWorkerFleet_name
- Undocumented member.
CreateWorkerFleet
, createWorkerFleet_site
- Undocumented member.
data CreateWorkerFleetResponse Source #
See: newCreateWorkerFleetResponse
smart constructor.
Instances
newCreateWorkerFleetResponse Source #
Create a value of CreateWorkerFleetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWorkerFleetResponse'
, createWorkerFleetResponse_httpStatus
- The response's http status code.
CreateWorkerFleetResponse
, createWorkerFleetResponse_arn
- Undocumented member.
CreateWorkerFleetResponse
, createWorkerFleetResponse_id
- Undocumented member.
CreateWorkerFleetResponse
, createWorkerFleetResponse_createdAt
- Undocumented member.
CreateWorkerFleetResponse
, createWorkerFleetResponse_updatedAt
- Undocumented member.
DeleteDestination
data DeleteDestination Source #
See: newDeleteDestination
smart constructor.
Instances
Create a value of DeleteDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDestination
, deleteDestination_id
- Undocumented member.
data DeleteDestinationResponse Source #
See: newDeleteDestinationResponse
smart constructor.
Instances
newDeleteDestinationResponse Source #
Create a value of DeleteDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDestinationResponse'
, deleteDestinationResponse_httpStatus
- The response's http status code.
DeleteSite
data DeleteSite Source #
See: newDeleteSite
smart constructor.
Instances
:: Text | |
-> DeleteSite |
Create a value of DeleteSite
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSite
, deleteSite_id
- Undocumented member.
data DeleteSiteResponse Source #
See: newDeleteSiteResponse
smart constructor.
Instances
newDeleteSiteResponse Source #
Create a value of DeleteSiteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSiteResponse'
, deleteSiteResponse_httpStatus
- The response's http status code.
DeleteWorker
data DeleteWorker Source #
See: newDeleteWorker
smart constructor.
Instances
Create a value of DeleteWorker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorker
, deleteWorker_id
- Undocumented member.
data DeleteWorkerResponse Source #
See: newDeleteWorkerResponse
smart constructor.
Instances
newDeleteWorkerResponse Source #
Create a value of DeleteWorkerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWorkerResponse'
, deleteWorkerResponse_httpStatus
- The response's http status code.
DeleteWorkerFleet
data DeleteWorkerFleet Source #
See: newDeleteWorkerFleet
smart constructor.
Instances
Create a value of DeleteWorkerFleet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorkerFleet
, deleteWorkerFleet_id
- Undocumented member.
data DeleteWorkerFleetResponse Source #
See: newDeleteWorkerFleetResponse
smart constructor.
Instances
newDeleteWorkerFleetResponse Source #
Create a value of DeleteWorkerFleetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWorkerFleetResponse'
, deleteWorkerFleetResponse_httpStatus
- The response's http status code.
GetDestination
data GetDestination Source #
See: newGetDestination
smart constructor.
Instances
Create a value of GetDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDestination
, getDestination_id
- Undocumented member.
data GetDestinationResponse Source #
See: newGetDestinationResponse
smart constructor.
Instances
newGetDestinationResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> DestinationState | |
-> GetDestinationResponse |
Create a value of GetDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDestinationResponse
, getDestinationResponse_additionalFixedProperties
- Undocumented member.
$sel:httpStatus:GetDestinationResponse'
, getDestinationResponse_httpStatus
- The response's http status code.
GetDestinationResponse
, getDestinationResponse_arn
- Undocumented member.
GetDestination
, getDestinationResponse_id
- Undocumented member.
GetDestinationResponse
, getDestinationResponse_name
- Undocumented member.
GetDestinationResponse
, getDestinationResponse_site
- Undocumented member.
GetDestinationResponse
, getDestinationResponse_createdAt
- Undocumented member.
GetDestinationResponse
, getDestinationResponse_updatedAt
- Undocumented member.
GetDestinationResponse
, getDestinationResponse_state
- Undocumented member.
GetSite
See: newGetSite
smart constructor.
Instances
ToHeaders GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite | |
ToPath GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite toPath :: GetSite -> ByteString # | |
ToQuery GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite toQuery :: GetSite -> QueryString # | |
AWSRequest GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite type AWSResponse GetSite # request :: (Service -> Service) -> GetSite -> Request GetSite # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSite -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSite))) # | |
Generic GetSite Source # | |
Read GetSite Source # | |
Show GetSite Source # | |
NFData GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite | |
Eq GetSite Source # | |
Hashable GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite | |
type AWSResponse GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite | |
type Rep GetSite Source # | |
Defined in Amazonka.IoTRoboRunner.GetSite |
Create a value of GetSite
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSite
, getSite_id
- Undocumented member.
data GetSiteResponse Source #
See: newGetSiteResponse
smart constructor.
Instances
Create a value of GetSiteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:GetSiteResponse'
, getSiteResponse_description
- Undocumented member.
$sel:httpStatus:GetSiteResponse'
, getSiteResponse_httpStatus
- The response's http status code.
GetSiteResponse
, getSiteResponse_arn
- Undocumented member.
GetSite
, getSiteResponse_id
- Undocumented member.
GetSiteResponse
, getSiteResponse_name
- Undocumented member.
GetSiteResponse
, getSiteResponse_countryCode
- Undocumented member.
GetSiteResponse
, getSiteResponse_createdAt
- Undocumented member.
GetSiteResponse
, getSiteResponse_updatedAt
- Undocumented member.
GetWorker
See: newGetWorker
smart constructor.
Instances
Create a value of GetWorker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorker
, getWorker_id
- Undocumented member.
data GetWorkerResponse Source #
See: newGetWorkerResponse
smart constructor.
GetWorkerResponse' (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Int Text Text Text Text POSIX POSIX Text |
Instances
Create a value of GetWorkerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorkerResponse
, getWorkerResponse_additionalFixedProperties
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_additionalTransientProperties
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_orientation
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_position
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_vendorProperties
- Undocumented member.
$sel:httpStatus:GetWorkerResponse'
, getWorkerResponse_httpStatus
- The response's http status code.
GetWorkerResponse
, getWorkerResponse_arn
- Undocumented member.
GetWorker
, getWorkerResponse_id
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_fleet
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_site
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_createdAt
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_updatedAt
- Undocumented member.
GetWorkerResponse
, getWorkerResponse_name
- Undocumented member.
GetWorkerFleet
data GetWorkerFleet Source #
See: newGetWorkerFleet
smart constructor.
Instances
Create a value of GetWorkerFleet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorkerFleet
, getWorkerFleet_id
- Undocumented member.
data GetWorkerFleetResponse Source #
See: newGetWorkerFleetResponse
smart constructor.
Instances
newGetWorkerFleetResponse Source #
Create a value of GetWorkerFleetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWorkerFleetResponse
, getWorkerFleetResponse_additionalFixedProperties
- Undocumented member.
$sel:httpStatus:GetWorkerFleetResponse'
, getWorkerFleetResponse_httpStatus
- The response's http status code.
GetWorkerFleet
, getWorkerFleetResponse_id
- Undocumented member.
GetWorkerFleetResponse
, getWorkerFleetResponse_arn
- Undocumented member.
GetWorkerFleetResponse
, getWorkerFleetResponse_name
- Undocumented member.
GetWorkerFleetResponse
, getWorkerFleetResponse_site
- Undocumented member.
GetWorkerFleetResponse
, getWorkerFleetResponse_createdAt
- Undocumented member.
GetWorkerFleetResponse
, getWorkerFleetResponse_updatedAt
- Undocumented member.
ListDestinations (Paginated)
data ListDestinations Source #
See: newListDestinations
smart constructor.
Instances
Create a value of ListDestinations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDestinations'
, listDestinations_maxResults
- Undocumented member.
ListDestinations
, listDestinations_nextToken
- Undocumented member.
ListDestinations
, listDestinations_state
- Undocumented member.
ListDestinations
, listDestinations_site
- Undocumented member.
data ListDestinationsResponse Source #
See: newListDestinationsResponse
smart constructor.
Instances
newListDestinationsResponse Source #
Create a value of ListDestinationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinations:ListDestinationsResponse'
, listDestinationsResponse_destinations
- Undocumented member.
ListDestinations
, listDestinationsResponse_nextToken
- Undocumented member.
$sel:httpStatus:ListDestinationsResponse'
, listDestinationsResponse_httpStatus
- The response's http status code.
ListSites (Paginated)
See: newListSites
smart constructor.
ListSites' (Maybe Natural) (Maybe Text) |
Instances
newListSites :: ListSites Source #
Create a value of ListSites
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListSites'
, listSites_maxResults
- Undocumented member.
ListSites
, listSites_nextToken
- Undocumented member.
data ListSitesResponse Source #
See: newListSitesResponse
smart constructor.
Instances
Create a value of ListSitesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSites
, listSitesResponse_nextToken
- Undocumented member.
$sel:sites:ListSitesResponse'
, listSitesResponse_sites
- Undocumented member.
$sel:httpStatus:ListSitesResponse'
, listSitesResponse_httpStatus
- The response's http status code.
ListWorkerFleets (Paginated)
data ListWorkerFleets Source #
See: newListWorkerFleets
smart constructor.
Instances
Create a value of ListWorkerFleets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListWorkerFleets'
, listWorkerFleets_maxResults
- Undocumented member.
ListWorkerFleets
, listWorkerFleets_nextToken
- Undocumented member.
ListWorkerFleets
, listWorkerFleets_site
- Undocumented member.
data ListWorkerFleetsResponse Source #
See: newListWorkerFleetsResponse
smart constructor.
Instances
newListWorkerFleetsResponse Source #
Create a value of ListWorkerFleetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkerFleets
, listWorkerFleetsResponse_nextToken
- Undocumented member.
$sel:workerFleets:ListWorkerFleetsResponse'
, listWorkerFleetsResponse_workerFleets
- Undocumented member.
$sel:httpStatus:ListWorkerFleetsResponse'
, listWorkerFleetsResponse_httpStatus
- The response's http status code.
ListWorkers (Paginated)
data ListWorkers Source #
See: newListWorkers
smart constructor.
Instances
Create a value of ListWorkers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkers
, listWorkers_fleet
- Undocumented member.
$sel:maxResults:ListWorkers'
, listWorkers_maxResults
- Undocumented member.
ListWorkers
, listWorkers_nextToken
- Undocumented member.
ListWorkers
, listWorkers_site
- Undocumented member.
data ListWorkersResponse Source #
See: newListWorkersResponse
smart constructor.
Instances
newListWorkersResponse Source #
Create a value of ListWorkersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkers
, listWorkersResponse_nextToken
- Undocumented member.
$sel:workers:ListWorkersResponse'
, listWorkersResponse_workers
- Undocumented member.
$sel:httpStatus:ListWorkersResponse'
, listWorkersResponse_httpStatus
- The response's http status code.
UpdateDestination
data UpdateDestination Source #
See: newUpdateDestination
smart constructor.
Instances
Create a value of UpdateDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDestination
, updateDestination_additionalFixedProperties
- Undocumented member.
UpdateDestination
, updateDestination_name
- Undocumented member.
UpdateDestination
, updateDestination_state
- Undocumented member.
UpdateDestination
, updateDestination_id
- Undocumented member.
data UpdateDestinationResponse Source #
See: newUpdateDestinationResponse
smart constructor.
Instances
newUpdateDestinationResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> DestinationState | |
-> UpdateDestinationResponse |
Create a value of UpdateDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDestination
, updateDestinationResponse_additionalFixedProperties
- Undocumented member.
$sel:httpStatus:UpdateDestinationResponse'
, updateDestinationResponse_httpStatus
- The response's http status code.
UpdateDestinationResponse
, updateDestinationResponse_arn
- Undocumented member.
UpdateDestination
, updateDestinationResponse_id
- Undocumented member.
UpdateDestination
, updateDestinationResponse_name
- Undocumented member.
UpdateDestinationResponse
, updateDestinationResponse_updatedAt
- Undocumented member.
UpdateDestination
, updateDestinationResponse_state
- Undocumented member.
UpdateSite
data UpdateSite Source #
See: newUpdateSite
smart constructor.
Instances
:: Text | |
-> UpdateSite |
Create a value of UpdateSite
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSite
, updateSite_countryCode
- Undocumented member.
UpdateSite
, updateSite_description
- Undocumented member.
UpdateSite
, updateSite_name
- Undocumented member.
UpdateSite
, updateSite_id
- Undocumented member.
data UpdateSiteResponse Source #
See: newUpdateSiteResponse
smart constructor.
Instances
newUpdateSiteResponse Source #
Create a value of UpdateSiteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateSite
, updateSiteResponse_countryCode
- Undocumented member.
UpdateSite
, updateSiteResponse_description
- Undocumented member.
$sel:httpStatus:UpdateSiteResponse'
, updateSiteResponse_httpStatus
- The response's http status code.
UpdateSiteResponse
, updateSiteResponse_arn
- Undocumented member.
UpdateSite
, updateSiteResponse_id
- Undocumented member.
UpdateSite
, updateSiteResponse_name
- Undocumented member.
UpdateSiteResponse
, updateSiteResponse_updatedAt
- Undocumented member.
UpdateWorker
data UpdateWorker Source #
See: newUpdateWorker
smart constructor.
UpdateWorker' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Text |
Instances
Create a value of UpdateWorker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorker
, updateWorker_additionalFixedProperties
- Undocumented member.
UpdateWorker
, updateWorker_additionalTransientProperties
- Undocumented member.
UpdateWorker
, updateWorker_name
- Undocumented member.
UpdateWorker
, updateWorker_orientation
- Undocumented member.
UpdateWorker
, updateWorker_position
- Undocumented member.
UpdateWorker
, updateWorker_vendorProperties
- Undocumented member.
UpdateWorker
, updateWorker_id
- Undocumented member.
data UpdateWorkerResponse Source #
See: newUpdateWorkerResponse
smart constructor.
UpdateWorkerResponse' (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Int Text Text Text POSIX Text |
Instances
newUpdateWorkerResponse Source #
Create a value of UpdateWorkerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorker
, updateWorkerResponse_additionalFixedProperties
- Undocumented member.
UpdateWorker
, updateWorkerResponse_additionalTransientProperties
- Undocumented member.
UpdateWorker
, updateWorkerResponse_orientation
- Undocumented member.
UpdateWorker
, updateWorkerResponse_position
- Undocumented member.
UpdateWorker
, updateWorkerResponse_vendorProperties
- Undocumented member.
$sel:httpStatus:UpdateWorkerResponse'
, updateWorkerResponse_httpStatus
- The response's http status code.
UpdateWorkerResponse
, updateWorkerResponse_arn
- Undocumented member.
UpdateWorker
, updateWorkerResponse_id
- Undocumented member.
UpdateWorkerResponse
, updateWorkerResponse_fleet
- Undocumented member.
UpdateWorkerResponse
, updateWorkerResponse_updatedAt
- Undocumented member.
UpdateWorker
, updateWorkerResponse_name
- Undocumented member.
UpdateWorkerFleet
data UpdateWorkerFleet Source #
See: newUpdateWorkerFleet
smart constructor.
Instances
Create a value of UpdateWorkerFleet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorkerFleet
, updateWorkerFleet_additionalFixedProperties
- Undocumented member.
UpdateWorkerFleet
, updateWorkerFleet_name
- Undocumented member.
UpdateWorkerFleet
, updateWorkerFleet_id
- Undocumented member.
data UpdateWorkerFleetResponse Source #
See: newUpdateWorkerFleetResponse
smart constructor.
Instances
newUpdateWorkerFleetResponse Source #
Create a value of UpdateWorkerFleetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorkerFleet
, updateWorkerFleetResponse_additionalFixedProperties
- Undocumented member.
$sel:httpStatus:UpdateWorkerFleetResponse'
, updateWorkerFleetResponse_httpStatus
- The response's http status code.
UpdateWorkerFleetResponse
, updateWorkerFleetResponse_arn
- Undocumented member.
UpdateWorkerFleet
, updateWorkerFleetResponse_id
- Undocumented member.
UpdateWorkerFleet
, updateWorkerFleetResponse_name
- Undocumented member.
UpdateWorkerFleetResponse
, updateWorkerFleetResponse_updatedAt
- Undocumented member.
Types
DestinationState
newtype DestinationState Source #
State of the destination.
pattern DestinationState_DECOMMISSIONED :: DestinationState | |
pattern DestinationState_DISABLED :: DestinationState | |
pattern DestinationState_ENABLED :: DestinationState |
Instances
CartesianCoordinates
data CartesianCoordinates Source #
Cartesian coordinates in 3D space relative to the RoboRunner origin.
See: newCartesianCoordinates
smart constructor.
Instances
newCartesianCoordinates Source #
Create a value of CartesianCoordinates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:z:CartesianCoordinates'
, cartesianCoordinates_z
- Z coordinate.
$sel:x:CartesianCoordinates'
, cartesianCoordinates_x
- X coordinate.
$sel:y:CartesianCoordinates'
, cartesianCoordinates_y
- Y coordinate.
Destination
data Destination Source #
Area within a facility where work can be performed.
See: newDestination
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> DestinationState | |
-> Destination |
Create a value of Destination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalFixedProperties:Destination'
, destination_additionalFixedProperties
- Undocumented member.
$sel:arn:Destination'
, destination_arn
- Undocumented member.
$sel:id:Destination'
, destination_id
- Undocumented member.
$sel:name:Destination'
, destination_name
- Undocumented member.
$sel:site:Destination'
, destination_site
- Undocumented member.
$sel:createdAt:Destination'
, destination_createdAt
- Undocumented member.
$sel:updatedAt:Destination'
, destination_updatedAt
- Undocumented member.
$sel:state:Destination'
, destination_state
- Undocumented member.
Orientation
data Orientation Source #
Worker orientation measured in units clockwise from north.
See: newOrientation
smart constructor.
Instances
newOrientation :: Orientation Source #
Create a value of Orientation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:degrees:Orientation'
, orientation_degrees
- Degrees, limited on [0, 360)
PositionCoordinates
data PositionCoordinates Source #
Supported coordinates for worker position.
See: newPositionCoordinates
smart constructor.
Instances
newPositionCoordinates :: PositionCoordinates Source #
Create a value of PositionCoordinates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cartesianCoordinates:PositionCoordinates'
, positionCoordinates_cartesianCoordinates
- Cartesian coordinates.
Site
Facility containing destinations, workers, activities, and tasks.
See: newSite
smart constructor.
Instances
FromJSON Site Source # | |
Generic Site Source # | |
Read Site Source # | |
Show Site Source # | |
NFData Site Source # | |
Defined in Amazonka.IoTRoboRunner.Types.Site | |
Eq Site Source # | |
Hashable Site Source # | |
Defined in Amazonka.IoTRoboRunner.Types.Site | |
type Rep Site Source # | |
Defined in Amazonka.IoTRoboRunner.Types.Site type Rep Site = D1 ('MetaData "Site" "Amazonka.IoTRoboRunner.Types.Site" "amazonka-iot-roborunner-2.0-IPZyCSO3ncX78oczP456D6" 'False) (C1 ('MetaCons "Site'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "countryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))) |
Create a value of Site
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Site'
, site_arn
- Undocumented member.
$sel:name:Site'
, site_name
- The name of the site. Mutable after creation and unique within a given
account.
$sel:countryCode:Site'
, site_countryCode
- Undocumented member.
$sel:createdAt:Site'
, site_createdAt
- Undocumented member.
VendorProperties
data VendorProperties Source #
Properties of the worker that are provided by the vendor FMS.
See: newVendorProperties
smart constructor.
Instances
Create a value of VendorProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vendorAdditionalFixedProperties:VendorProperties'
, vendorProperties_vendorAdditionalFixedProperties
- Undocumented member.
$sel:vendorAdditionalTransientProperties:VendorProperties'
, vendorProperties_vendorAdditionalTransientProperties
- Undocumented member.
$sel:vendorWorkerIpAddress:VendorProperties'
, vendorProperties_vendorWorkerIpAddress
- Undocumented member.
$sel:vendorWorkerId:VendorProperties'
, vendorProperties_vendorWorkerId
- Undocumented member.
Worker
A unit capable of performing tasks.
See: newWorker
smart constructor.
Worker' (Maybe Text) (Maybe Text) (Maybe Orientation) (Maybe PositionCoordinates) (Maybe VendorProperties) Text Text Text POSIX POSIX Text Text |
Instances
Create a value of Worker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalFixedProperties:Worker'
, worker_additionalFixedProperties
- Undocumented member.
$sel:additionalTransientProperties:Worker'
, worker_additionalTransientProperties
- Undocumented member.
$sel:orientation:Worker'
, worker_orientation
- Undocumented member.
$sel:position:Worker'
, worker_position
- Undocumented member.
$sel:vendorProperties:Worker'
, worker_vendorProperties
- Undocumented member.
$sel:arn:Worker'
, worker_arn
- Undocumented member.
$sel:id:Worker'
, worker_id
- Undocumented member.
$sel:fleet:Worker'
, worker_fleet
- Undocumented member.
$sel:createdAt:Worker'
, worker_createdAt
- Undocumented member.
$sel:updatedAt:Worker'
, worker_updatedAt
- Undocumented member.
$sel:name:Worker'
, worker_name
- Undocumented member.
$sel:site:Worker'
, worker_site
- Undocumented member.
WorkerFleet
data WorkerFleet Source #
A collection of workers organized within a facility.
See: newWorkerFleet
smart constructor.
Instances
Create a value of WorkerFleet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalFixedProperties:WorkerFleet'
, workerFleet_additionalFixedProperties
- Undocumented member.
$sel:arn:WorkerFleet'
, workerFleet_arn
- Undocumented member.
$sel:id:WorkerFleet'
, workerFleet_id
- Undocumented member.
$sel:name:WorkerFleet'
, workerFleet_name
- Undocumented member.
$sel:site:WorkerFleet'
, workerFleet_site
- Undocumented member.
$sel:createdAt:WorkerFleet'
, workerFleet_createdAt
- Undocumented member.
$sel:updatedAt:WorkerFleet'
, workerFleet_updatedAt
- Undocumented member.