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

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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

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: TimestampTypeDef = ...,
    expiryTime: TimestampTypeDef = ...,
    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)
    dataPartitions: Sequence[DataPartitionTypeDef] = ...,  # (8)
    signalsToFetch: Sequence[SignalFetchInformationUnionTypeDef] = ...,  # (9)
) -> CreateCampaignResponseTypeDef:  # (10)
    ...

1. See CollectionSchemeTypeDef
2. See DiagnosticsModeType
3. See SpoolingModeType
4. See CompressionType
5. See SignalInformationTypeDef
6. See TagTypeDef
7. See DataDestinationConfigTypeDef
8. See DataPartitionTypeDef
9. See SignalFetchInformationTypeDef SignalFetchInformationOutputTypeDef
10. 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[SignalDecoderUnionTypeDef] = ...,  # (1)
    networkInterfaces: Sequence[NetworkInterfaceTypeDef] = ...,  # (2)
    defaultForUnmappedSignals: DefaultForUnmappedSignalsTypeType = ...,  # (3)
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateDecoderManifestResponseTypeDef:  # (5)
    ...

1. See SignalDecoderTypeDef SignalDecoderOutputTypeDef
2. See NetworkInterfaceTypeDef
3. See DefaultForUnmappedSignalsTypeType
4. See TagTypeDef
5. 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[NodeUnionTypeDef] = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateSignalCatalogResponseTypeDef:  # (3)
    ...

1. See NodeTypeDef NodeOutputTypeDef
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_state_template

Creates a state template.

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

# create_state_template method definition

def create_state_template(
    self,
    *,
    name: str,
    signalCatalogArn: str,
    stateTemplateProperties: Sequence[str],
    description: str = ...,
    dataExtraDimensions: Sequence[str] = ...,
    metadataExtraDimensions: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateStateTemplateResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateStateTemplateResponseTypeDef

# create_state_template method usage example with argument unpacking

kwargs: CreateStateTemplateRequestRequestTypeDef = {  # (1)
    "name": ...,
    "signalCatalogArn": ...,
    "stateTemplateProperties": ...,
}

parent.create_state_template(**kwargs)

1. See CreateStateTemplateRequestRequestTypeDef

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)
    stateTemplates: Sequence[StateTemplateAssociationUnionTypeDef] = ...,  # (3)
) -> CreateVehicleResponseTypeDef:  # (4)
    ...

1. See VehicleAssociationBehaviorType
2. See TagTypeDef
3. See StateTemplateAssociationTypeDef StateTemplateAssociationOutputTypeDef
4. 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_state_template

Deletes a state template.

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

# delete_state_template method definition

def delete_state_template(
    self,
    *,
    identifier: str,
) -> DeleteStateTemplateResponseTypeDef:  # (1)
    ...

1. See DeleteStateTemplateResponseTypeDef

# delete_state_template method usage example with argument unpacking

kwargs: DeleteStateTemplateRequestRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.delete_state_template(**kwargs)

1. See DeleteStateTemplateRequestRequestTypeDef

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

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_encryption_configuration

Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.

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

# get_encryption_configuration method definition

def get_encryption_configuration(
    self,
) -> GetEncryptionConfigurationResponseTypeDef:  # (1)
    ...

1. See GetEncryptionConfigurationResponseTypeDef

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_state_template

Retrieves information about a state template.

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

# get_state_template method definition

def get_state_template(
    self,
    *,
    identifier: str,
) -> GetStateTemplateResponseTypeDef:  # (1)
    ...

1. See GetStateTemplateResponseTypeDef

# get_state_template method usage example with argument unpacking

kwargs: GetStateTemplateRequestRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.get_state_template(**kwargs)

1. See GetStateTemplateRequestRequestTypeDef

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 campaigns, decoder manifests, or state templates associated with a vehicle.

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 NetworkFileDefinitionTypeDef
2. See ImportDecoderManifestResponseTypeDef

