Skip to content

Iotfleetwise Classes

Actuator

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

description

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

allowedValues

  • Type: typing.Optional[typing.List[str]]

min

  • Type: typing.Optional[float]

max

  • Type: typing.Optional[float]

assignedValue

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

structFullyQualifiedName

  • Type: typing.Optional[str]

ActuatorOutput

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

description

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

allowedValues

  • Type: typing.Optional[typing.List[str]]

min

  • Type: typing.Optional[float]

max

  • Type: typing.Optional[float]

assignedValue

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

structFullyQualifiedName

  • Type: typing.Optional[str]

AssociateVehicleFleetRequest

vehicleName

  • Type:
  • Required: Yes

fleetId

  • Type:
  • Required: Yes

Attribute

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

description

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

allowedValues

  • Type: typing.Optional[typing.List[str]]

min

  • Type: typing.Optional[float]

max

  • Type: typing.Optional[float]

assignedValue

  • Type: typing.Optional[str]

defaultValue

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

AttributeOutput

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

description

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

allowedValues

  • Type: typing.Optional[typing.List[str]]

min

  • Type: typing.Optional[float]

max

  • Type: typing.Optional[float]

assignedValue

  • Type: typing.Optional[str]

defaultValue

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchCreateVehicleRequest

vehicles

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CreateVehicleRequestItem]
  • Required: Yes

BatchCreateVehicleResponse

vehicles

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CreateVehicleResponseItem]
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CreateVehicleError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchUpdateVehicleRequest

vehicles

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.UpdateVehicleRequestItem]
  • Required: Yes

BatchUpdateVehicleResponse

vehicles

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.UpdateVehicleResponseItem]
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.UpdateVehicleError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Branch

fullyQualifiedName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

CampaignSummary

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

arn

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

signalCatalogArn

  • Type: typing.Optional[str]

targetArn

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['CREATING', 'RUNNING', 'SUSPENDED', 'WAITING_FOR_APPROVAL']]

CanDbcDefinition

networkInterface

  • Type:
  • Required: Yes

canDbcFiles

  • Type: typing.List[typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]]
  • Required: Yes

signalsMap

  • Type: typing.Optional[typing.Dict[str, str]]

CanInterface

name

  • Type:
  • Required: Yes

protocolName

  • Type: typing.Optional[str]

protocolVersion

  • Type: typing.Optional[str]

CanSignal

messageId

  • Type:
  • Required: Yes

isBigEndian

  • Type:
  • Required: Yes

isSigned

  • Type:
  • Required: Yes

startBit

  • Type:
  • Required: Yes

offset

  • Type:
  • Required: Yes

factor

  • Type:
  • Required: Yes

length

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

signalValueType

  • Type: typing.Optional[typing.Literal['FLOATING_POINT', 'INTEGER']]

CloudWatchLogDeliveryOptions

logType

  • Type: typing.Literal['ERROR', 'OFF']
  • Required: Yes

logGroupName

  • Type: typing.Optional[str]

CollectionScheme

timeBasedCollectionScheme

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.TimeBasedCollectionScheme]

conditionBasedCollectionScheme

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ConditionBasedCollectionScheme]

ConditionBasedCollectionScheme

expression

  • Type:
  • Required: Yes

minimumTriggerIntervalMs

  • Type: typing.Optional[int]

triggerMode

  • Type: typing.Optional[typing.Literal['ALWAYS', 'RISING_EDGE']]

conditionLanguageVersion

  • Type: typing.Optional[int]

ConditionBasedSignalFetchConfig

conditionExpression

  • Type:
  • Required: Yes

triggerMode

  • Type: typing.Literal['ALWAYS', 'RISING_EDGE']
  • Required: Yes

CreateCampaignRequest

name

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

targetArn

  • Type:
  • Required: Yes

collectionScheme

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

startTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

expiryTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

postTriggerCollectionDuration

  • Type: typing.Optional[int]

diagnosticsMode

  • Type: typing.Optional[typing.Literal['OFF', 'SEND_ACTIVE_DTCS']]

spoolingMode

  • Type: typing.Optional[typing.Literal['OFF', 'TO_DISK']]

compression

  • Type: typing.Optional[typing.Literal['OFF', 'SNAPPY']]

priority

  • Type: typing.Optional[int]

