Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTFleetWise.CreateVehicle

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.

If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing.

For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.

Synopsis

data CreateVehicle = CreateVehicle' {
- associationBehavior :: Maybe VehicleAssociationBehavior
- attributes :: Maybe (HashMap Text Text)
- tags :: Maybe [Tag]
- vehicleName :: Text
- modelManifestArn :: Text
- decoderManifestArn :: Text
}
newCreateVehicle :: Text -> Text -> Text -> CreateVehicle
createVehicle_associationBehavior :: Lens' CreateVehicle (Maybe VehicleAssociationBehavior)
createVehicle_attributes :: Lens' CreateVehicle (Maybe (HashMap Text Text))
createVehicle_tags :: Lens' CreateVehicle (Maybe [Tag])
createVehicle_vehicleName :: Lens' CreateVehicle Text
createVehicle_modelManifestArn :: Lens' CreateVehicle Text
createVehicle_decoderManifestArn :: Lens' CreateVehicle Text
data CreateVehicleResponse = CreateVehicleResponse' {
- arn :: Maybe Text
- thingArn :: Maybe Text
- vehicleName :: Maybe Text
- httpStatus :: Int
}
newCreateVehicleResponse :: Int -> CreateVehicleResponse
createVehicleResponse_arn :: Lens' CreateVehicleResponse (Maybe Text)
createVehicleResponse_thingArn :: Lens' CreateVehicleResponse (Maybe Text)
createVehicleResponse_vehicleName :: Lens' CreateVehicleResponse (Maybe Text)
createVehicleResponse_httpStatus :: Lens' CreateVehicleResponse Int

Creating a Request

data CreateVehicle Source #

See: newCreateVehicle smart constructor.

Constructors

CreateVehicle'

Fields

associationBehavior :: Maybe VehicleAssociationBehavior
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.
Default:
attributes :: Maybe (HashMap Text Text)
Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
tags :: Maybe [Tag]
Metadata that can be used to manage the vehicle.
vehicleName :: Text
The unique ID of the vehicle to create.
modelManifestArn :: Text
The Amazon Resource Name ARN of a vehicle model.
decoderManifestArn :: Text
The ARN of a decoder manifest.

Instances

Instances details

