Skip to content

IoTRoboRunnerClient

Index > IoTRoboRunner > IoTRoboRunnerClient

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

IoTRoboRunnerClient

Type annotations and code completion for boto3.client("iot-roborunner"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_iot_roborunner.client import IoTRoboRunnerClient

def get_iot-roborunner_client() -> IoTRoboRunnerClient:
    return Session().client("iot-roborunner")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("iot-roborunner").exceptions structure.

Usage example
client = boto3.client("iot-roborunner")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_iot_roborunner.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iot-roborunner").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iot-roborunner").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_destination

Grants permission to create a destination See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").create_destination method. boto3 documentation

Method definition
def create_destination(
    self,
    *,
    name: str,
    site: str,
    clientToken: str = ...,
    state: DestinationStateType = ...,  # (1)
    additionalFixedProperties: str = ...,
) -> CreateDestinationResponseTypeDef:  # (2)
    ...
  1. See DestinationStateType
  2. See CreateDestinationResponseTypeDef
Usage example with kwargs
kwargs: CreateDestinationRequestRequestTypeDef = {  # (1)
    "name": ...,
    "site": ...,
}

parent.create_destination(**kwargs)
  1. See CreateDestinationRequestRequestTypeDef

create_site

Grants permission to create a site See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").create_site method. boto3 documentation

Method definition
def create_site(
    self,
    *,
    name: str,
    countryCode: str,
    clientToken: str = ...,
    description: str = ...,
) -> CreateSiteResponseTypeDef:  # (1)
    ...
  1. See CreateSiteResponseTypeDef
Usage example with kwargs
kwargs: CreateSiteRequestRequestTypeDef = {  # (1)
    "name": ...,
    "countryCode": ...,
}

parent.create_site(**kwargs)
  1. See CreateSiteRequestRequestTypeDef

create_worker

Grants permission to create a worker See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").create_worker method. boto3 documentation

Method definition
def create_worker(
    self,
    *,
    name: str,
    fleet: str,
    clientToken: str = ...,
    additionalTransientProperties: str = ...,
    additionalFixedProperties: str = ...,
    vendorProperties: VendorPropertiesTypeDef = ...,  # (1)
    position: PositionCoordinatesTypeDef = ...,  # (2)
    orientation: OrientationTypeDef = ...,  # (3)
) -> CreateWorkerResponseTypeDef:  # (4)
    ...
  1. See VendorPropertiesTypeDef
  2. See PositionCoordinatesTypeDef
  3. See OrientationTypeDef
  4. See CreateWorkerResponseTypeDef
Usage example with kwargs
kwargs: CreateWorkerRequestRequestTypeDef = {  # (1)
    "name": ...,
    "fleet": ...,
}

parent.create_worker(**kwargs)
  1. See CreateWorkerRequestRequestTypeDef

create_worker_fleet

Grants permission to create a worker fleet See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").create_worker_fleet method. boto3 documentation

Method definition
def create_worker_fleet(
    self,
    *,
    name: str,
    site: str,
    clientToken: str = ...,
    additionalFixedProperties: str = ...,
) -> CreateWorkerFleetResponseTypeDef:  # (1)
    ...
  1. See CreateWorkerFleetResponseTypeDef
Usage example with kwargs
kwargs: CreateWorkerFleetRequestRequestTypeDef = {  # (1)
    "name": ...,
    "site": ...,
}

parent.create_worker_fleet(**kwargs)
  1. See CreateWorkerFleetRequestRequestTypeDef

delete_destination

Grants permission to delete a destination See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").delete_destination method. boto3 documentation