# import_decoder_manifest method usage example with argument unpacking

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

parent.import_decoder_manifest(**kwargs)

1. See ImportDecoderManifestRequestRequestTypeDef

import_signal_catalog

Creates a signal catalog using your existing VSS formatted content from your local device.

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

# import_signal_catalog method definition

def import_signal_catalog(
    self,
    *,
    name: str,
    description: str = ...,
    vss: FormattedVssTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> ImportSignalCatalogResponseTypeDef:  # (3)
    ...

1. See FormattedVssTypeDef
2. See TagTypeDef
3. See ImportSignalCatalogResponseTypeDef

# import_signal_catalog method usage example with argument unpacking

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

parent.import_signal_catalog(**kwargs)

1. See ImportSignalCatalogRequestRequestTypeDef

list_campaigns

Lists information about created campaigns.

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

# list_campaigns method definition

def list_campaigns(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    status: str = ...,
) -> ListCampaignsResponseTypeDef:  # (1)
    ...

1. See ListCampaignsResponseTypeDef

# list_campaigns method usage example with argument unpacking

kwargs: ListCampaignsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_campaigns(**kwargs)

1. See ListCampaignsRequestRequestTypeDef

list_decoder_manifest_network_interfaces

Lists the network interfaces specified in a decoder manifest.

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

# list_decoder_manifest_network_interfaces method definition

def list_decoder_manifest_network_interfaces(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDecoderManifestNetworkInterfacesResponseTypeDef:  # (1)
    ...

1. See ListDecoderManifestNetworkInterfacesResponseTypeDef

# list_decoder_manifest_network_interfaces method usage example with argument unpacking

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

parent.list_decoder_manifest_network_interfaces(**kwargs)

1. See ListDecoderManifestNetworkInterfacesRequestRequestTypeDef

list_decoder_manifest_signals

A list of information about signal decoders specified in a decoder manifest.

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

# list_decoder_manifest_signals method definition

def list_decoder_manifest_signals(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDecoderManifestSignalsResponseTypeDef:  # (1)
    ...

1. See ListDecoderManifestSignalsResponseTypeDef

# list_decoder_manifest_signals method usage example with argument unpacking

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

parent.list_decoder_manifest_signals(**kwargs)

1. See ListDecoderManifestSignalsRequestRequestTypeDef

list_decoder_manifests

Lists decoder manifests.

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

# list_decoder_manifests method definition

def list_decoder_manifests(
    self,
    *,
    modelManifestArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDecoderManifestsResponseTypeDef:  # (1)
    ...

1. See ListDecoderManifestsResponseTypeDef

# list_decoder_manifests method usage example with argument unpacking

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

parent.list_decoder_manifests(**kwargs)

1. See ListDecoderManifestsRequestRequestTypeDef

list_fleets

Retrieves information for each created fleet in an Amazon Web Services account.

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

# list_fleets method definition

def list_fleets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFleetsResponseTypeDef:  # (1)
    ...

1. See ListFleetsResponseTypeDef

# list_fleets method usage example with argument unpacking

kwargs: ListFleetsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_fleets(**kwargs)

1. See ListFleetsRequestRequestTypeDef

list_fleets_for_vehicle

Retrieves a list of IDs for all fleets that the vehicle is associated with.

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

# list_fleets_for_vehicle method definition

def list_fleets_for_vehicle(
    self,
    *,
    vehicleName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFleetsForVehicleResponseTypeDef:  # (1)
    ...

1. See ListFleetsForVehicleResponseTypeDef

# list_fleets_for_vehicle method usage example with argument unpacking

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

parent.list_fleets_for_vehicle(**kwargs)

1. See ListFleetsForVehicleRequestRequestTypeDef

list_model_manifest_nodes

Lists information about nodes specified in a vehicle model (model manifest).

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

# list_model_manifest_nodes method definition

def list_model_manifest_nodes(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListModelManifestNodesResponseTypeDef:  # (1)
    ...

1. See ListModelManifestNodesResponseTypeDef

# list_model_manifest_nodes method usage example with argument unpacking

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

parent.list_model_manifest_nodes(**kwargs)

1. See ListModelManifestNodesRequestRequestTypeDef

list_model_manifests

Retrieves a list of vehicle models (model manifests).

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

# list_model_manifests method definition

def list_model_manifests(
    self,
    *,
    signalCatalogArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListModelManifestsResponseTypeDef:  # (1)
    ...

1. See ListModelManifestsResponseTypeDef

# list_model_manifests method usage example with argument unpacking

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

parent.list_model_manifests(**kwargs)

1. See ListModelManifestsRequestRequestTypeDef

list_signal_catalog_nodes

Lists of information about the signals (nodes) specified in a signal catalog.

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

# list_signal_catalog_nodes method definition

def list_signal_catalog_nodes(
    self,
    *,
    name: str,
    nextToken: str = ...,
    maxResults: int = ...,
    signalNodeType: SignalNodeTypeType = ...,  # (1)
) -> ListSignalCatalogNodesResponseTypeDef:  # (2)
    ...

1. See SignalNodeTypeType
2. See ListSignalCatalogNodesResponseTypeDef

# list_signal_catalog_nodes method usage example with argument unpacking

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

parent.list_signal_catalog_nodes(**kwargs)

1. See ListSignalCatalogNodesRequestRequestTypeDef

list_signal_catalogs

Lists all the created signal catalogs in an Amazon Web Services account.

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

# list_signal_catalogs method definition

def list_signal_catalogs(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSignalCatalogsResponseTypeDef:  # (1)
    ...

1. See ListSignalCatalogsResponseTypeDef

# list_signal_catalogs method usage example with argument unpacking

kwargs: ListSignalCatalogsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_signal_catalogs(**kwargs)

1. See ListSignalCatalogsRequestRequestTypeDef

list_state_templates

Lists information about created state templates.

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

# list_state_templates method definition

def list_state_templates(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListStateTemplatesResponseTypeDef:  # (1)
    ...

1. See ListStateTemplatesResponseTypeDef

# list_state_templates method usage example with argument unpacking

kwargs: ListStateTemplatesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_state_templates(**kwargs)

1. See ListStateTemplatesRequestRequestTypeDef

list_tags_for_resource

Lists the tags (metadata) you have assigned to the resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_vehicles

Retrieves a list of summaries of created vehicles.

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

# list_vehicles method definition

def list_vehicles(
    self,
    *,
    modelManifestArn: str = ...,
    attributeNames: Sequence[str] = ...,
    attributeValues: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListVehiclesResponseTypeDef:  # (1)
    ...

1. See ListVehiclesResponseTypeDef

# list_vehicles method usage example with argument unpacking

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

parent.list_vehicles(**kwargs)

1. See ListVehiclesRequestRequestTypeDef

list_vehicles_in_fleet

Retrieves a list of summaries of all vehicles associated with a fleet.

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

# list_vehicles_in_fleet method definition

def list_vehicles_in_fleet(
    self,
    *,
    fleetId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListVehiclesInFleetResponseTypeDef:  # (1)
    ...

1. See ListVehiclesInFleetResponseTypeDef

# list_vehicles_in_fleet method usage example with argument unpacking

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

parent.list_vehicles_in_fleet(**kwargs)

1. See ListVehiclesInFleetRequestRequestTypeDef

put_encryption_configuration

Creates or updates the encryption configuration.

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

# put_encryption_configuration method definition

def put_encryption_configuration(
    self,
    *,
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyId: str = ...,
) -> PutEncryptionConfigurationResponseTypeDef:  # (2)
    ...

1. See EncryptionTypeType
2. See PutEncryptionConfigurationResponseTypeDef

# put_encryption_configuration method usage example with argument unpacking

kwargs: PutEncryptionConfigurationRequestRequestTypeDef = {  # (1)
    "encryptionType": ...,
}

parent.put_encryption_configuration(**kwargs)

1. See PutEncryptionConfigurationRequestRequestTypeDef

put_logging_options

Creates or updates the logging option.

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

# put_logging_options method definition

def put_logging_options(
    self,
    *,
    cloudWatchLogDelivery: CloudWatchLogDeliveryOptionsTypeDef,  # (1)
) -> dict[str, Any]:
    ...

1. See CloudWatchLogDeliveryOptionsTypeDef

# put_logging_options method usage example with argument unpacking

kwargs: PutLoggingOptionsRequestRequestTypeDef = {  # (1)
    "cloudWatchLogDelivery": ...,
}

parent.put_logging_options(**kwargs)

1. See PutLoggingOptionsRequestRequestTypeDef

register_account

This API operation contains deprecated parameters.

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

# register_account method definition

def register_account(
    self,
    *,
    timestreamResources: TimestreamResourcesTypeDef = ...,  # (1)
    iamResources: IamResourcesTypeDef = ...,  # (2)
) -> RegisterAccountResponseTypeDef:  # (3)
    ...

1. See TimestreamResourcesTypeDef
2. See IamResourcesTypeDef
3. See RegisterAccountResponseTypeDef

# register_account method usage example with argument unpacking

kwargs: RegisterAccountRequestRequestTypeDef = {  # (1)
    "timestreamResources": ...,
}

parent.register_account(**kwargs)

1. See RegisterAccountRequestRequestTypeDef

tag_resource

Adds to or modifies the tags of the given resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the given tags (metadata) from the resource.

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

# untag_resource method definition

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)

1. See UntagResourceRequestRequestTypeDef

update_campaign

Updates a campaign.

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

# update_campaign method definition

def update_campaign(
    self,
    *,
    name: str,
    action: UpdateCampaignActionType,  # (1)
    description: str = ...,
    dataExtraDimensions: Sequence[str] = ...,
) -> UpdateCampaignResponseTypeDef:  # (2)
    ...

1. See UpdateCampaignActionType
2. See UpdateCampaignResponseTypeDef

# update_campaign method usage example with argument unpacking

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

parent.update_campaign(**kwargs)

1. See UpdateCampaignRequestRequestTypeDef

update_decoder_manifest

Updates a decoder manifest.

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

# update_decoder_manifest method definition

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)
    defaultForUnmappedSignals: DefaultForUnmappedSignalsTypeType = ...,  # (6)
) -> UpdateDecoderManifestResponseTypeDef:  # (7)
    ...

1. See SignalDecoderTypeDef
2. See SignalDecoderTypeDef
3. See NetworkInterfaceTypeDef
4. See NetworkInterfaceTypeDef
5. See ManifestStatusType
6. See DefaultForUnmappedSignalsTypeType
7. See UpdateDecoderManifestResponseTypeDef

# update_decoder_manifest method usage example with argument unpacking

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

parent.update_decoder_manifest(**kwargs)

1. See UpdateDecoderManifestRequestRequestTypeDef

update_fleet

Updates the description of an existing fleet.

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

# update_fleet method definition

def update_fleet(
    self,
    *,
    fleetId: str,
    description: str = ...,
) -> UpdateFleetResponseTypeDef:  # (1)
    ...

1. See UpdateFleetResponseTypeDef

# update_fleet method usage example with argument unpacking

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

parent.update_fleet(**kwargs)

1. See UpdateFleetRequestRequestTypeDef

update_model_manifest

Updates a vehicle model (model manifest).

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

# update_model_manifest method definition

def update_model_manifest(
    self,
    *,
    name: str,
    description: str = ...,
    nodesToAdd: Sequence[str] = ...,
    nodesToRemove: Sequence[str] = ...,
    status: ManifestStatusType = ...,  # (1)
) -> UpdateModelManifestResponseTypeDef:  # (2)
    ...

1. See ManifestStatusType
2. See UpdateModelManifestResponseTypeDef

# update_model_manifest method usage example with argument unpacking

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

parent.update_model_manifest(**kwargs)

1. See UpdateModelManifestRequestRequestTypeDef

update_signal_catalog

Updates a signal catalog.

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

# update_signal_catalog method definition

def update_signal_catalog(
    self,
    *,
    name: str,
    description: str = ...,
    nodesToAdd: Sequence[NodeTypeDef] = ...,  # (1)
    nodesToUpdate: Sequence[NodeTypeDef] = ...,  # (1)
    nodesToRemove: Sequence[str] = ...,
) -> UpdateSignalCatalogResponseTypeDef:  # (3)
    ...

1. See NodeTypeDef
2. See NodeTypeDef
3. See UpdateSignalCatalogResponseTypeDef

# update_signal_catalog method usage example with argument unpacking

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

parent.update_signal_catalog(**kwargs)

1. See UpdateSignalCatalogRequestRequestTypeDef

update_state_template

Updates a state template.

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

# update_state_template method definition

def update_state_template(
    self,
    *,
    identifier: str,
    description: str = ...,
    stateTemplatePropertiesToAdd: Sequence[str] = ...,
    stateTemplatePropertiesToRemove: Sequence[str] = ...,
    dataExtraDimensions: Sequence[str] = ...,
    metadataExtraDimensions: Sequence[str] = ...,
) -> UpdateStateTemplateResponseTypeDef:  # (1)
    ...

1. See UpdateStateTemplateResponseTypeDef

# update_state_template method usage example with argument unpacking

kwargs: UpdateStateTemplateRequestRequestTypeDef = {  # (1)
    "identifier": ...,
}

parent.update_state_template(**kwargs)

1. See UpdateStateTemplateRequestRequestTypeDef

update_vehicle

Updates a vehicle.

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

# update_vehicle method definition

def update_vehicle(
    self,
    *,
    vehicleName: str,
    modelManifestArn: str = ...,
    decoderManifestArn: str = ...,
    attributes: Mapping[str, str] = ...,
    attributeUpdateMode: UpdateModeType = ...,  # (1)
    stateTemplatesToAdd: Sequence[StateTemplateAssociationTypeDef] = ...,  # (2)
    stateTemplatesToRemove: Sequence[str] = ...,
) -> UpdateVehicleResponseTypeDef:  # (3)
    ...

1. See UpdateModeType
2. See StateTemplateAssociationTypeDef
3. See UpdateVehicleResponseTypeDef

# update_vehicle method usage example with argument unpacking

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

parent.update_vehicle(**kwargs)

1. See UpdateVehicleRequestRequestTypeDef

get_paginator

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

• client.get_paginator("get_vehicle_status") -> GetVehicleStatusPaginator
• client.get_paginator("list_campaigns") -> ListCampaignsPaginator
• client.get_paginator("list_decoder_manifest_network_interfaces") -> ListDecoderManifestNetworkInterfacesPaginator
• client.get_paginator("list_decoder_manifest_signals") -> ListDecoderManifestSignalsPaginator
• client.get_paginator("list_decoder_manifests") -> ListDecoderManifestsPaginator
• client.get_paginator("list_fleets_for_vehicle") -> ListFleetsForVehiclePaginator
• client.get_paginator("list_fleets") -> ListFleetsPaginator
• client.get_paginator("list_model_manifest_nodes") -> ListModelManifestNodesPaginator
• client.get_paginator("list_model_manifests") -> ListModelManifestsPaginator
• client.get_paginator("list_signal_catalog_nodes") -> ListSignalCatalogNodesPaginator
• client.get_paginator("list_signal_catalogs") -> ListSignalCatalogsPaginator
• client.get_paginator("list_state_templates") -> ListStateTemplatesPaginator
• client.get_paginator("list_vehicles_in_fleet") -> ListVehiclesInFleetPaginator
• client.get_paginator("list_vehicles") -> ListVehiclesPaginator