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
# IoTRoboRunnerClient 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.
# Exceptions.exceptions usage example
client = boto3.client("iot-roborunner")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions 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
# can_paginate 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
# close 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
# create_destination method definition
def create_destination(
self,
*,
name: str,
site: str,
clientToken: str = ...,
state: DestinationStateType = ..., # (1)
additionalFixedProperties: str = ...,
) -> CreateDestinationResponseTypeDef: # (2)
...
# create_destination method usage example with argument unpacking
kwargs: CreateDestinationRequestRequestTypeDef = { # (1)
"name": ...,
"site": ...,
}
parent.create_destination(**kwargs)
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
# create_site method definition
def create_site(
self,
*,
name: str,
countryCode: str,
clientToken: str = ...,
description: str = ...,
) -> CreateSiteResponseTypeDef: # (1)
...
# create_site method usage example with argument unpacking
kwargs: CreateSiteRequestRequestTypeDef = { # (1)
"name": ...,
"countryCode": ...,
}
parent.create_site(**kwargs)
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
# create_worker 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)
...
- See VendorPropertiesTypeDef
- See PositionCoordinatesTypeDef
- See OrientationTypeDef
- See CreateWorkerResponseTypeDef
# create_worker method usage example with argument unpacking
kwargs: CreateWorkerRequestRequestTypeDef = { # (1)
"name": ...,
"fleet": ...,
}
parent.create_worker(**kwargs)
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
# create_worker_fleet method definition
def create_worker_fleet(
self,
*,
name: str,
site: str,
clientToken: str = ...,
additionalFixedProperties: str = ...,
) -> CreateWorkerFleetResponseTypeDef: # (1)
...
# create_worker_fleet method usage example with argument unpacking
kwargs: CreateWorkerFleetRequestRequestTypeDef = { # (1)
"name": ...,
"site": ...,
}
parent.create_worker_fleet(**kwargs)
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
# delete_destination method definition
def delete_destination(
self,
*,
id: str,
) -> Dict[str, Any]:
...
# delete_destination method usage example with argument unpacking
kwargs: DeleteDestinationRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_destination(**kwargs)
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
# delete_site method definition
def delete_site(
self,
*,
id: str,
) -> Dict[str, Any]:
...
# delete_site method usage example with argument unpacking
kwargs: DeleteSiteRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_site(**kwargs)
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
# delete_worker method definition
def delete_worker(
self,
*,
id: str,
) -> Dict[str, Any]:
...
# delete_worker method usage example with argument unpacking
kwargs: DeleteWorkerRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_worker(**kwargs)
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
# delete_worker_fleet method definition
def delete_worker_fleet(
self,
*,
id: str,
) -> Dict[str, Any]:
...
# delete_worker_fleet method usage example with argument unpacking
kwargs: DeleteWorkerFleetRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_worker_fleet(**kwargs)
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
# generate_presigned_url 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
# get_destination method definition
def get_destination(
self,
*,
id: str,
) -> GetDestinationResponseTypeDef: # (1)
...
# get_destination method usage example with argument unpacking
kwargs: GetDestinationRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_destination(**kwargs)
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
# get_site method definition
def get_site(
self,
*,
id: str,
) -> GetSiteResponseTypeDef: # (1)
...
# get_site method usage example with argument unpacking
kwargs: GetSiteRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_site(**kwargs)
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
# get_worker method definition
def get_worker(
self,
*,
id: str,
) -> GetWorkerResponseTypeDef: # (1)
...
# get_worker method usage example with argument unpacking
kwargs: GetWorkerRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_worker(**kwargs)
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
# get_worker_fleet method definition
def get_worker_fleet(
self,
*,
id: str,
) -> GetWorkerFleetResponseTypeDef: # (1)
...
# get_worker_fleet method usage example with argument unpacking
kwargs: GetWorkerFleetRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_worker_fleet(**kwargs)
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
# list_destinations method definition
def list_destinations(
self,
*,
site: str,
maxResults: int = ...,
nextToken: str = ...,
state: DestinationStateType = ..., # (1)
) -> ListDestinationsResponseTypeDef: # (2)
...
# list_destinations method usage example with argument unpacking
kwargs: ListDestinationsRequestRequestTypeDef = { # (1)
"site": ...,
}
parent.list_destinations(**kwargs)
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
# list_sites method definition
def list_sites(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSitesResponseTypeDef: # (1)
...
# list_sites method usage example with argument unpacking
kwargs: ListSitesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_sites(**kwargs)
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
# list_worker_fleets method definition
def list_worker_fleets(
self,
*,
site: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListWorkerFleetsResponseTypeDef: # (1)
...
# list_worker_fleets method usage example with argument unpacking
kwargs: ListWorkerFleetsRequestRequestTypeDef = { # (1)
"site": ...,
}
parent.list_worker_fleets(**kwargs)
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
# list_workers method definition
def list_workers(
self,
*,
site: str,
maxResults: int = ...,
nextToken: str = ...,
fleet: str = ...,
) -> ListWorkersResponseTypeDef: # (1)
...
# list_workers method usage example with argument unpacking
kwargs: ListWorkersRequestRequestTypeDef = { # (1)
"site": ...,
}
parent.list_workers(**kwargs)
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
# update_destination method definition
def update_destination(
self,
*,
id: str,
name: str = ...,
state: DestinationStateType = ..., # (1)
additionalFixedProperties: str = ...,
) -> UpdateDestinationResponseTypeDef: # (2)
...
# update_destination method usage example with argument unpacking
kwargs: UpdateDestinationRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_destination(**kwargs)
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
# update_site method definition
def update_site(
self,
*,
id: str,
name: str = ...,
countryCode: str = ...,
description: str = ...,
) -> UpdateSiteResponseTypeDef: # (1)
...
# update_site method usage example with argument unpacking
kwargs: UpdateSiteRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_site(**kwargs)
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
# update_worker 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)
...
- See VendorPropertiesTypeDef
- See PositionCoordinatesTypeDef
- See OrientationTypeDef
- See UpdateWorkerResponseTypeDef
# update_worker method usage example with argument unpacking
kwargs: UpdateWorkerRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_worker(**kwargs)
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
# update_worker_fleet method definition
def update_worker_fleet(
self,
*,
id: str,
name: str = ...,
additionalFixedProperties: str = ...,
) -> UpdateWorkerFleetResponseTypeDef: # (1)
...
# update_worker_fleet method usage example with argument unpacking
kwargs: UpdateWorkerFleetRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_worker_fleet(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("iot-roborunner").get_paginator
method with overloads.
client.get_paginator("list_destinations")
-> ListDestinationsPaginatorclient.get_paginator("list_sites")
-> ListSitesPaginatorclient.get_paginator("list_worker_fleets")
-> ListWorkerFleetsPaginatorclient.get_paginator("list_workers")
-> ListWorkersPaginator