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

# create_campaign method definition

def create_campaign(
    self,
    *,
    name: str,
    signalCatalogArn: str,
    targetArn: str,
    collectionScheme: CollectionSchemeTypeDef,  # (1)
    description: str = ...,
    startTime: Union[datetime, str] = ...,
    expiryTime: Union[datetime, str] = ...,
    postTriggerCollectionDuration: int = ...,
    diagnosticsMode: DiagnosticsModeType = ...,  # (2)
    spoolingMode: SpoolingModeType = ...,  # (3)
    compression: CompressionType = ...,  # (4)
    priority: int = ...,
    signalsToCollect: Sequence[SignalInformationTypeDef] = ...,  # (5)
    dataExtraDimensions: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (6)
    dataDestinationConfigs: Sequence[DataDestinationConfigTypeDef] = ...,  # (7)
) -> CreateCampaignResponseTypeDef:  # (8)
    ...
  1. See CollectionSchemeTypeDef
  2. See DiagnosticsModeType
  3. See SpoolingModeType
  4. See CompressionType
  5. See SignalInformationTypeDef
  6. See TagTypeDef
  7. See DataDestinationConfigTypeDef
  8. See CreateCampaignResponseTypeDef 
# create_campaign method usage example with argument unpacking

kwargs: CreateCampaignRequestRequestTypeDef = {  # (1)
    "name": ...,
    "signalCatalogArn": ...,
    "targetArn": ...,
    "collectionScheme": ...,
}

parent.create_campaign(**kwargs)
  1. See CreateCampaignRequestRequestTypeDef

create_decoder_manifest#

Creates the decoder manifest associated with a model manifest.

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

# create_decoder_manifest method definition

