| 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 |
Amazonka.IoTRoboRunner.Types
Description
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
- newtype DestinationState where
- DestinationState' { }
- pattern DestinationState_DECOMMISSIONED :: DestinationState
- pattern DestinationState_DISABLED :: DestinationState
- pattern DestinationState_ENABLED :: DestinationState
- data CartesianCoordinates = CartesianCoordinates' {}
- newCartesianCoordinates :: Double -> Double -> CartesianCoordinates
- cartesianCoordinates_z :: Lens' CartesianCoordinates (Maybe Double)
- cartesianCoordinates_x :: Lens' CartesianCoordinates Double
- cartesianCoordinates_y :: Lens' CartesianCoordinates Double
- data Destination = Destination' {}
- newDestination :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DestinationState -> Destination
- destination_additionalFixedProperties :: Lens' Destination (Maybe Text)
- destination_arn :: Lens' Destination Text
- destination_id :: Lens' Destination Text
- destination_name :: Lens' Destination Text
- destination_site :: Lens' Destination Text
- destination_createdAt :: Lens' Destination UTCTime
- destination_updatedAt :: Lens' Destination UTCTime
- destination_state :: Lens' Destination DestinationState
- data Orientation = Orientation' {}
- newOrientation :: Orientation
- orientation_degrees :: Lens' Orientation (Maybe Double)
- data PositionCoordinates = PositionCoordinates' {}
- newPositionCoordinates :: PositionCoordinates
- positionCoordinates_cartesianCoordinates :: Lens' PositionCoordinates (Maybe CartesianCoordinates)
- data Site = Site' {}
- newSite :: Text -> Text -> Text -> UTCTime -> Site
- site_arn :: Lens' Site Text
- site_name :: Lens' Site Text
- site_countryCode :: Lens' Site Text
- site_createdAt :: Lens' Site UTCTime
- data VendorProperties = VendorProperties' {}
- newVendorProperties :: Text -> VendorProperties
- vendorProperties_vendorAdditionalFixedProperties :: Lens' VendorProperties (Maybe Text)
- vendorProperties_vendorAdditionalTransientProperties :: Lens' VendorProperties (Maybe Text)
- vendorProperties_vendorWorkerIpAddress :: Lens' VendorProperties (Maybe Text)
- vendorProperties_vendorWorkerId :: Lens' VendorProperties Text
- data Worker = Worker' {}
- newWorker :: Text -> Text -> Text -> UTCTime -> UTCTime -> Text -> Text -> Worker
- worker_additionalFixedProperties :: Lens' Worker (Maybe Text)
- worker_additionalTransientProperties :: Lens' Worker (Maybe Text)
- worker_orientation :: Lens' Worker (Maybe Orientation)
- worker_position :: Lens' Worker (Maybe PositionCoordinates)
- worker_vendorProperties :: Lens' Worker (Maybe VendorProperties)
- worker_arn :: Lens' Worker Text
- worker_id :: Lens' Worker Text
- worker_fleet :: Lens' Worker Text
- worker_createdAt :: Lens' Worker UTCTime
- worker_updatedAt :: Lens' Worker UTCTime
- worker_name :: Lens' Worker Text
- worker_site :: Lens' Worker Text
- data WorkerFleet = WorkerFleet' {}
- newWorkerFleet :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> WorkerFleet
- workerFleet_additionalFixedProperties :: Lens' WorkerFleet (Maybe Text)
- workerFleet_arn :: Lens' WorkerFleet Text
- workerFleet_id :: Lens' WorkerFleet Text
- workerFleet_name :: Lens' WorkerFleet Text
- workerFleet_site :: Lens' WorkerFleet Text
- workerFleet_createdAt :: Lens' WorkerFleet UTCTime
- workerFleet_updatedAt :: Lens' WorkerFleet UTCTime
Service Configuration
defaultService :: Service Source #
API version 2018-05-10 of the Amazon IoT RoboRunner SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
User does not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
Exception thrown if a resource in a create request already exists.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Exception thrown if something goes wrong within the service.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Exception thrown if a resource referenced in the request doesn't exist.
_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 :: AsError a => Fold a ServiceError Source #
Exception thrown if the api has been called too quickly be the client.
_ValidationException :: AsError a => Fold a ServiceError Source #
Exception thrown if an invalid parameter is provided to an API.
DestinationState
newtype DestinationState Source #
State of the destination.
Constructors
| DestinationState' | |
Fields | |
Bundled Patterns
| 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.
Constructors
| CartesianCoordinates' | |
Instances
newCartesianCoordinates Source #
Arguments
| :: Double | |
| -> Double | |
| -> CartesianCoordinates |
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.
cartesianCoordinates_z :: Lens' CartesianCoordinates (Maybe Double) Source #
Z coordinate.
cartesianCoordinates_x :: Lens' CartesianCoordinates Double Source #
X coordinate.
cartesianCoordinates_y :: Lens' CartesianCoordinates Double Source #
Y coordinate.
Destination
data Destination Source #
Area within a facility where work can be performed.
See: newDestination smart constructor.
Constructors
| Destination' | |
Instances
Arguments
| :: 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.
destination_additionalFixedProperties :: Lens' Destination (Maybe Text) Source #
Undocumented member.
destination_arn :: Lens' Destination Text Source #
Undocumented member.
destination_id :: Lens' Destination Text Source #
Undocumented member.
destination_name :: Lens' Destination Text Source #
Undocumented member.
destination_site :: Lens' Destination Text Source #
Undocumented member.
destination_createdAt :: Lens' Destination UTCTime Source #
Undocumented member.
destination_updatedAt :: Lens' Destination UTCTime Source #
Undocumented member.
destination_state :: Lens' Destination DestinationState Source #
Undocumented member.
Orientation
data Orientation Source #
Worker orientation measured in units clockwise from north.
See: newOrientation smart constructor.
Constructors
| Orientation' | |
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)
orientation_degrees :: Lens' Orientation (Maybe Double) Source #
Degrees, limited on [0, 360)
PositionCoordinates
data PositionCoordinates Source #
Supported coordinates for worker position.
See: newPositionCoordinates smart constructor.
Constructors
| PositionCoordinates' | |
Fields
| |
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.
positionCoordinates_cartesianCoordinates :: Lens' PositionCoordinates (Maybe CartesianCoordinates) Source #
Cartesian coordinates.
Site
Facility containing destinations, workers, activities, and tasks.
See: newSite smart constructor.
Constructors
| Site' | |
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.
site_name :: Lens' Site Text Source #
The name of the site. Mutable after creation and unique within a given account.
VendorProperties
data VendorProperties Source #
Properties of the worker that are provided by the vendor FMS.
See: newVendorProperties smart constructor.
Constructors
| VendorProperties' | |
Instances
Arguments
| :: Text | |
| -> VendorProperties |
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.
vendorProperties_vendorAdditionalFixedProperties :: Lens' VendorProperties (Maybe Text) Source #
Undocumented member.
vendorProperties_vendorAdditionalTransientProperties :: Lens' VendorProperties (Maybe Text) Source #
Undocumented member.
vendorProperties_vendorWorkerIpAddress :: Lens' VendorProperties (Maybe Text) Source #
Undocumented member.
vendorProperties_vendorWorkerId :: Lens' VendorProperties Text Source #
Undocumented member.
Worker
A unit capable of performing tasks.
See: newWorker smart constructor.
Constructors
| Worker' | |
Fields
| |
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.
worker_orientation :: Lens' Worker (Maybe Orientation) Source #
Undocumented member.
worker_position :: Lens' Worker (Maybe PositionCoordinates) Source #
Undocumented member.
worker_vendorProperties :: Lens' Worker (Maybe VendorProperties) Source #
Undocumented member.
WorkerFleet
data WorkerFleet Source #
A collection of workers organized within a facility.
See: newWorkerFleet smart constructor.
Constructors
| WorkerFleet' | |
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.
workerFleet_additionalFixedProperties :: Lens' WorkerFleet (Maybe Text) Source #
Undocumented member.
workerFleet_arn :: Lens' WorkerFleet Text Source #
Undocumented member.
workerFleet_id :: Lens' WorkerFleet Text Source #
Undocumented member.
workerFleet_name :: Lens' WorkerFleet Text Source #
Undocumented member.
workerFleet_site :: Lens' WorkerFleet Text Source #
Undocumented member.
workerFleet_createdAt :: Lens' WorkerFleet UTCTime Source #
Undocumented member.
workerFleet_updatedAt :: Lens' WorkerFleet UTCTime Source #
Undocumented member.