signalsToCollect

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalInformation]]

dataExtraDimensions

  • Type: typing.Optional[typing.List[str]]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

dataDestinationConfigs

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.DataDestinationConfig]]

dataPartitions

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.DataPartition]]

signalsToFetch

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalFetchInformation, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalFetchInformationOutput]]]

CreateCampaignResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDecoderManifestRequest

name

  • Type:
  • Required: Yes

modelManifestArn

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

signalDecoders

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoder, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoderOutput]]]

networkInterfaces

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NetworkInterface]]

defaultForUnmappedSignals

  • Type: typing.Optional[typing.Literal['CUSTOM_DECODING']]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

CreateDecoderManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateFleetRequest

fleetId

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

CreateFleetResponse

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateModelManifestRequest

name

  • Type:
  • Required: Yes

nodes

  • Type: typing.List[str]
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

CreateModelManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSignalCatalogRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

nodes

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Node, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NodeOutput]]]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

CreateSignalCatalogResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateStateTemplateRequest

name

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

stateTemplateProperties

  • Type: typing.List[str]
  • Required: Yes

description

  • Type: typing.Optional[str]

dataExtraDimensions

  • Type: typing.Optional[typing.List[str]]

metadataExtraDimensions

  • Type: typing.Optional[typing.List[str]]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

CreateStateTemplateResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateVehicleError

vehicleName

  • Type: typing.Optional[str]

code

  • Type: typing.Optional[str]

message

  • Type: typing.Optional[str]

CreateVehicleRequest

vehicleName

  • Type:
  • Required: Yes

modelManifestArn

  • Type:
  • Required: Yes

decoderManifestArn

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

associationBehavior

  • Type: typing.Optional[typing.Literal['CreateIotThing', 'ValidateIotThingExists']]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

stateTemplates

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociation, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociationOutput]]]

CreateVehicleRequestItem

vehicleName

  • Type:
  • Required: Yes

modelManifestArn

  • Type:
  • Required: Yes

decoderManifestArn

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

associationBehavior

  • Type: typing.Optional[typing.Literal['CreateIotThing', 'ValidateIotThingExists']]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

stateTemplates

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociation, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociationOutput]]]

CreateVehicleResponse

vehicleName

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

thingArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateVehicleResponseItem

vehicleName

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

thingArn

  • Type: typing.Optional[str]

CustomDecodingInterface

name

  • Type:
  • Required: Yes

CustomDecodingSignal

id

  • Type:
  • Required: Yes

CustomProperty

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

dataEncoding

  • Type: typing.Optional[typing.Literal['BINARY', 'TYPED']]

description

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

structFullyQualifiedName

  • Type: typing.Optional[str]

CustomStruct

fullyQualifiedName

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

DataDestinationConfig

s3Config

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.S3Config]

timestreamConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.TimestreamConfig]

mqttTopicConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.MqttTopicConfig]

DataPartition

id

  • Type:
  • Required: Yes

storageOptions

  • Type:
  • Required: Yes

uploadOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.DataPartitionUploadOptions]

DataPartitionStorageOptions

maximumSize

  • Type:
  • Required: Yes

storageLocation

  • Type:
  • Required: Yes

minimumTimeToLive

  • Type:
  • Required: Yes

DataPartitionUploadOptions

expression

  • Type:
  • Required: Yes

conditionLanguageVersion

  • Type: typing.Optional[int]

DecoderManifestSummary

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

modelManifestArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DRAFT', 'INVALID', 'VALIDATING']]

message

  • Type: typing.Optional[str]

DeleteCampaignRequest

name

  • Type:
  • Required: Yes

DeleteCampaignResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDecoderManifestRequest

name

  • Type:
  • Required: Yes

DeleteDecoderManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteFleetRequest

fleetId

  • Type:
  • Required: Yes

DeleteFleetResponse

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteModelManifestRequest

name

  • Type:
  • Required: Yes

DeleteModelManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteSignalCatalogRequest

name

  • Type:
  • Required: Yes

DeleteSignalCatalogResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteStateTemplateRequest

identifier

  • Type:
  • Required: Yes

DeleteStateTemplateResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteVehicleRequest

vehicleName

  • Type:
  • Required: Yes

DeleteVehicleResponse

