Skip to content

Type definitions#

Index > IoTRoboRunner > Type definitions

Auto-generated documentation for IoTRoboRunner type annotations stubs module mypy-boto3-iot-roborunner.

CartesianCoordinatesTypeDef#

# CartesianCoordinatesTypeDef definition

class CartesianCoordinatesTypeDef(TypedDict):
    x: float,
    y: float,
    z: NotRequired[float],

CreateDestinationRequestRequestTypeDef#

# CreateDestinationRequestRequestTypeDef definition

class CreateDestinationRequestRequestTypeDef(TypedDict):
    name: str,
    site: str,
    clientToken: NotRequired[str],
    state: NotRequired[DestinationStateType],  # (1)
    additionalFixedProperties: NotRequired[str],
  1. See DestinationStateType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateSiteRequestRequestTypeDef#

# CreateSiteRequestRequestTypeDef definition

class CreateSiteRequestRequestTypeDef(TypedDict):
    name: str,
    countryCode: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],

CreateWorkerFleetRequestRequestTypeDef#

# CreateWorkerFleetRequestRequestTypeDef definition

class CreateWorkerFleetRequestRequestTypeDef(TypedDict):
    name: str,
    site: str,
    clientToken: NotRequired[str],
    additionalFixedProperties: NotRequired[str],

OrientationTypeDef#

# OrientationTypeDef definition

class OrientationTypeDef(TypedDict):
    degrees: NotRequired[float],

VendorPropertiesTypeDef#

# VendorPropertiesTypeDef definition

class VendorPropertiesTypeDef(TypedDict):
    vendorWorkerId: str,
    vendorWorkerIpAddress: NotRequired[str],
    vendorAdditionalTransientProperties: NotRequired[str],
    vendorAdditionalFixedProperties: NotRequired[str],

DeleteDestinationRequestRequestTypeDef#

# DeleteDestinationRequestRequestTypeDef definition

class DeleteDestinationRequestRequestTypeDef(TypedDict):
    id: str,

DeleteSiteRequestRequestTypeDef#

# DeleteSiteRequestRequestTypeDef definition

class DeleteSiteRequestRequestTypeDef(TypedDict):
    id: str,

DeleteWorkerFleetRequestRequestTypeDef#

# DeleteWorkerFleetRequestRequestTypeDef definition

class DeleteWorkerFleetRequestRequestTypeDef(TypedDict):
    id: str,

DeleteWorkerRequestRequestTypeDef#

# DeleteWorkerRequestRequestTypeDef definition

class DeleteWorkerRequestRequestTypeDef(TypedDict):
    id: str,

DestinationTypeDef#

# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    site: str,
    createdAt: datetime,
    updatedAt: datetime,
    state: DestinationStateType,  # (1)
    additionalFixedProperties: NotRequired[str],
  1. See DestinationStateType

GetDestinationRequestRequestTypeDef#

# GetDestinationRequestRequestTypeDef definition

class GetDestinationRequestRequestTypeDef(TypedDict):
    id: str,

GetSiteRequestRequestTypeDef#

# GetSiteRequestRequestTypeDef definition

class GetSiteRequestRequestTypeDef(TypedDict):
    id: str,

GetWorkerFleetRequestRequestTypeDef#

# GetWorkerFleetRequestRequestTypeDef definition

class GetWorkerFleetRequestRequestTypeDef(TypedDict):
    id: str,

GetWorkerRequestRequestTypeDef#

# GetWorkerRequestRequestTypeDef definition

class GetWorkerRequestRequestTypeDef(TypedDict):
    id: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDestinationsRequestRequestTypeDef#

# ListDestinationsRequestRequestTypeDef definition

class ListDestinationsRequestRequestTypeDef(TypedDict):
    site: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    state: NotRequired[DestinationStateType],  # (1)
  1. See DestinationStateType

ListSitesRequestRequestTypeDef#

# ListSitesRequestRequestTypeDef definition

class ListSitesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SiteTypeDef#

# SiteTypeDef definition

class SiteTypeDef(TypedDict):
    arn: str,
    name: str,
    countryCode: str,
    createdAt: datetime,

ListWorkerFleetsRequestRequestTypeDef#

# ListWorkerFleetsRequestRequestTypeDef definition

class ListWorkerFleetsRequestRequestTypeDef(TypedDict):
    site: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

WorkerFleetTypeDef#

# WorkerFleetTypeDef definition

class WorkerFleetTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    site: str,
    createdAt: datetime,
    updatedAt: datetime,
    additionalFixedProperties: NotRequired[str],

ListWorkersRequestRequestTypeDef#

# ListWorkersRequestRequestTypeDef definition

class ListWorkersRequestRequestTypeDef(TypedDict):
    site: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    fleet: NotRequired[str],

UpdateDestinationRequestRequestTypeDef#

# UpdateDestinationRequestRequestTypeDef definition

class UpdateDestinationRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    state: NotRequired[DestinationStateType],  # (1)
    additionalFixedProperties: NotRequired[str],
  1. See DestinationStateType

UpdateSiteRequestRequestTypeDef#

# UpdateSiteRequestRequestTypeDef definition

class UpdateSiteRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    countryCode: NotRequired[str],
    description: NotRequired[str],

UpdateWorkerFleetRequestRequestTypeDef#

# UpdateWorkerFleetRequestRequestTypeDef definition

class UpdateWorkerFleetRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    additionalFixedProperties: NotRequired[str],

PositionCoordinatesTypeDef#

# PositionCoordinatesTypeDef definition

class PositionCoordinatesTypeDef(TypedDict):
    cartesianCoordinates: NotRequired[CartesianCoordinatesTypeDef],  # (1)
  1. See CartesianCoordinatesTypeDef

CreateDestinationResponseTypeDef#

# CreateDestinationResponseTypeDef definition

class CreateDestinationResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createdAt: datetime,
    updatedAt: datetime,
    state: DestinationStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationStateType
  2. See ResponseMetadataTypeDef

CreateSiteResponseTypeDef#

# CreateSiteResponseTypeDef definition

class CreateSiteResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createdAt: datetime,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWorkerFleetResponseTypeDef#

# CreateWorkerFleetResponseTypeDef definition

class CreateWorkerFleetResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createdAt: datetime,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWorkerResponseTypeDef#

# CreateWorkerResponseTypeDef definition

class CreateWorkerResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createdAt: datetime,
    updatedAt: datetime,
    site: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDestinationResponseTypeDef#

# GetDestinationResponseTypeDef definition

class GetDestinationResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    site: str,
    createdAt: datetime,
    updatedAt: datetime,
    state: DestinationStateType,  # (1)
    additionalFixedProperties: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationStateType
  2. See ResponseMetadataTypeDef

GetSiteResponseTypeDef#

# GetSiteResponseTypeDef definition

class GetSiteResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    countryCode: str,
    description: str,
    createdAt: datetime,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetWorkerFleetResponseTypeDef#

# GetWorkerFleetResponseTypeDef definition

class GetWorkerFleetResponseTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    site: str,
    createdAt: datetime,
    updatedAt: datetime,
    additionalFixedProperties: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateDestinationResponseTypeDef#

# UpdateDestinationResponseTypeDef definition

class UpdateDestinationResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    updatedAt: datetime,
    state: DestinationStateType,  # (1)
    additionalFixedProperties: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationStateType
  2. See ResponseMetadataTypeDef

UpdateSiteResponseTypeDef#

# UpdateSiteResponseTypeDef definition

class UpdateSiteResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    countryCode: str,
    description: str,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateWorkerFleetResponseTypeDef#

# UpdateWorkerFleetResponseTypeDef definition

class UpdateWorkerFleetResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    updatedAt: datetime,
    additionalFixedProperties: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDestinationsResponseTypeDef#

# ListDestinationsResponseTypeDef definition

