Skip to content

IoTFleetWiseClient#

Index > IoTFleetWise > IoTFleetWiseClient

Auto-generated documentation for IoTFleetWise type annotations stubs module mypy-boto3-iotfleetwise.

IoTFleetWiseClient#

Type annotations and code completion for boto3.client("iotfleetwise"). boto3 documentation

# IoTFleetWiseClient usage example

from boto3.session import Session
from mypy_boto3_iotfleetwise.client import IoTFleetWiseClient

def get_iotfleetwise_client() -> IoTFleetWiseClient:
    return Session().client("iotfleetwise")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("iotfleetwise")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DecoderManifestValidationException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidNodeException,
    client.exceptions.InvalidSignalsException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_iotfleetwise.client import Exceptions

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

Methods#

associate_vehicle_fleet#

Adds, or associates, a vehicle with a fleet.

Type annotations and code completion for boto3.client("iotfleetwise").associate_vehicle_fleet method. boto3 documentation

# associate_vehicle_fleet method definition

def associate_vehicle_fleet(
    self,
    *,
    vehicleName: str,
    fleetId: str,
) -> Dict[str, Any]:
    ...
# associate_vehicle_fleet method usage example with argument unpacking

kwargs: AssociateVehicleFleetRequestRequestTypeDef = {  # (1)
    "vehicleName": ...,
    "fleetId": ...,
}

parent.associate_vehicle_fleet(**kwargs)
  1. See AssociateVehicleFleetRequestRequestTypeDef

batch_create_vehicle#

Creates a group, or batch, of vehicles.

Type annotations and code completion for boto3.client("iotfleetwise").batch_create_vehicle method. boto3 documentation

# batch_create_vehicle method definition

def batch_create_vehicle(
    self,
    *,
    vehicles: Sequence[CreateVehicleRequestItemTypeDef],  # (1)
) -> BatchCreateVehicleResponseTypeDef:  # (2)
    ...
  1. See CreateVehicleRequestItemTypeDef
  2. See BatchCreateVehicleResponseTypeDef 
# batch_create_vehicle method usage example with argument unpacking

kwargs: BatchCreateVehicleRequestRequestTypeDef = {  # (1)
    "vehicles": ...,
}

parent.batch_create_vehicle(**kwargs)
  1. See BatchCreateVehicleRequestRequestTypeDef

batch_update_vehicle#

Updates a group, or batch, of vehicles.

Type annotations and code completion for boto3.client("iotfleetwise").batch_update_vehicle method. boto3 documentation

# batch_update_vehicle method definition

def batch_update_vehicle(
    self,
    *,
    vehicles: Sequence[UpdateVehicleRequestItemTypeDef],  # (1)
) -> BatchUpdateVehicleResponseTypeDef:  # (2)
    ...
  1. See UpdateVehicleRequestItemTypeDef
  2. See BatchUpdateVehicleResponseTypeDef 
# batch_update_vehicle method usage example with argument unpacking

kwargs: BatchUpdateVehicleRequestRequestTypeDef = {  # (1)
    "vehicles": ...,
}

parent.batch_update_vehicle(**kwargs)
  1. See BatchUpdateVehicleRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iotfleetwise").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("iotfleetwise").close method. boto3 documentation

# close method definition

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

create_campaign#

Creates an orchestration of data collection rules.

Type annotations and code completion for boto3.client("iotfleetwise").create_campaign method. boto3 documentation