vehicleName

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisassociateVehicleFleetRequest

vehicleName

  • Type:
  • Required: Yes

fleetId

  • Type:
  • Required: Yes

FleetSummary

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

lastModificationTime

  • Type: typing.Optional[datetime.datetime]

FormattedVss

vssJson

  • Type: typing.Optional[str]

GetCampaignRequest

name

  • Type:
  • Required: Yes

GetCampaignResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

targetArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATING', 'RUNNING', 'SUSPENDED', 'WAITING_FOR_APPROVAL']
  • Required: Yes

startTime

  • Type:
  • Required: Yes

expiryTime

  • Type:
  • Required: Yes

postTriggerCollectionDuration

  • Type:
  • Required: Yes

diagnosticsMode

  • Type: typing.Literal['OFF', 'SEND_ACTIVE_DTCS']
  • Required: Yes

spoolingMode

  • Type: typing.Literal['OFF', 'TO_DISK']
  • Required: Yes

compression

  • Type: typing.Literal['OFF', 'SNAPPY']
  • Required: Yes

priority

  • Type:
  • Required: Yes

signalsToCollect

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalInformation]
  • Required: Yes

collectionScheme

  • Type:
  • Required: Yes

dataExtraDimensions

  • Type: typing.List[str]
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

dataDestinationConfigs

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.DataDestinationConfig]
  • Required: Yes

dataPartitions

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.DataPartition]
  • Required: Yes

signalsToFetch

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalFetchInformationOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDecoderManifestRequest

name

  • Type:
  • Required: Yes

GetDecoderManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

modelManifestArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'DRAFT', 'INVALID', 'VALIDATING']
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

message

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetEncryptionConfigurationResponse

kmsKeyId

  • Type:
  • Required: Yes

encryptionStatus

  • Type: typing.Literal['FAILURE', 'PENDING', 'SUCCESS']
  • Required: Yes

encryptionType

  • Type: typing.Literal['FLEETWISE_DEFAULT_ENCRYPTION', 'KMS_BASED_ENCRYPTION']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFleetRequest

fleetId

  • Type:
  • Required: Yes

GetFleetResponse

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetLoggingOptionsResponse

cloudWatchLogDelivery

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetModelManifestRequest

name

  • Type:
  • Required: Yes

GetModelManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'DRAFT', 'INVALID', 'VALIDATING']
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRegisterAccountStatusResponse

customerAccountId

  • Type:
  • Required: Yes

accountStatus

  • Type: typing.Literal['REGISTRATION_FAILURE', 'REGISTRATION_PENDING', 'REGISTRATION_SUCCESS']
  • Required: Yes

timestreamRegistrationResponse

  • Type:
  • Required: Yes

iamRegistrationResponse

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSignalCatalogRequest

name

  • Type:
  • Required: Yes

GetSignalCatalogResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

nodeCounts

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetStateTemplateRequest

identifier

  • Type:
  • Required: Yes

GetStateTemplateResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

signalCatalogArn

  • Type:
  • Required: Yes

stateTemplateProperties

  • Type: typing.List[str]
  • Required: Yes

dataExtraDimensions

  • Type: typing.List[str]
  • Required: Yes

metadataExtraDimensions

  • Type: typing.List[str]
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetVehicleRequest

vehicleName

  • Type:
  • Required: Yes

GetVehicleResponse

vehicleName

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

modelManifestArn

  • Type:
  • Required: Yes

decoderManifestArn

  • Type:
  • Required: Yes

attributes

  • Type: typing.Dict[str, str]
  • Required: Yes

stateTemplates

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociationOutput]
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetVehicleStatusRequest

vehicleName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetVehicleStatusRequestPaginate

vehicleName

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

GetVehicleStatusResponse

campaigns

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.VehicleStatus]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

IamRegistrationResponse

roleArn

  • Type:
  • Required: Yes

registrationStatus

  • Type: typing.Literal['REGISTRATION_FAILURE', 'REGISTRATION_PENDING', 'REGISTRATION_SUCCESS']
  • Required: Yes

errorMessage

  • Type: typing.Optional[str]

IamResources

roleArn

  • Type:
  • Required: Yes

ImportDecoderManifestRequest

name

  • Type:
  • Required: Yes