class ListDestinationsResponseTypeDef(TypedDict):
    nextToken: str,
    destinations: List[DestinationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationTypeDef
  2. See ResponseMetadataTypeDef

ListDestinationsRequestListDestinationsPaginateTypeDef#

# ListDestinationsRequestListDestinationsPaginateTypeDef definition

class ListDestinationsRequestListDestinationsPaginateTypeDef(TypedDict):
    site: str,
    state: NotRequired[DestinationStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DestinationStateType
  2. See PaginatorConfigTypeDef

ListSitesRequestListSitesPaginateTypeDef#

# ListSitesRequestListSitesPaginateTypeDef definition

class ListSitesRequestListSitesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkerFleetsRequestListWorkerFleetsPaginateTypeDef#

# ListWorkerFleetsRequestListWorkerFleetsPaginateTypeDef definition

class ListWorkerFleetsRequestListWorkerFleetsPaginateTypeDef(TypedDict):
    site: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkersRequestListWorkersPaginateTypeDef#

# ListWorkersRequestListWorkersPaginateTypeDef definition

class ListWorkersRequestListWorkersPaginateTypeDef(TypedDict):
    site: str,
    fleet: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSitesResponseTypeDef#

# ListSitesResponseTypeDef definition

class ListSitesResponseTypeDef(TypedDict):
    nextToken: str,
    sites: List[SiteTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SiteTypeDef
  2. See ResponseMetadataTypeDef

ListWorkerFleetsResponseTypeDef#

# ListWorkerFleetsResponseTypeDef definition

class ListWorkerFleetsResponseTypeDef(TypedDict):
    nextToken: str,
    workerFleets: List[WorkerFleetTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkerFleetTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkerRequestRequestTypeDef#

# CreateWorkerRequestRequestTypeDef definition

class CreateWorkerRequestRequestTypeDef(TypedDict):
    name: str,
    fleet: str,
    clientToken: NotRequired[str],
    additionalTransientProperties: NotRequired[str],
    additionalFixedProperties: NotRequired[str],
    vendorProperties: NotRequired[VendorPropertiesTypeDef],  # (1)
    position: NotRequired[PositionCoordinatesTypeDef],  # (2)
    orientation: NotRequired[OrientationTypeDef],  # (3)
  1. See VendorPropertiesTypeDef
  2. See PositionCoordinatesTypeDef
  3. See OrientationTypeDef

GetWorkerResponseTypeDef#

# GetWorkerResponseTypeDef definition

class GetWorkerResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    fleet: str,
    site: str,
    createdAt: datetime,
    updatedAt: datetime,
    name: str,
    additionalTransientProperties: str,
    additionalFixedProperties: str,
    vendorProperties: VendorPropertiesTypeDef,  # (1)
    position: PositionCoordinatesTypeDef,  # (2)
    orientation: OrientationTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See VendorPropertiesTypeDef
  2. See PositionCoordinatesTypeDef
  3. See OrientationTypeDef
  4. See ResponseMetadataTypeDef

UpdateWorkerRequestRequestTypeDef#

# UpdateWorkerRequestRequestTypeDef definition

class UpdateWorkerRequestRequestTypeDef(TypedDict):
    id: str,
    name: NotRequired[str],
    additionalTransientProperties: NotRequired[str],
    additionalFixedProperties: NotRequired[str],
    vendorProperties: NotRequired[VendorPropertiesTypeDef],  # (1)
    position: NotRequired[PositionCoordinatesTypeDef],  # (2)
    orientation: NotRequired[OrientationTypeDef],  # (3)
  1. See VendorPropertiesTypeDef
  2. See PositionCoordinatesTypeDef
  3. See OrientationTypeDef

UpdateWorkerResponseTypeDef#

# UpdateWorkerResponseTypeDef definition

class UpdateWorkerResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    fleet: str,
    updatedAt: datetime,
    name: str,
    additionalTransientProperties: str,
    additionalFixedProperties: str,
    orientation: OrientationTypeDef,  # (1)
    vendorProperties: VendorPropertiesTypeDef,  # (2)
    position: PositionCoordinatesTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See OrientationTypeDef
  2. See VendorPropertiesTypeDef
  3. See PositionCoordinatesTypeDef
  4. See ResponseMetadataTypeDef

WorkerTypeDef#

# WorkerTypeDef definition

class WorkerTypeDef(TypedDict):
    arn: str,
    id: str,
    fleet: str,
    createdAt: datetime,
    updatedAt: datetime,
    name: str,
    site: str,
    additionalTransientProperties: NotRequired[str],
    additionalFixedProperties: NotRequired[str],
    vendorProperties: NotRequired[VendorPropertiesTypeDef],  # (1)
    position: NotRequired[PositionCoordinatesTypeDef],  # (2)
    orientation: NotRequired[OrientationTypeDef],  # (3)
  1. See VendorPropertiesTypeDef
  2. See PositionCoordinatesTypeDef
  3. See OrientationTypeDef

ListWorkersResponseTypeDef#

# ListWorkersResponseTypeDef definition

class ListWorkersResponseTypeDef(TypedDict):
    nextToken: str,
    workers: List[WorkerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkerTypeDef
  2. See ResponseMetadataTypeDef