def create_decoder_manifest(
    self,
    *,
    name: str,
    modelManifestArn: str,
    description: str = ...,
    signalDecoders: Sequence[SignalDecoderTypeDef] = ...,  # (1)
    networkInterfaces: Sequence[NetworkInterfaceTypeDef] = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDecoderManifestResponseTypeDef:  # (4)
    ...
  1. See SignalDecoderTypeDef
  2. See NetworkInterfaceTypeDef
  3. See TagTypeDef
  4. See CreateDecoderManifestResponseTypeDef 
# create_decoder_manifest method usage example with argument unpacking

kwargs: CreateDecoderManifestRequestRequestTypeDef = {  # (1)
    "name": ...,
    "modelManifestArn": ...,
}

parent.create_decoder_manifest(**kwargs)
  1. See CreateDecoderManifestRequestRequestTypeDef

create_fleet#

Creates a fleet that represents a group of vehicles.

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

# create_fleet method definition

def create_fleet(
    self,
    *,
    fleetId: str,
    signalCatalogArn: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateFleetResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateFleetResponseTypeDef 
# create_fleet method usage example with argument unpacking

kwargs: CreateFleetRequestRequestTypeDef = {  # (1)
    "fleetId": ...,
    "signalCatalogArn": ...,
}

parent.create_fleet(**kwargs)
  1. See CreateFleetRequestRequestTypeDef

create_model_manifest#

Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).

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

# create_model_manifest method definition

def create_model_manifest(
    self,
    *,
    name: str,
    nodes: Sequence[str],
    signalCatalogArn: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateModelManifestResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateModelManifestResponseTypeDef 
# create_model_manifest method usage example with argument unpacking

kwargs: CreateModelManifestRequestRequestTypeDef = {  # (1)
    "name": ...,
    "nodes": ...,
    "signalCatalogArn": ...,
}

parent.create_model_manifest(**kwargs)
  1. See CreateModelManifestRequestRequestTypeDef

create_signal_catalog#

Creates a collection of standardized signals that can be reused to create vehicle models.

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

# create_signal_catalog method definition

def create_signal_catalog(
    self,
    *,
    name: str,
    description: str = ...,
    nodes: Sequence[NodeTypeDef] = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateSignalCatalogResponseTypeDef:  # (3)
    ...
  1. See NodeTypeDef
  2. See TagTypeDef
  3. See CreateSignalCatalogResponseTypeDef 
# create_signal_catalog method usage example with argument unpacking

kwargs: CreateSignalCatalogRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_signal_catalog(**kwargs)
  1. See CreateSignalCatalogRequestRequestTypeDef

create_vehicle#

Creates a vehicle, which is an instance of a vehicle model (model manifest).

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

# create_vehicle method definition

def create_vehicle(
    self,
    *,
    vehicleName: str,
    modelManifestArn: str,
    decoderManifestArn: str,
    attributes: Mapping[str, str] = ...,
    associationBehavior: VehicleAssociationBehaviorType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateVehicleResponseTypeDef:  # (3)
    ...
  1. See VehicleAssociationBehaviorType
  2. See TagTypeDef
  3. See CreateVehicleResponseTypeDef 
# create_vehicle method usage example with argument unpacking

kwargs: CreateVehicleRequestRequestTypeDef = {  # (1)
    "vehicleName": ...,
    "modelManifestArn": ...,
    "decoderManifestArn": ...,
}

parent.create_vehicle(**kwargs)
  1. See CreateVehicleRequestRequestTypeDef

delete_campaign#

Deletes a data collection campaign.

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

# delete_campaign method definition

def delete_campaign(
    self,
    *,
    name: str,
) -> DeleteCampaignResponseTypeDef:  # (1)
    ...
  1. See DeleteCampaignResponseTypeDef 
# delete_campaign method usage example with argument unpacking

kwargs: DeleteCampaignRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_campaign(**kwargs)
  1. See DeleteCampaignRequestRequestTypeDef

delete_decoder_manifest#

Deletes a decoder manifest.

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

# delete_decoder_manifest method definition

def delete_decoder_manifest(
    self,
    *,
    name: str,
) -> DeleteDecoderManifestResponseTypeDef:  # (1)
    ...
  1. See DeleteDecoderManifestResponseTypeDef 
# delete_decoder_manifest method usage example with argument unpacking

kwargs: DeleteDecoderManifestRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_decoder_manifest(**kwargs)
  1. See DeleteDecoderManifestRequestRequestTypeDef

delete_fleet#

Deletes a fleet.

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

# delete_fleet method definition

def delete_fleet(
    self,
    *,
    fleetId: str,
) -> DeleteFleetResponseTypeDef:  # (1)
    ...
  1. See DeleteFleetResponseTypeDef 
# delete_fleet method usage example with argument unpacking

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

parent.delete_fleet(**kwargs)
  1. See DeleteFleetRequestRequestTypeDef

delete_model_manifest#

Deletes a vehicle model (model manifest).

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

# delete_model_manifest method definition

def delete_model_manifest(
    self,
    *,
    name: str,
) -> DeleteModelManifestResponseTypeDef:  # (1)
    ...
  1. See DeleteModelManifestResponseTypeDef 
# delete_model_manifest method usage example with argument unpacking

kwargs: DeleteModelManifestRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_model_manifest(**kwargs)
  1. See DeleteModelManifestRequestRequestTypeDef

delete_signal_catalog#

Deletes a signal catalog.

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

# delete_signal_catalog method definition

def delete_signal_catalog(
    self,
    *,
    name: str,
) -> DeleteSignalCatalogResponseTypeDef:  # (1)
    ...
  1. See DeleteSignalCatalogResponseTypeDef 
# delete_signal_catalog method usage example with argument unpacking

kwargs: DeleteSignalCatalogRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_signal_catalog(**kwargs)
  1. See DeleteSignalCatalogRequestRequestTypeDef

delete_vehicle#

Deletes a vehicle and removes it from any campaigns.

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

# delete_vehicle method definition

def delete_vehicle(
    self,
    *,
    vehicleName: str,
) -> DeleteVehicleResponseTypeDef:  # (1)
    ...
  1. See DeleteVehicleResponseTypeDef 
# delete_vehicle method usage example with argument unpacking

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

parent.delete_vehicle(**kwargs)
  1. See DeleteVehicleRequestRequestTypeDef

disassociate_vehicle_fleet#

Removes, or disassociates, a vehicle from a fleet.

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

# disassociate_vehicle_fleet method definition

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

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

parent.disassociate_vehicle_fleet(**kwargs)
  1. See DisassociateVehicleFleetRequestRequestTypeDef

generate_presigned_url#

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

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

Retrieves information about a campaign.

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

# get_campaign method definition

def get_campaign(
    self,
    *,
    name: str,
) -> GetCampaignResponseTypeDef:  # (1)
    ...
  1. See GetCampaignResponseTypeDef 
# get_campaign method usage example with argument unpacking

kwargs: GetCampaignRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_campaign(**kwargs)
  1. See GetCampaignRequestRequestTypeDef

get_decoder_manifest#

Retrieves information about a created decoder manifest.

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

# get_decoder_manifest method definition

def get_decoder_manifest(
    self,
    *,
    name: str,
) -> GetDecoderManifestResponseTypeDef:  # (1)
    ...
  1. See GetDecoderManifestResponseTypeDef 
# get_decoder_manifest method usage example with argument unpacking

kwargs: GetDecoderManifestRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_decoder_manifest(**kwargs)
  1. See GetDecoderManifestRequestRequestTypeDef

get_fleet#

Retrieves information about a fleet.

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

# get_fleet method definition

def get_fleet(
    self,
    *,
    fleetId: str,
) -> GetFleetResponseTypeDef:  # (1)
    ...
  1. See GetFleetResponseTypeDef 
# get_fleet method usage example with argument unpacking

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

parent.get_fleet(**kwargs)
  1. See GetFleetRequestRequestTypeDef

get_logging_options#

Retrieves the logging options.

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

# get_logging_options method definition

def get_logging_options(
    self,
) -> GetLoggingOptionsResponseTypeDef:  # (1)
    ...
  1. See GetLoggingOptionsResponseTypeDef

get_model_manifest#

Retrieves information about a vehicle model (model manifest).

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

# get_model_manifest method definition

def get_model_manifest(
    self,
    *,
    name: str,
) -> GetModelManifestResponseTypeDef:  # (1)
    ...
  1. See GetModelManifestResponseTypeDef 
# get_model_manifest method usage example with argument unpacking

kwargs: GetModelManifestRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_model_manifest(**kwargs)
  1. See GetModelManifestRequestRequestTypeDef

get_register_account_status#

Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.

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

# get_register_account_status method definition

def get_register_account_status(
    self,
) -> GetRegisterAccountStatusResponseTypeDef:  # (1)
    ...
  1. See GetRegisterAccountStatusResponseTypeDef

get_signal_catalog#

Retrieves information about a signal catalog.

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

# get_signal_catalog method definition

def get_signal_catalog(
    self,
    *,
    name: str,
) -> GetSignalCatalogResponseTypeDef:  # (1)
    ...
  1. See GetSignalCatalogResponseTypeDef 
# get_signal_catalog method usage example with argument unpacking

kwargs: GetSignalCatalogRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_signal_catalog(**kwargs)
  1. See GetSignalCatalogRequestRequestTypeDef

get_vehicle#

Retrieves information about a vehicle.

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

# get_vehicle method definition

def get_vehicle(
    self,
    *,
    vehicleName: str,
) -> GetVehicleResponseTypeDef:  # (1)
    ...
  1. See GetVehicleResponseTypeDef 
# get_vehicle method usage example with argument unpacking

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

parent.get_vehicle(**kwargs)
  1. See GetVehicleRequestRequestTypeDef

get_vehicle_status#

Retrieves information about the status of a vehicle with any associated campaigns.

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

# get_vehicle_status method definition

def get_vehicle_status(
    self,
    *,
    vehicleName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetVehicleStatusResponseTypeDef:  # (1)
    ...
  1. See GetVehicleStatusResponseTypeDef 
# get_vehicle_status method usage example with argument unpacking

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

parent.get_vehicle_status(**kwargs)
  1. See GetVehicleStatusRequestRequestTypeDef

import_decoder_manifest#

Creates a decoder manifest using your existing CAN DBC file from your local device.

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

# import_decoder_manifest method definition

def import_decoder_manifest(
    self,
    *,
    name: str,
    networkFileDefinitions: Sequence[NetworkFileDefinitionTypeDef],  # (1)
) -> ImportDecoderManifestResponseTypeDef:  # (2)
    ...
  1. See