networkFileDefinitions

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NetworkFileDefinition]
  • Required: Yes

ImportDecoderManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImportSignalCatalogRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

vss

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.FormattedVss]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]]

ImportSignalCatalogResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListCampaignsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

status

  • Type: typing.Optional[str]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

ListCampaignsRequestPaginate

status

  • Type: typing.Optional[str]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListCampaignsResponse

campaignSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CampaignSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDecoderManifestNetworkInterfacesRequest

name

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDecoderManifestNetworkInterfacesRequestPaginate

name

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListDecoderManifestNetworkInterfacesResponse

networkInterfaces

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NetworkInterface]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDecoderManifestSignalsRequest

name

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDecoderManifestSignalsRequestPaginate

name

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListDecoderManifestSignalsResponse

signalDecoders

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoderOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDecoderManifestSignalsResponsePaginator

signalDecoders

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoderPaginator]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDecoderManifestsRequest

modelManifestArn

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

ListDecoderManifestsRequestPaginate

modelManifestArn

  • Type: typing.Optional[str]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListDecoderManifestsResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.DecoderManifestSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListFleetsForVehicleRequest

vehicleName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListFleetsForVehicleRequestPaginate

vehicleName

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListFleetsForVehicleResponse

fleets

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListFleetsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

ListFleetsRequestPaginate

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListFleetsResponse

fleetSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.FleetSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListModelManifestNodesRequest

name

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListModelManifestNodesRequestPaginate

name

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListModelManifestNodesResponse

nodes

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NodeOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListModelManifestsRequest

signalCatalogArn

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

ListModelManifestsRequestPaginate

signalCatalogArn

  • Type: typing.Optional[str]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListModelManifestsResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ModelManifestSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListSignalCatalogNodesRequest

name

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

signalNodeType

  • Type: typing.Optional[typing.Literal['ACTUATOR', 'ATTRIBUTE', 'BRANCH', 'CUSTOM_PROPERTY', 'CUSTOM_STRUCT', 'SENSOR']]

ListSignalCatalogNodesRequestPaginate

name

  • Type:
  • Required: Yes

signalNodeType

  • Type: typing.Optional[typing.Literal['ACTUATOR', 'ATTRIBUTE', 'BRANCH', 'CUSTOM_PROPERTY', 'CUSTOM_STRUCT', 'SENSOR']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListSignalCatalogNodesResponse

nodes

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NodeOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListSignalCatalogsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListSignalCatalogsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListSignalCatalogsResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalCatalogSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListStateTemplatesRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

ListStateTemplatesRequestPaginate

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListStateTemplatesResponse

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

ResourceARN

  • Type:
  • Required: Yes

ListTagsForResourceResponse

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListVehiclesInFleetRequest

fleetId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListVehiclesInFleetRequestPaginate

fleetId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListVehiclesInFleetResponse

vehicles

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListVehiclesRequest

modelManifestArn

  • Type: typing.Optional[str]

attributeNames

  • Type: typing.Optional[typing.List[str]]

attributeValues

  • Type: typing.Optional[typing.List[str]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

ListVehiclesRequestPaginate

modelManifestArn

  • Type: typing.Optional[str]

attributeNames

  • Type: typing.Optional[typing.List[str]]

attributeValues

  • Type: typing.Optional[typing.List[str]]

listResponseScope

  • Type: typing.Optional[typing.Literal['METADATA_ONLY']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PaginatorConfig]

ListVehiclesResponse

vehicleSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.VehicleSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

MessageSignal

topicName

  • Type:
  • Required: Yes

structuredMessage

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessage, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageOutput]
  • Required: Yes

MessageSignalOutput

topicName

  • Type:
  • Required: Yes

structuredMessage

  • Type:
  • Required: Yes

MessageSignalPaginator

topicName

  • Type:
  • Required: Yes

structuredMessage

  • Type:
  • Required: Yes

ModelManifestSummary

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

name

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

signalCatalogArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DRAFT', 'INVALID', 'VALIDATING']]

MqttTopicConfig

mqttTopicArn

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

NetworkFileDefinition

canDbc

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CanDbcDefinition]

NetworkInterface