ToJSON CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods toJSON :: CreateVehicle -> Value # toEncoding :: CreateVehicle -> Encoding # toJSONList :: [CreateVehicle] -> Value # toEncodingList :: [CreateVehicle] -> Encoding #
ToHeaders CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods toHeaders :: CreateVehicle -> [Header] #
ToPath CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods toPath :: CreateVehicle -> ByteString #
ToQuery CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods toQuery :: CreateVehicle -> QueryString #
AWSRequest CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Associated Types type AWSResponse CreateVehicle # Methods request :: (Service -> Service) -> CreateVehicle -> Request CreateVehicle # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateVehicle -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateVehicle))) #
Generic CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Associated Types type Rep CreateVehicle :: Type -> Type # Methods from :: CreateVehicle -> Rep CreateVehicle x # to :: Rep CreateVehicle x -> CreateVehicle #
Read CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods readsPrec :: Int -> ReadS CreateVehicle # readList :: ReadS [CreateVehicle] # readPrec :: ReadPrec CreateVehicle # readListPrec :: ReadPrec [CreateVehicle] #
Show CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods showsPrec :: Int -> CreateVehicle -> ShowS # show :: CreateVehicle -> String # showList :: [CreateVehicle] -> ShowS #
NFData CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods rnf :: CreateVehicle -> () #
Eq CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods (==) :: CreateVehicle -> CreateVehicle -> Bool # (/=) :: CreateVehicle -> CreateVehicle -> Bool #
Hashable CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods hashWithSalt :: Int -> CreateVehicle -> Int # hash :: CreateVehicle -> Int #
type AWSResponse CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle type AWSResponse CreateVehicle = CreateVehicleResponse
type Rep CreateVehicle Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle type Rep CreateVehicle = D1 ('MetaData "CreateVehicle" "Amazonka.IoTFleetWise.CreateVehicle" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "CreateVehicle'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "associationBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VehicleAssociationBehavior)) :: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: (S1 ('MetaSel ('Just "vehicleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "modelManifestArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "decoderManifestArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateVehicle Source #

Arguments

:: Text	`CreateVehicle`
-> Text	`CreateVehicle`
-> Text	`CreateVehicle`
-> CreateVehicle

Create a value of CreateVehicle with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateVehicle, createVehicle_associationBehavior - An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

Default:

CreateVehicle, createVehicle_attributes - Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"

CreateVehicle, createVehicle_tags - Metadata that can be used to manage the vehicle.

CreateVehicle, createVehicle_vehicleName - The unique ID of the vehicle to create.

CreateVehicle, createVehicle_modelManifestArn - The Amazon Resource Name ARN of a vehicle model.

CreateVehicle, createVehicle_decoderManifestArn - The ARN of a decoder manifest.

Request Lenses

createVehicle_associationBehavior :: Lens' CreateVehicle (Maybe VehicleAssociationBehavior) Source #

An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

Default:

createVehicle_attributes :: Lens' CreateVehicle (Maybe (HashMap Text Text)) Source #

Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"

createVehicle_tags :: Lens' CreateVehicle (Maybe [Tag]) Source #

Metadata that can be used to manage the vehicle.

createVehicle_vehicleName :: Lens' CreateVehicle Text Source #

The unique ID of the vehicle to create.

createVehicle_modelManifestArn :: Lens' CreateVehicle Text Source #

The Amazon Resource Name ARN of a vehicle model.

createVehicle_decoderManifestArn :: Lens' CreateVehicle Text Source #

The ARN of a decoder manifest.

Destructuring the Response

data CreateVehicleResponse Source #

See: newCreateVehicleResponse smart constructor.

Constructors

CreateVehicleResponse'
Fields arn :: Maybe Text The ARN of the created vehicle. thingArn :: Maybe Text The ARN of a created or validated Amazon Web Services IoT thing. vehicleName :: Maybe Text The unique ID of the created vehicle. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateVehicleResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Associated Types type Rep CreateVehicleResponse :: Type -> Type # Methods from :: CreateVehicleResponse -> Rep CreateVehicleResponse x # to :: Rep CreateVehicleResponse x -> CreateVehicleResponse #
Read CreateVehicleResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods readsPrec :: Int -> ReadS CreateVehicleResponse # readList :: ReadS [CreateVehicleResponse] # readPrec :: ReadPrec CreateVehicleResponse # readListPrec :: ReadPrec [CreateVehicleResponse] #
Show CreateVehicleResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods showsPrec :: Int -> CreateVehicleResponse -> ShowS # show :: CreateVehicleResponse -> String # showList :: [CreateVehicleResponse] -> ShowS #
NFData CreateVehicleResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods rnf :: CreateVehicleResponse -> () #
Eq CreateVehicleResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle Methods (==) :: CreateVehicleResponse -> CreateVehicleResponse -> Bool # (/=) :: CreateVehicleResponse -> CreateVehicleResponse -> Bool #
type Rep CreateVehicleResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.CreateVehicle type Rep CreateVehicleResponse = D1 ('MetaData "CreateVehicleResponse" "Amazonka.IoTFleetWise.CreateVehicle" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "CreateVehicleResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "thingArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vehicleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateVehicleResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateVehicleResponse'`
-> CreateVehicleResponse

Create a value of CreateVehicleResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateVehicleResponse, createVehicleResponse_arn - The ARN of the created vehicle.

CreateVehicleResponse, createVehicleResponse_thingArn - The ARN of a created or validated Amazon Web Services IoT thing.

CreateVehicle, createVehicleResponse_vehicleName - The unique ID of the created vehicle.

$sel:httpStatus:CreateVehicleResponse', createVehicleResponse_httpStatus - The response's http status code.

Response Lenses

createVehicleResponse_arn :: Lens' CreateVehicleResponse (Maybe Text) Source #

The ARN of the created vehicle.

createVehicleResponse_thingArn :: Lens' CreateVehicleResponse (Maybe Text) Source #

The ARN of a created or validated Amazon Web Services IoT thing.

createVehicleResponse_vehicleName :: Lens' CreateVehicleResponse (Maybe Text) Source #

The unique ID of the created vehicle.

createVehicleResponse_httpStatus :: Lens' CreateVehicleResponse Int Source #

The response's http status code.