IoTFleetWiseClient#
Index > IoTFleetWise > IoTFleetWiseClient
Auto-generated documentation for IoTFleetWise type annotations stubs module types-aiobotocore-iotfleetwise.
IoTFleetWiseClient#
Type annotations and code completion for session.create_client("iotfleetwise")
boto3 documentation
IoTFleetWiseClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_iotfleetwise.client import IoTFleetWiseClient
session = get_session()
async with session.create_client("iotfleetwise") as client:
client: IoTFleetWiseClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("iotfleetwise").exceptions
structure.
IoTFleetWiseClient.exceptions usage example
async with session.create_client("iotfleetwise") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.DecoderManifestValidationException,
client.InternalServerException,
client.InvalidNodeException,
client.InvalidSignalsException,
client.LimitExceededException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
IoTFleetWiseClient usage type checking example
from types_aiobotocore_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 session.create_client("iotfleetwise").associate_vehicle_fleet
method.
boto3 documentation
# associate_vehicle_fleet method definition
await 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)
batch_create_vehicle#
Creates a group, or batch, of vehicles.
Type annotations and code completion for session.create_client("iotfleetwise").batch_create_vehicle
method.
boto3 documentation
# batch_create_vehicle method definition
await def batch_create_vehicle(
self,
*,
vehicles: Sequence[CreateVehicleRequestItemTypeDef], # (1)
) -> BatchCreateVehicleResponseTypeDef: # (2)
...
# batch_create_vehicle method usage example with argument unpacking
kwargs: BatchCreateVehicleRequestRequestTypeDef = { # (1)
"vehicles": ...,
}
parent.batch_create_vehicle(**kwargs)
batch_update_vehicle#
Updates a group, or batch, of vehicles.
Type annotations and code completion for session.create_client("iotfleetwise").batch_update_vehicle
method.
boto3 documentation
# batch_update_vehicle method definition
await def batch_update_vehicle(
self,
*,
vehicles: Sequence[UpdateVehicleRequestItemTypeDef], # (1)
) -> BatchUpdateVehicleResponseTypeDef: # (2)
...
# batch_update_vehicle method usage example with argument unpacking
kwargs: BatchUpdateVehicleRequestRequestTypeDef = { # (1)
"vehicles": ...,
}
parent.batch_update_vehicle(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_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 session.create_client("iotfleetwise").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_campaign#
Creates an orchestration of data collection rules.
Type annotations and code completion for session.create_client("iotfleetwise").create_campaign
method.
boto3 documentation
# create_campaign method definition
await 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)
...
- See CollectionSchemeTypeDef
- See DiagnosticsModeType
- See SpoolingModeType
- See CompressionType
- See SignalInformationTypeDef
- See TagTypeDef
- See DataDestinationConfigTypeDef
- See CreateCampaignResponseTypeDef
# create_campaign method usage example with argument unpacking
kwargs: CreateCampaignRequestRequestTypeDef = { # (1)
"name": ...,
"signalCatalogArn": ...,
"targetArn": ...,
"collectionScheme": ...,
}
parent.create_campaign(**kwargs)
create_decoder_manifest#
Creates the decoder manifest associated with a model manifest.
Type annotations and code completion for session.create_client("iotfleetwise").create_decoder_manifest
method.
boto3 documentation
# create_decoder_manifest method definition
await 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)
...
- See SignalDecoderTypeDef
- See NetworkInterfaceTypeDef
- See TagTypeDef
- See CreateDecoderManifestResponseTypeDef
# create_decoder_manifest method usage example with argument unpacking
kwargs: CreateDecoderManifestRequestRequestTypeDef = { # (1)
"name": ...,
"modelManifestArn": ...,
}
parent.create_decoder_manifest(**kwargs)
create_fleet#
Creates a fleet that represents a group of vehicles.
Type annotations and code completion for session.create_client("iotfleetwise").create_fleet
method.
boto3 documentation
# create_fleet method definition
await def create_fleet(
self,
*,
fleetId: str,
signalCatalogArn: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateFleetResponseTypeDef: # (2)
...
- See TagTypeDef
- See CreateFleetResponseTypeDef
# create_fleet method usage example with argument unpacking
kwargs: CreateFleetRequestRequestTypeDef = { # (1)
"fleetId": ...,
"signalCatalogArn": ...,
}
parent.create_fleet(**kwargs)
create_model_manifest#
Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators).
Type annotations and code completion for session.create_client("iotfleetwise").create_model_manifest
method.
boto3 documentation
# create_model_manifest method definition
await def create_model_manifest(
self,
*,
name: str,
nodes: Sequence[str],
signalCatalogArn: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateModelManifestResponseTypeDef: # (2)
...
# create_model_manifest method usage example with argument unpacking
kwargs: CreateModelManifestRequestRequestTypeDef = { # (1)
"name": ...,
"nodes": ...,
"signalCatalogArn": ...,
}
parent.create_model_manifest(**kwargs)
create_signal_catalog#
Creates a collection of standardized signals that can be reused to create vehicle models.
Type annotations and code completion for session.create_client("iotfleetwise").create_signal_catalog
method.
boto3 documentation
# create_signal_catalog method definition
await def create_signal_catalog(
self,
*,
name: str,
description: str = ...,
nodes: Sequence[NodeTypeDef] = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateSignalCatalogResponseTypeDef: # (3)
...
- See NodeTypeDef
- See TagTypeDef
- See CreateSignalCatalogResponseTypeDef
# create_signal_catalog method usage example with argument unpacking
kwargs: CreateSignalCatalogRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_signal_catalog(**kwargs)
create_vehicle#
Creates a vehicle, which is an instance of a vehicle model (model manifest).
Type annotations and code completion for session.create_client("iotfleetwise").create_vehicle
method.
boto3 documentation
# create_vehicle method definition
await def create_vehicle(
self,
*,
vehicleName: str,
modelManifestArn: str,
decoderManifestArn: str,
attributes: Mapping[str, str] = ...,
associationBehavior: VehicleAssociationBehaviorType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateVehicleResponseTypeDef: # (3)
...
# create_vehicle method usage example with argument unpacking
kwargs: CreateVehicleRequestRequestTypeDef = { # (1)
"vehicleName": ...,
"modelManifestArn": ...,
"decoderManifestArn": ...,
}
parent.create_vehicle(**kwargs)
delete_campaign#
Deletes a data collection campaign.
Type annotations and code completion for session.create_client("iotfleetwise").delete_campaign
method.
boto3 documentation
# delete_campaign method definition
await def delete_campaign(
self,
*,
name: str,
) -> DeleteCampaignResponseTypeDef: # (1)
...
# delete_campaign method usage example with argument unpacking
kwargs: DeleteCampaignRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_campaign(**kwargs)
delete_decoder_manifest#
Deletes a decoder manifest.
Type annotations and code completion for session.create_client("iotfleetwise").delete_decoder_manifest
method.
boto3 documentation
# delete_decoder_manifest method definition
await def delete_decoder_manifest(
self,
*,
name: str,
) -> DeleteDecoderManifestResponseTypeDef: # (1)
...
# delete_decoder_manifest method usage example with argument unpacking
kwargs: DeleteDecoderManifestRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_decoder_manifest(**kwargs)
delete_fleet#
Deletes a fleet.
Type annotations and code completion for session.create_client("iotfleetwise").delete_fleet
method.
boto3 documentation
# delete_fleet method definition
await def delete_fleet(
self,
*,
fleetId: str,
) -> DeleteFleetResponseTypeDef: # (1)
...
# delete_fleet method usage example with argument unpacking
kwargs: DeleteFleetRequestRequestTypeDef = { # (1)
"fleetId": ...,
}
parent.delete_fleet(**kwargs)
delete_model_manifest#
Deletes a vehicle model (model manifest).
Type annotations and code completion for session.create_client("iotfleetwise").delete_model_manifest
method.
boto3 documentation
# delete_model_manifest method definition
await def delete_model_manifest(
self,
*,
name: str,
) -> DeleteModelManifestResponseTypeDef: # (1)
...
# delete_model_manifest method usage example with argument unpacking
kwargs: DeleteModelManifestRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_model_manifest(**kwargs)
delete_signal_catalog#
Deletes a signal catalog.
Type annotations and code completion for session.create_client("iotfleetwise").delete_signal_catalog
method.
boto3 documentation
# delete_signal_catalog method definition
await def delete_signal_catalog(
self,
*,
name: str,
) -> DeleteSignalCatalogResponseTypeDef: # (1)
...
# delete_signal_catalog method usage example with argument unpacking
kwargs: DeleteSignalCatalogRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_signal_catalog(**kwargs)
delete_vehicle#
Deletes a vehicle and removes it from any campaigns.
Type annotations and code completion for session.create_client("iotfleetwise").delete_vehicle
method.
boto3 documentation
# delete_vehicle method definition
await def delete_vehicle(
self,
*,
vehicleName: str,
) -> DeleteVehicleResponseTypeDef: # (1)
...
# delete_vehicle method usage example with argument unpacking
kwargs: DeleteVehicleRequestRequestTypeDef = { # (1)
"vehicleName": ...,
}
parent.delete_vehicle(**kwargs)
disassociate_vehicle_fleet#
Removes, or disassociates, a vehicle from a fleet.
Type annotations and code completion for session.create_client("iotfleetwise").disassociate_vehicle_fleet
method.
boto3 documentation
# disassociate_vehicle_fleet method definition
await 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)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("iotfleetwise").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("iotfleetwise").get_campaign
method.
boto3 documentation
# get_campaign method definition
await def get_campaign(
self,
*,
name: str,
) -> GetCampaignResponseTypeDef: # (1)
...
# get_campaign method usage example with argument unpacking
kwargs: GetCampaignRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_campaign(**kwargs)
get_decoder_manifest#
Retrieves information about a created decoder manifest.
Type annotations and code completion for session.create_client("iotfleetwise").get_decoder_manifest
method.
boto3 documentation
# get_decoder_manifest method definition
await def get_decoder_manifest(
self,
*,
name: str,
) -> GetDecoderManifestResponseTypeDef: # (1)
...
# get_decoder_manifest method usage example with argument unpacking
kwargs: GetDecoderManifestRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_decoder_manifest(**kwargs)
get_fleet#
Retrieves information about a fleet.
Type annotations and code completion for session.create_client("iotfleetwise").get_fleet
method.
boto3 documentation
# get_fleet method definition
await def get_fleet(
self,
*,
fleetId: str,
) -> GetFleetResponseTypeDef: # (1)
...
# get_fleet method usage example with argument unpacking
kwargs: GetFleetRequestRequestTypeDef = { # (1)
"fleetId": ...,
}
parent.get_fleet(**kwargs)
get_logging_options#
Retrieves the logging options.
Type annotations and code completion for session.create_client("iotfleetwise").get_logging_options
method.
boto3 documentation
# get_logging_options method definition
await def get_logging_options(
self,
) -> GetLoggingOptionsResponseTypeDef: # (1)
...
get_model_manifest#
Retrieves information about a vehicle model (model manifest).
Type annotations and code completion for session.create_client("iotfleetwise").get_model_manifest
method.
boto3 documentation
# get_model_manifest method definition
await def get_model_manifest(
self,
*,
name: str,
) -> GetModelManifestResponseTypeDef: # (1)
...
# get_model_manifest method usage example with argument unpacking
kwargs: GetModelManifestRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_model_manifest(**kwargs)
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 session.create_client("iotfleetwise").get_register_account_status
method.
boto3 documentation
# get_register_account_status method definition
await def get_register_account_status(
self,
) -> GetRegisterAccountStatusResponseTypeDef: # (1)
...
get_signal_catalog#
Retrieves information about a signal catalog.
Type annotations and code completion for session.create_client("iotfleetwise").get_signal_catalog
method.
boto3 documentation
# get_signal_catalog method definition
await def get_signal_catalog(
self,
*,
name: str,
) -> GetSignalCatalogResponseTypeDef: # (1)
...
# get_signal_catalog method usage example with argument unpacking
kwargs: GetSignalCatalogRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_signal_catalog(**kwargs)
get_vehicle#
Retrieves information about a vehicle.
Type annotations and code completion for session.create_client("iotfleetwise").get_vehicle
method.
boto3 documentation
# get_vehicle method definition
await def get_vehicle(
self,
*,
vehicleName: str,
) -> GetVehicleResponseTypeDef: # (1)
...
# get_vehicle method usage example with argument unpacking
kwargs: GetVehicleRequestRequestTypeDef = { # (1)
"vehicleName": ...,
}
parent.get_vehicle(**kwargs)
get_vehicle_status#
Retrieves information about the status of a vehicle with any associated campaigns.
Type annotations and code completion for session.create_client("iotfleetwise").get_vehicle_status
method.
boto3 documentation
# get_vehicle_status method definition
await def get_vehicle_status(
self,
*,
vehicleName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetVehicleStatusResponseTypeDef: # (1)
...
# get_vehicle_status method usage example with argument unpacking
kwargs: GetVehicleStatusRequestRequestTypeDef = { # (1)
"vehicleName": ...,
}
parent.get_vehicle_status(**kwargs)
import_decoder_manifest#
Creates a decoder manifest using your existing CAN DBC file from your local device.
Type annotations and code completion for session.create_client("iotfleetwise").import_decoder_manifest
method.
boto3 documentation
# import_decoder_manifest method definition
await def import_decoder_manifest(
self,
*,
name: str,
networkFileDefinitions: Sequence[NetworkFileDefinitionTypeDef], # (1)
) -> ImportDecoderManifestResponseTypeDef: # (2)
...
# import_decoder_manifest method usage example with argument unpacking
kwargs: ImportDecoderManifestRequestRequestTypeDef = { # (1)
"name": ...,
"networkFileDefinitions": ...,
}
parent.import_decoder_manifest(**kwargs)
import_signal_catalog#
Creates a signal catalog using your existing VSS formatted content from your local device.
Type annotations and code completion for session.create_client("iotfleetwise").import_signal_catalog
method.
boto3 documentation
# import_signal_catalog method definition
await def import_signal_catalog(
self,
*,
name: str,
description: str = ...,
vss: FormattedVssTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> ImportSignalCatalogResponseTypeDef: # (3)
...
# import_signal_catalog method usage example with argument unpacking
kwargs: ImportSignalCatalogRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.import_signal_catalog(**kwargs)
list_campaigns#
Lists information about created campaigns.
Type annotations and code completion for session.create_client("iotfleetwise").list_campaigns
method.
boto3 documentation
# list_campaigns method definition
await def list_campaigns(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
status: str = ...,
) -> ListCampaignsResponseTypeDef: # (1)
...
# list_campaigns method usage example with argument unpacking
kwargs: ListCampaignsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_campaigns(**kwargs)
list_decoder_manifest_network_interfaces#
Lists the network interfaces specified in a decoder manifest.
Type annotations and code completion for session.create_client("iotfleetwise").list_decoder_manifest_network_interfaces
method.
boto3 documentation
# list_decoder_manifest_network_interfaces method definition
await def list_decoder_manifest_network_interfaces(
self,
*,
name: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDecoderManifestNetworkInterfacesResponseTypeDef: # (1)
...
# list_decoder_manifest_network_interfaces method usage example with argument unpacking
kwargs: ListDecoderManifestNetworkInterfacesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.list_decoder_manifest_network_interfaces(**kwargs)
list_decoder_manifest_signals#
A list of information about signal decoders specified in a decoder manifest.
Type annotations and code completion for session.create_client("iotfleetwise").list_decoder_manifest_signals
method.
boto3 documentation
# list_decoder_manifest_signals method definition
await def list_decoder_manifest_signals(
self,
*,
name: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDecoderManifestSignalsResponseTypeDef: # (1)
...
# list_decoder_manifest_signals method usage example with argument unpacking
kwargs: ListDecoderManifestSignalsRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.list_decoder_manifest_signals(**kwargs)
list_decoder_manifests#
Lists decoder manifests.
Type annotations and code completion for session.create_client("iotfleetwise").list_decoder_manifests
method.
boto3 documentation
# list_decoder_manifests method definition
await def list_decoder_manifests(
self,
*,
modelManifestArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDecoderManifestsResponseTypeDef: # (1)
...
# list_decoder_manifests method usage example with argument unpacking
kwargs: ListDecoderManifestsRequestRequestTypeDef = { # (1)
"modelManifestArn": ...,
}
parent.list_decoder_manifests(**kwargs)
list_fleets#
Retrieves information for each created fleet in an Amazon Web Services account.
Type annotations and code completion for session.create_client("iotfleetwise").list_fleets
method.
boto3 documentation
# list_fleets method definition
await def list_fleets(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListFleetsResponseTypeDef: # (1)
...
# list_fleets method usage example with argument unpacking
kwargs: ListFleetsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_fleets(**kwargs)
list_fleets_for_vehicle#
Retrieves a list of IDs for all fleets that the vehicle is associated with.
Type annotations and code completion for session.create_client("iotfleetwise").list_fleets_for_vehicle
method.
boto3 documentation
# list_fleets_for_vehicle method definition
await def list_fleets_for_vehicle(
self,
*,
vehicleName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListFleetsForVehicleResponseTypeDef: # (1)
...
# list_fleets_for_vehicle method usage example with argument unpacking
kwargs: ListFleetsForVehicleRequestRequestTypeDef = { # (1)
"vehicleName": ...,
}
parent.list_fleets_for_vehicle(**kwargs)
list_model_manifest_nodes#
Lists information about nodes specified in a vehicle model (model manifest).
Type annotations and code completion for session.create_client("iotfleetwise").list_model_manifest_nodes
method.
boto3 documentation
# list_model_manifest_nodes method definition
await def list_model_manifest_nodes(
self,
*,
name: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListModelManifestNodesResponseTypeDef: # (1)
...
# list_model_manifest_nodes method usage example with argument unpacking
kwargs: ListModelManifestNodesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.list_model_manifest_nodes(**kwargs)
list_model_manifests#
Retrieves a list of vehicle models (model manifests).
Type annotations and code completion for session.create_client("iotfleetwise").list_model_manifests
method.
boto3 documentation
# list_model_manifests method definition
await def list_model_manifests(
self,
*,
signalCatalogArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListModelManifestsResponseTypeDef: # (1)
...
# list_model_manifests method usage example with argument unpacking
kwargs: ListModelManifestsRequestRequestTypeDef = { # (1)
"signalCatalogArn": ...,
}
parent.list_model_manifests(**kwargs)
list_signal_catalog_nodes#
Lists of information about the signals (nodes) specified in a signal catalog.
Type annotations and code completion for session.create_client("iotfleetwise").list_signal_catalog_nodes
method.
boto3 documentation
# list_signal_catalog_nodes method definition
await def list_signal_catalog_nodes(
self,
*,
name: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListSignalCatalogNodesResponseTypeDef: # (1)
...
# list_signal_catalog_nodes method usage example with argument unpacking
kwargs: ListSignalCatalogNodesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.list_signal_catalog_nodes(**kwargs)
list_signal_catalogs#
Lists all the created signal catalogs in an Amazon Web Services account.
Type annotations and code completion for session.create_client("iotfleetwise").list_signal_catalogs
method.
boto3 documentation
# list_signal_catalogs method definition
await def list_signal_catalogs(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListSignalCatalogsResponseTypeDef: # (1)
...
# list_signal_catalogs method usage example with argument unpacking
kwargs: ListSignalCatalogsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_signal_catalogs(**kwargs)
list_tags_for_resource#
Lists the tags (metadata) you have assigned to the resource.
Type annotations and code completion for session.create_client("iotfleetwise").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
list_vehicles#
Retrieves a list of summaries of created vehicles.
Type annotations and code completion for session.create_client("iotfleetwise").list_vehicles
method.
boto3 documentation
# list_vehicles method definition
await def list_vehicles(
self,
*,
modelManifestArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListVehiclesResponseTypeDef: # (1)
...
# list_vehicles method usage example with argument unpacking
kwargs: ListVehiclesRequestRequestTypeDef = { # (1)
"modelManifestArn": ...,
}
parent.list_vehicles(**kwargs)
list_vehicles_in_fleet#
Retrieves a list of summaries of all vehicles associated with a fleet.
Type annotations and code completion for session.create_client("iotfleetwise").list_vehicles_in_fleet
method.
boto3 documentation
# list_vehicles_in_fleet method definition
await def list_vehicles_in_fleet(
self,
*,
fleetId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListVehiclesInFleetResponseTypeDef: # (1)
...
# list_vehicles_in_fleet method usage example with argument unpacking
kwargs: ListVehiclesInFleetRequestRequestTypeDef = { # (1)
"fleetId": ...,
}
parent.list_vehicles_in_fleet(**kwargs)
put_logging_options#
Creates or updates the logging option.
Type annotations and code completion for session.create_client("iotfleetwise").put_logging_options
method.
boto3 documentation
# put_logging_options method definition
await def put_logging_options(
self,
*,
cloudWatchLogDelivery: CloudWatchLogDeliveryOptionsTypeDef, # (1)
) -> Dict[str, Any]:
...
# put_logging_options method usage example with argument unpacking
kwargs: PutLoggingOptionsRequestRequestTypeDef = { # (1)
"cloudWatchLogDelivery": ...,
}
parent.put_logging_options(**kwargs)
register_account#
.
Type annotations and code completion for session.create_client("iotfleetwise").register_account
method.
boto3 documentation
# register_account method definition
await def register_account(
self,
*,
timestreamResources: TimestreamResourcesTypeDef = ..., # (1)
iamResources: IamResourcesTypeDef = ..., # (2)
) -> RegisterAccountResponseTypeDef: # (3)
...
# register_account method usage example with argument unpacking
kwargs: RegisterAccountRequestRequestTypeDef = { # (1)
"timestreamResources": ...,
}
parent.register_account(**kwargs)
tag_resource#
Adds to or modifies the tags of the given resource.
Type annotations and code completion for session.create_client("iotfleetwise").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes the given tags (metadata) from the resource.
Type annotations and code completion for session.create_client("iotfleetwise").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_campaign#
Updates a campaign.
Type annotations and code completion for session.create_client("iotfleetwise").update_campaign
method.
boto3 documentation
# update_campaign method definition
await def update_campaign(
self,
*,
name: str,
action: UpdateCampaignActionType, # (1)
description: str = ...,
dataExtraDimensions: Sequence[str] = ...,
) -> UpdateCampaignResponseTypeDef: # (2)
...
# update_campaign method usage example with argument unpacking
kwargs: UpdateCampaignRequestRequestTypeDef = { # (1)
"name": ...,
"action": ...,
}
parent.update_campaign(**kwargs)
update_decoder_manifest#
Updates a decoder manifest.
Type annotations and code completion for session.create_client("iotfleetwise").update_decoder_manifest
method.
boto3 documentation
# update_decoder_manifest method definition
await def update_decoder_manifest(
self,
*,
name: str,
description: str = ...,
signalDecodersToAdd: Sequence[SignalDecoderTypeDef] = ..., # (1)
signalDecodersToUpdate: Sequence[SignalDecoderTypeDef] = ..., # (1)
signalDecodersToRemove: Sequence[str] = ...,
networkInterfacesToAdd: Sequence[NetworkInterfaceTypeDef] = ..., # (3)
networkInterfacesToUpdate: Sequence[NetworkInterfaceTypeDef] = ..., # (3)
networkInterfacesToRemove: Sequence[str] = ...,
status: ManifestStatusType = ..., # (5)
) -> UpdateDecoderManifestResponseTypeDef: # (6)
...
- See SignalDecoderTypeDef
- See SignalDecoderTypeDef
- See NetworkInterfaceTypeDef
- See NetworkInterfaceTypeDef
- See ManifestStatusType
- See UpdateDecoderManifestResponseTypeDef
# update_decoder_manifest method usage example with argument unpacking
kwargs: UpdateDecoderManifestRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_decoder_manifest(**kwargs)
update_fleet#
Updates the description of an existing fleet.
Type annotations and code completion for session.create_client("iotfleetwise").update_fleet
method.
boto3 documentation
# update_fleet method definition
await def update_fleet(
self,
*,
fleetId: str,
description: str = ...,
) -> UpdateFleetResponseTypeDef: # (1)
...
# update_fleet method usage example with argument unpacking
kwargs: UpdateFleetRequestRequestTypeDef = { # (1)
"fleetId": ...,
}
parent.update_fleet(**kwargs)
update_model_manifest#
Updates a vehicle model (model manifest).
Type annotations and code completion for session.create_client("iotfleetwise").update_model_manifest
method.
boto3 documentation
# update_model_manifest method definition
await def update_model_manifest(
self,
*,
name: str,
description: str = ...,
nodesToAdd: Sequence[str] = ...,
nodesToRemove: Sequence[str] = ...,
status: ManifestStatusType = ..., # (1)
) -> UpdateModelManifestResponseTypeDef: # (2)
...
# update_model_manifest method usage example with argument unpacking
kwargs: UpdateModelManifestRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_model_manifest(**kwargs)
update_signal_catalog#
Updates a signal catalog.
Type annotations and code completion for session.create_client("iotfleetwise").update_signal_catalog
method.
boto3 documentation
# update_signal_catalog method definition
await def update_signal_catalog(
self,
*,
name: str,
description: str = ...,
nodesToAdd: Sequence[NodeTypeDef] = ..., # (1)
nodesToUpdate: Sequence[NodeTypeDef] = ..., # (1)
nodesToRemove: Sequence[str] = ...,
) -> UpdateSignalCatalogResponseTypeDef: # (3)
...
- See NodeTypeDef
- See NodeTypeDef
- See UpdateSignalCatalogResponseTypeDef
# update_signal_catalog method usage example with argument unpacking
kwargs: UpdateSignalCatalogRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_signal_catalog(**kwargs)
update_vehicle#
Updates a vehicle.
Type annotations and code completion for session.create_client("iotfleetwise").update_vehicle
method.
boto3 documentation
# update_vehicle method definition
await def update_vehicle(
self,
*,
vehicleName: str,
modelManifestArn: str = ...,
decoderManifestArn: str = ...,
attributes: Mapping[str, str] = ...,
attributeUpdateMode: UpdateModeType = ..., # (1)
) -> UpdateVehicleResponseTypeDef: # (2)
...
# update_vehicle method usage example with argument unpacking
kwargs: UpdateVehicleRequestRequestTypeDef = { # (1)
"vehicleName": ...,
}
parent.update_vehicle(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("iotfleetwise").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> IoTFleetWiseClient:
...
__aexit__#
Type annotations and code completion for session.create_client("iotfleetwise").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("iotfleetwise").get_paginator
method with overloads.
client.get_paginator("get_vehicle_status")
-> GetVehicleStatusPaginatorclient.get_paginator("list_campaigns")
-> ListCampaignsPaginatorclient.get_paginator("list_decoder_manifest_network_interfaces")
-> ListDecoderManifestNetworkInterfacesPaginatorclient.get_paginator("list_decoder_manifest_signals")
-> ListDecoderManifestSignalsPaginatorclient.get_paginator("list_decoder_manifests")
-> ListDecoderManifestsPaginatorclient.get_paginator("list_fleets")
-> ListFleetsPaginatorclient.get_paginator("list_fleets_for_vehicle")
-> ListFleetsForVehiclePaginatorclient.get_paginator("list_model_manifest_nodes")
-> ListModelManifestNodesPaginatorclient.get_paginator("list_model_manifests")
-> ListModelManifestsPaginatorclient.get_paginator("list_signal_catalog_nodes")
-> ListSignalCatalogNodesPaginatorclient.get_paginator("list_signal_catalogs")
-> ListSignalCatalogsPaginatorclient.get_paginator("list_vehicles")
-> ListVehiclesPaginatorclient.get_paginator("list_vehicles_in_fleet")
-> ListVehiclesInFleetPaginator