interfaceId

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['CAN_INTERFACE', 'CUSTOM_DECODING_INTERFACE', 'OBD_INTERFACE', 'VEHICLE_MIDDLEWARE']
  • Required: Yes

canInterface

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CanInterface]

obdInterface

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ObdInterface]

vehicleMiddleware

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.VehicleMiddleware]

customDecodingInterface

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomDecodingInterface]

Node

branch

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Branch]

sensor

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Sensor, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SensorOutput, NoneType]

actuator

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Actuator, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ActuatorOutput, NoneType]

attribute

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Attribute, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.AttributeOutput, NoneType]

struct

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomStruct]

property

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomProperty]

NodeCounts

totalNodes

  • Type: typing.Optional[int]

totalBranches

  • Type: typing.Optional[int]

totalSensors

  • Type: typing.Optional[int]

totalAttributes

  • Type: typing.Optional[int]

totalActuators

  • Type: typing.Optional[int]

totalStructs

  • Type: typing.Optional[int]

totalProperties

  • Type: typing.Optional[int]

NodeOutput

branch

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Branch]

sensor

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SensorOutput]

actuator

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ActuatorOutput]

attribute

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.AttributeOutput]

struct

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomStruct]

property

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomProperty]

ObdInterface

name

  • Type:
  • Required: Yes

requestMessageId

  • Type:
  • Required: Yes

obdStandard

  • Type: typing.Optional[str]

pidRequestIntervalSeconds

  • Type: typing.Optional[int]

dtcRequestIntervalSeconds

  • Type: typing.Optional[int]

useExtendedIds

  • Type: typing.Optional[bool]

hasTransmissionEcu

  • Type: typing.Optional[bool]

ObdSignal

pidResponseLength

  • Type:
  • Required: Yes

serviceMode

  • Type:
  • Required: Yes

pid

  • Type:
  • Required: Yes

scaling

  • Type:
  • Required: Yes

offset

  • Type:
  • Required: Yes

startByte

  • Type:
  • Required: Yes

byteLength

  • Type:
  • Required: Yes

bitRightShift

  • Type: typing.Optional[int]

bitMaskLength

  • Type: typing.Optional[int]

isSigned

  • Type: typing.Optional[bool]

signalValueType

  • Type: typing.Optional[typing.Literal['FLOATING_POINT', 'INTEGER']]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PeriodicStateTemplateUpdateStrategy

stateTemplateUpdateRate

  • Type:
  • Required: Yes

PrimitiveMessageDefinition

ros2PrimitiveMessageDefinition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ROS2PrimitiveMessageDefinition]

PutEncryptionConfigurationRequest

encryptionType

  • Type: typing.Literal['FLEETWISE_DEFAULT_ENCRYPTION', 'KMS_BASED_ENCRYPTION']
  • Required: Yes

kmsKeyId

  • Type: typing.Optional[str]

PutEncryptionConfigurationResponse

kmsKeyId

  • Type:
  • Required: Yes

encryptionStatus

  • Type: typing.Literal['FAILURE', 'PENDING', 'SUCCESS']
  • Required: Yes

encryptionType

  • Type: typing.Literal['FLEETWISE_DEFAULT_ENCRYPTION', 'KMS_BASED_ENCRYPTION']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutLoggingOptionsRequest

cloudWatchLogDelivery

  • Type:
  • Required: Yes

ROS2PrimitiveMessageDefinition

primitiveType

  • Type: typing.Literal['BOOL', 'BYTE', 'CHAR', 'FLOAT32', 'FLOAT64', 'INT16', 'INT32', 'INT64', 'INT8', 'STRING', 'UINT16', 'UINT32', 'UINT64', 'UINT8', 'WSTRING']
  • Required: Yes

offset

  • Type: typing.Optional[float]

scaling

  • Type: typing.Optional[float]

upperBound

  • Type: typing.Optional[int]

RegisterAccountRequest

timestreamResources

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.TimestreamResources]

iamResources

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.IamResources]

RegisterAccountResponse

registerAccountStatus

  • Type: typing.Literal['REGISTRATION_FAILURE', 'REGISTRATION_PENDING', 'REGISTRATION_SUCCESS']
  • Required: Yes

timestreamResources

  • Type:
  • Required: Yes

iamResources

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

S3Config

bucketArn

  • Type:
  • Required: Yes