Method definition
def delete_destination(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDestinationRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_destination(**kwargs)
  1. See DeleteDestinationRequestRequestTypeDef

delete_site

Grants permission to delete a site See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").delete_site method. boto3 documentation

Method definition
def delete_site(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSiteRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_site(**kwargs)
  1. See DeleteSiteRequestRequestTypeDef

delete_worker

Grants permission to delete a worker See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").delete_worker method. boto3 documentation

Method definition
def delete_worker(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteWorkerRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_worker(**kwargs)
  1. See DeleteWorkerRequestRequestTypeDef

delete_worker_fleet

Grants permission to delete a worker fleet See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").delete_worker_fleet method. boto3 documentation

Method definition
def delete_worker_fleet(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteWorkerFleetRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_worker_fleet(**kwargs)
  1. See DeleteWorkerFleetRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("iot-roborunner").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_destination

Grants permission to get a destination See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").get_destination method. boto3 documentation

Method definition
def get_destination(
    self,
    *,
    id: str,
) -> GetDestinationResponseTypeDef:  # (1)
    ...
  1. See GetDestinationResponseTypeDef
Usage example with kwargs
kwargs: GetDestinationRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_destination(**kwargs)
  1. See GetDestinationRequestRequestTypeDef

get_site

Grants permission to get a site See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").get_site method. boto3 documentation

Method definition
def get_site(
    self,
    *,
    id: str,
) -> GetSiteResponseTypeDef:  # (1)
    ...
  1. See GetSiteResponseTypeDef
Usage example with kwargs
kwargs: GetSiteRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_site(**kwargs)
  1. See GetSiteRequestRequestTypeDef

get_worker

Grants permission to get a worker See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").get_worker method. boto3 documentation

Method definition
def get_worker(
    self,
    *,
    id: str,
) -> GetWorkerResponseTypeDef:  # (1)
    ...
  1. See GetWorkerResponseTypeDef
Usage example with kwargs
kwargs: GetWorkerRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_worker(**kwargs)
  1. See GetWorkerRequestRequestTypeDef

get_worker_fleet

Grants permission to get a worker fleet See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").get_worker_fleet method. boto3 documentation

Method definition
def get_worker_fleet(
    self,
    *,
    id: str,
) -> GetWorkerFleetResponseTypeDef:  # (1)
    ...
  1. See GetWorkerFleetResponseTypeDef
Usage example with kwargs
kwargs: GetWorkerFleetRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_worker_fleet(**kwargs)
  1. See GetWorkerFleetRequestRequestTypeDef

list_destinations

Grants permission to list destinations See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").list_destinations method. boto3 documentation

Method definition
def list_destinations(
    self,
    *,
    site: str,
    maxResults: int = ...,
    nextToken: str = ...,
    state: DestinationStateType = ...,  # (1)
) -> ListDestinationsResponseTypeDef:  # (2)
    ...
  1. See DestinationStateType
  2. See ListDestinationsResponseTypeDef
Usage example with kwargs
kwargs: ListDestinationsRequestRequestTypeDef = {  # (1)
    "site": ...,
}

parent.list_destinations(**kwargs)
  1. See ListDestinationsRequestRequestTypeDef

list_sites

Grants permission to list sites See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").list_sites method. boto3 documentation

Method definition
def list_sites(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSitesResponseTypeDef:  # (1)
    ...
  1. See ListSitesResponseTypeDef
Usage example with kwargs
kwargs: ListSitesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_sites(**kwargs)
  1. See ListSitesRequestRequestTypeDef

list_worker_fleets

Grants permission to list worker fleets See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").list_worker_fleets method. boto3 documentation

Method definition
def list_worker_fleets(
    self,
    *,
    site: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkerFleetsResponseTypeDef:  # (1)
    ...
  1. See ListWorkerFleetsResponseTypeDef
Usage example with kwargs
kwargs: ListWorkerFleetsRequestRequestTypeDef = {  # (1)
    "site": ...,
}

parent.list_worker_fleets(**kwargs)
  1. See ListWorkerFleetsRequestRequestTypeDef

list_workers

Grants permission to list workers See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").list_workers method. boto3 documentation

Method definition
def list_workers(
    self,
    *,
    site: str,
    maxResults: int = ...,
    nextToken: str = ...,
    fleet: str = ...,
) -> ListWorkersResponseTypeDef:  # (1)
    ...
  1. See ListWorkersResponseTypeDef
Usage example with kwargs
kwargs: ListWorkersRequestRequestTypeDef = {  # (1)
    "site": ...,
}

parent.list_workers(**kwargs)
  1. See ListWorkersRequestRequestTypeDef

update_destination

Grants permission to update a destination See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").update_destination method. boto3 documentation

Method definition
def update_destination(
    self,
    *,
    id: str,
    name: str = ...,
    state: DestinationStateType = ...,  # (1)
    additionalFixedProperties: str = ...,
) -> UpdateDestinationResponseTypeDef:  # (2)
    ...
  1. See DestinationStateType
  2. See UpdateDestinationResponseTypeDef
Usage example with kwargs
kwargs: UpdateDestinationRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_destination(**kwargs)
  1. See UpdateDestinationRequestRequestTypeDef

update_site

Grants permission to update a site See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").update_site method. boto3 documentation

Method definition
def update_site(
    self,
    *,
    id: str,
    name: str = ...,
    countryCode: str = ...,
    description: str = ...,
) -> UpdateSiteResponseTypeDef:  # (1)
    ...
  1. See UpdateSiteResponseTypeDef
Usage example with kwargs
kwargs: UpdateSiteRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_site(**kwargs)
  1. See UpdateSiteRequestRequestTypeDef

update_worker

Grants permission to update a worker See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").update_worker method. boto3 documentation

Method definition
def update_worker(
    self,
    *,
    id: str,
    name: str = ...,
    additionalTransientProperties: str = ...,
    additionalFixedProperties: str = ...,
    vendorProperties: VendorPropertiesTypeDef = ...,  # (1)
    position: PositionCoordinatesTypeDef = ...,  # (2)
    orientation: OrientationTypeDef = ...,  # (3)
) -> UpdateWorkerResponseTypeDef:  # (4)
    ...
  1. See VendorPropertiesTypeDef
  2. See PositionCoordinatesTypeDef
  3. See OrientationTypeDef
  4. See UpdateWorkerResponseTypeDef
Usage example with kwargs
kwargs: UpdateWorkerRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_worker(**kwargs)
  1. See UpdateWorkerRequestRequestTypeDef

update_worker_fleet

Grants permission to update a worker fleet See also: AWS API Documentation.

Type annotations and code completion for boto3.client("iot-roborunner").update_worker_fleet method. boto3 documentation

Method definition
def update_worker_fleet(
    self,
    *,
    id: str,
    name: str = ...,
    additionalFixedProperties: str = ...,
) -> UpdateWorkerFleetResponseTypeDef:  # (1)
    ...
  1. See UpdateWorkerFleetResponseTypeDef
Usage example with kwargs
kwargs: UpdateWorkerFleetRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_worker_fleet(**kwargs)
  1. See UpdateWorkerFleetRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("iot-roborunner").get_paginator method with overloads.