dataFormat

  • Type: typing.Optional[typing.Literal['JSON', 'PARQUET']]

storageCompressionFormat

  • Type: typing.Optional[typing.Literal['GZIP', 'NONE']]

prefix

  • Type: typing.Optional[str]

Sensor

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

description

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

allowedValues

  • Type: typing.Optional[typing.List[str]]

min

  • Type: typing.Optional[float]

max

  • Type: typing.Optional[float]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

structFullyQualifiedName

  • Type: typing.Optional[str]

SensorOutput

fullyQualifiedName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'BOOLEAN_ARRAY', 'DOUBLE', 'DOUBLE_ARRAY', 'FLOAT', 'FLOAT_ARRAY', 'INT16', 'INT16_ARRAY', 'INT32', 'INT32_ARRAY', 'INT64', 'INT64_ARRAY', 'INT8', 'INT8_ARRAY', 'STRING', 'STRING_ARRAY', 'STRUCT', 'STRUCT_ARRAY', 'UINT16', 'UINT16_ARRAY', 'UINT32', 'UINT32_ARRAY', 'UINT64', 'UINT64_ARRAY', 'UINT8', 'UINT8_ARRAY', 'UNIX_TIMESTAMP', 'UNIX_TIMESTAMP_ARRAY', 'UNKNOWN']
  • Required: Yes

description

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

allowedValues

  • Type: typing.Optional[typing.List[str]]

min

  • Type: typing.Optional[float]

max

  • Type: typing.Optional[float]

deprecationMessage

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

structFullyQualifiedName

  • Type: typing.Optional[str]

SignalCatalogSummary

name

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastModificationTime

  • Type: typing.Optional[datetime.datetime]

SignalDecoder

fullyQualifiedName

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['CAN_SIGNAL', 'CUSTOM_DECODING_SIGNAL', 'MESSAGE_SIGNAL', 'OBD_SIGNAL']
  • Required: Yes

interfaceId

  • Type:
  • Required: Yes

canSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CanSignal]

obdSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ObdSignal]

messageSignal

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.MessageSignal, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.MessageSignalOutput, NoneType]

customDecodingSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomDecodingSignal]

SignalDecoderOutput

fullyQualifiedName

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['CAN_SIGNAL', 'CUSTOM_DECODING_SIGNAL', 'MESSAGE_SIGNAL', 'OBD_SIGNAL']
  • Required: Yes

interfaceId

  • Type:
  • Required: Yes

canSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CanSignal]

obdSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ObdSignal]

messageSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.MessageSignalOutput]

customDecodingSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomDecodingSignal]

SignalDecoderPaginator

fullyQualifiedName

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['CAN_SIGNAL', 'CUSTOM_DECODING_SIGNAL', 'MESSAGE_SIGNAL', 'OBD_SIGNAL']
  • Required: Yes

interfaceId

  • Type:
  • Required: Yes

canSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CanSignal]

obdSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ObdSignal]

messageSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.MessageSignalPaginator]

customDecodingSignal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.CustomDecodingSignal]

SignalFetchConfig

timeBased

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.TimeBasedSignalFetchConfig]

conditionBased

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.ConditionBasedSignalFetchConfig]

SignalFetchInformation

fullyQualifiedName

  • Type:
  • Required: Yes

signalFetchConfig

  • Type:
  • Required: Yes

actions

  • Type: typing.List[str]
  • Required: Yes

conditionLanguageVersion

  • Type: typing.Optional[int]

SignalFetchInformationOutput

fullyQualifiedName

  • Type:
  • Required: Yes

signalFetchConfig

  • Type:
  • Required: Yes

actions

  • Type: typing.List[str]
  • Required: Yes

conditionLanguageVersion

  • Type: typing.Optional[int]

SignalInformation

name

  • Type:
  • Required: Yes

maxSampleCount

  • Type: typing.Optional[int]

minimumSamplingIntervalMs

  • Type: typing.Optional[int]

dataPartitionId

  • Type: typing.Optional[str]

StateTemplateAssociation

identifier

  • Type:
  • Required: Yes

stateTemplateUpdateStrategy

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateUpdateStrategy, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateUpdateStrategyOutput]
  • Required: Yes

StateTemplateAssociationOutput

identifier

  • Type:
  • Required: Yes

stateTemplateUpdateStrategy

  • Type:
  • Required: Yes

StateTemplateSummary

name

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

signalCatalogArn

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastModificationTime

  • Type: typing.Optional[datetime.datetime]

id

  • Type: typing.Optional[str]

StateTemplateUpdateStrategy

periodic

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PeriodicStateTemplateUpdateStrategy]

onChange

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

StateTemplateUpdateStrategyOutput

periodic

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PeriodicStateTemplateUpdateStrategy]

onChange

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

StorageMaximumSize

unit

  • Type: typing.Literal['GB', 'MB', 'TB']
  • Required: Yes

value

  • Type:
  • Required: Yes

StorageMinimumTimeToLive

unit

  • Type: typing.Literal['DAYS', 'HOURS', 'WEEKS']
  • Required: Yes

value

  • Type:
  • Required: Yes

StructuredMessage

primitiveMessageDefinition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PrimitiveMessageDefinition]

structuredMessageListDefinition

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageListDefinition, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageListDefinitionOutput, NoneType]

structuredMessageDefinition

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageFieldNameAndDataTypePair, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageFieldNameAndDataTypePairOutput]]]

StructuredMessageFieldNameAndDataTypePair

fieldName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

StructuredMessageFieldNameAndDataTypePairOutput

fieldName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

StructuredMessageFieldNameAndDataTypePairPaginator

fieldName

  • Type:
  • Required: Yes

dataType

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

StructuredMessageListDefinition

name

  • Type:
  • Required: Yes

memberType

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

listType

  • Type: typing.Literal['DYNAMIC_BOUNDED_CAPACITY', 'DYNAMIC_UNBOUNDED_CAPACITY', 'FIXED_CAPACITY']
  • Required: Yes

capacity

  • Type: typing.Optional[int]

StructuredMessageListDefinitionOutput

name

  • Type:
  • Required: Yes

memberType

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

listType

  • Type: typing.Literal['DYNAMIC_BOUNDED_CAPACITY', 'DYNAMIC_UNBOUNDED_CAPACITY', 'FIXED_CAPACITY']
  • Required: Yes

capacity

  • Type: typing.Optional[int]

StructuredMessageListDefinitionPaginator

name

  • Type:
  • Required: Yes

memberType

  • Type: typing.Dict[str, typing.Any]
  • Required: Yes

listType

  • Type: typing.Literal['DYNAMIC_BOUNDED_CAPACITY', 'DYNAMIC_UNBOUNDED_CAPACITY', 'FIXED_CAPACITY']
  • Required: Yes

capacity

  • Type: typing.Optional[int]

StructuredMessageOutput

primitiveMessageDefinition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PrimitiveMessageDefinition]

structuredMessageListDefinition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageListDefinitionOutput]

structuredMessageDefinition

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageFieldNameAndDataTypePairOutput]]

StructuredMessagePaginator

primitiveMessageDefinition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.PrimitiveMessageDefinition]

structuredMessageListDefinition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageListDefinitionPaginator]

structuredMessageDefinition

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StructuredMessageFieldNameAndDataTypePairPaginator]]

Tag

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

TagResourceRequest

ResourceARN

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Tag]
  • Required: Yes

TimeBasedCollectionScheme

periodMs

  • Type:
  • Required: Yes

TimeBasedSignalFetchConfig

executionFrequencyMs

  • Type:
  • Required: Yes

TimePeriod

unit

  • Type: typing.Literal['HOUR', 'MILLISECOND', 'MINUTE', 'SECOND']
  • Required: Yes

value

  • Type:
  • Required: Yes

TimestreamConfig

timestreamTableArn

  • Type:
  • Required: Yes

executionRoleArn

  • Type:
  • Required: Yes

TimestreamRegistrationResponse

timestreamDatabaseName

  • Type:
  • Required: Yes

timestreamTableName

  • Type:
  • Required: Yes

registrationStatus

  • Type: typing.Literal['REGISTRATION_FAILURE', 'REGISTRATION_PENDING', 'REGISTRATION_SUCCESS']
  • Required: Yes

timestreamDatabaseArn

  • Type: typing.Optional[str]

timestreamTableArn

  • Type: typing.Optional[str]

errorMessage

  • Type: typing.Optional[str]

TimestreamResources

timestreamDatabaseName

  • Type:
  • Required: Yes

timestreamTableName

  • Type:
  • Required: Yes

UntagResourceRequest

ResourceARN

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateCampaignRequest

name

  • Type:
  • Required: Yes

action

  • Type: typing.Literal['APPROVE', 'RESUME', 'SUSPEND', 'UPDATE']
  • Required: Yes

description

  • Type: typing.Optional[str]

dataExtraDimensions

  • Type: typing.Optional[typing.List[str]]

UpdateCampaignResponse

arn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATING', 'RUNNING', 'SUSPENDED', 'WAITING_FOR_APPROVAL']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDecoderManifestRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

signalDecodersToAdd

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoder, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoderOutput]]]

signalDecodersToUpdate

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoder, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.SignalDecoderOutput]]]

signalDecodersToRemove

  • Type: typing.Optional[typing.List[str]]

networkInterfacesToAdd

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NetworkInterface]]

networkInterfacesToUpdate

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NetworkInterface]]

networkInterfacesToRemove

  • Type: typing.Optional[typing.List[str]]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DRAFT', 'INVALID', 'VALIDATING']]

defaultForUnmappedSignals

  • Type: typing.Optional[typing.Literal['CUSTOM_DECODING']]

UpdateDecoderManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateFleetRequest

fleetId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

UpdateFleetResponse

id

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateModelManifestRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

nodesToAdd

  • Type: typing.Optional[typing.List[str]]

nodesToRemove

  • Type: typing.Optional[typing.List[str]]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DRAFT', 'INVALID', 'VALIDATING']]

UpdateModelManifestResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateSignalCatalogRequest

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

nodesToAdd

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Node, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NodeOutput]]]

nodesToUpdate

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.Node, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.NodeOutput]]]

nodesToRemove

  • Type: typing.Optional[typing.List[str]]

UpdateSignalCatalogResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateStateTemplateRequest

identifier

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

stateTemplatePropertiesToAdd

  • Type: typing.Optional[typing.List[str]]

stateTemplatePropertiesToRemove

  • Type: typing.Optional[typing.List[str]]

dataExtraDimensions

  • Type: typing.Optional[typing.List[str]]

metadataExtraDimensions

  • Type: typing.Optional[typing.List[str]]

UpdateStateTemplateResponse

name

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateVehicleError

vehicleName

  • Type: typing.Optional[str]

code

  • Type: typing.Optional[int]

message

  • Type: typing.Optional[str]

UpdateVehicleRequest

vehicleName

  • Type:
  • Required: Yes

modelManifestArn

  • Type: typing.Optional[str]

decoderManifestArn

  • Type: typing.Optional[str]

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

attributeUpdateMode

  • Type: typing.Optional[typing.Literal['Merge', 'Overwrite']]

stateTemplatesToAdd

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociation, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociationOutput]]]

stateTemplatesToRemove

  • Type: typing.Optional[typing.List[str]]

UpdateVehicleRequestItem

vehicleName

  • Type:
  • Required: Yes

modelManifestArn

  • Type: typing.Optional[str]

decoderManifestArn

  • Type: typing.Optional[str]

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

attributeUpdateMode

  • Type: typing.Optional[typing.Literal['Merge', 'Overwrite']]

stateTemplatesToAdd

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociation, aws_resource_validator.pydantic_models.iotfleetwise.iotfleetwise_classes.StateTemplateAssociationOutput]]]

stateTemplatesToRemove

  • Type: typing.Optional[typing.List[str]]

UpdateVehicleResponse

vehicleName

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateVehicleResponseItem

vehicleName

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

VehicleMiddleware

name

  • Type:
  • Required: Yes

protocolName

  • Type: typing.Literal['ROS_2']
  • Required: Yes

VehicleStatus

campaignName

  • Type: typing.Optional[str]

vehicleName

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['CREATED', 'DELETING', 'HEALTHY', 'READY', 'SUSPENDED']]

VehicleSummary

vehicleName

  • Type:
  • Required: Yes

arn

  • Type:
  • Required: Yes

modelManifestArn

  • Type:
  • Required: Yes

decoderManifestArn

  • Type:
  • Required: Yes

creationTime

  • Type:
  • Required: Yes

lastModificationTime

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Dict[str, str]]