amazonka-iotfleetwise-2.0: Amazon IoT FleetWise SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTFleetWise.GetVehicleStatus

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data GetVehicleStatus Source #

See: newGetVehicleStatus smart constructor.

Constructors

GetVehicleStatus' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of items to return, between 1 and 100, inclusive.

  • nextToken :: Maybe Text

    A pagination token for the next set of results.

    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

  • vehicleName :: Text

    The ID of the vehicle to retrieve information about.

Instances

Instances details
ToJSON GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

toJSON :: GetVehicleStatus -> Value #

toEncoding :: GetVehicleStatus -> Encoding #

toJSONList :: [GetVehicleStatus] -> Value #

toEncodingList :: [GetVehicleStatus] -> Encoding #

ToHeaders GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

toHeaders :: GetVehicleStatus -> [Header] #

ToPath GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

toPath :: GetVehicleStatus -> ByteString #

ToQuery GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

toQuery :: GetVehicleStatus -> QueryString #

AWSPager GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

page :: GetVehicleStatus -> AWSResponse GetVehicleStatus -> Maybe GetVehicleStatus #

AWSRequest GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Associated Types

type AWSResponse GetVehicleStatus #

Methods

request :: (Service -> Service) -> GetVehicleStatus -> Request GetVehicleStatus #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetVehicleStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVehicleStatus))) #

Generic GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Associated Types

type Rep GetVehicleStatus :: Type -> Type #

Methods

from :: GetVehicleStatus -> Rep GetVehicleStatus x #

to :: Rep GetVehicleStatus x -> GetVehicleStatus #

Read GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

readsPrec :: Int -> ReadS GetVehicleStatus #

readList :: ReadS [GetVehicleStatus] #

readPrec :: ReadPrec GetVehicleStatus #

readListPrec :: ReadPrec [GetVehicleStatus] #

Show GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

showsPrec :: Int -> GetVehicleStatus -> ShowS #

show :: GetVehicleStatus -> String #

showList :: [GetVehicleStatus] -> ShowS #

NFData GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

rnf :: GetVehicleStatus -> () #

Eq GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

(==) :: GetVehicleStatus -> GetVehicleStatus -> Bool #

(/=) :: GetVehicleStatus -> GetVehicleStatus -> Bool #

Hashable GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

hashWithSalt :: Int -> GetVehicleStatus -> Int #

hash :: GetVehicleStatus -> Int #

type AWSResponse GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

type AWSResponse GetVehicleStatus = GetVehicleStatusResponse
type Rep GetVehicleStatus Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

type Rep GetVehicleStatus = D1 ('MetaData "GetVehicleStatus" "Amazonka.IoTFleetWise.GetVehicleStatus" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "GetVehicleStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vehicleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetVehicleStatus Source #

Arguments

:: Text

GetVehicleStatus

-> GetVehicleStatus 

Create a value of GetVehicleStatus 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:

$sel:maxResults:GetVehicleStatus', getVehicleStatus_maxResults - The maximum number of items to return, between 1 and 100, inclusive.

GetVehicleStatus, getVehicleStatus_nextToken - A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

GetVehicleStatus, getVehicleStatus_vehicleName - The ID of the vehicle to retrieve information about.

Request Lenses

getVehicleStatus_maxResults :: Lens' GetVehicleStatus (Maybe Natural) Source #

The maximum number of items to return, between 1 and 100, inclusive.

getVehicleStatus_nextToken :: Lens' GetVehicleStatus (Maybe Text) Source #

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

getVehicleStatus_vehicleName :: Lens' GetVehicleStatus Text Source #

The ID of the vehicle to retrieve information about.

Destructuring the Response

data GetVehicleStatusResponse Source #

See: newGetVehicleStatusResponse smart constructor.

Constructors

GetVehicleStatusResponse' 

Fields

Instances

Instances details
Generic GetVehicleStatusResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Associated Types

type Rep GetVehicleStatusResponse :: Type -> Type #

Methods

from :: GetVehicleStatusResponse -> Rep GetVehicleStatusResponse x #

to :: Rep GetVehicleStatusResponse x -> GetVehicleStatusResponse #

Read GetVehicleStatusResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

readsPrec :: Int -> ReadS GetVehicleStatusResponse #

readList :: ReadS [GetVehicleStatusResponse] #

readPrec :: ReadPrec GetVehicleStatusResponse #

readListPrec :: ReadPrec [GetVehicleStatusResponse] #

Show GetVehicleStatusResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

showsPrec :: Int -> GetVehicleStatusResponse -> ShowS #

show :: GetVehicleStatusResponse -> String #

showList :: [GetVehicleStatusResponse] -> ShowS #

NFData GetVehicleStatusResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

rnf :: GetVehicleStatusResponse -> () #

Eq GetVehicleStatusResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

Methods

(==) :: GetVehicleStatusResponse -> GetVehicleStatusResponse -> Bool #

(/=) :: GetVehicleStatusResponse -> GetVehicleStatusResponse -> Bool #

type Rep GetVehicleStatusResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.GetVehicleStatus

type Rep GetVehicleStatusResponse = D1 ('MetaData "GetVehicleStatusResponse" "Amazonka.IoTFleetWise.GetVehicleStatus" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "GetVehicleStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaigns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VehicleStatus])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetVehicleStatusResponse Source #

Arguments

:: Int

$sel:httpStatus:GetVehicleStatusResponse'

-> GetVehicleStatusResponse 

Create a value of GetVehicleStatusResponse 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:

$sel:campaigns:GetVehicleStatusResponse', getVehicleStatusResponse_campaigns - Lists information about the state of the vehicle with deployed campaigns.

GetVehicleStatus, getVehicleStatusResponse_nextToken - The token to retrieve the next set of results, or null if there are no more results.

$sel:httpStatus:GetVehicleStatusResponse', getVehicleStatusResponse_httpStatus - The response's http status code.

Response Lenses

getVehicleStatusResponse_campaigns :: Lens' GetVehicleStatusResponse (Maybe [VehicleStatus]) Source #

Lists information about the state of the vehicle with deployed campaigns.

getVehicleStatusResponse_nextToken :: Lens' GetVehicleStatusResponse (Maybe Text) Source #

The token to retrieve the next set of results, or null if there are no more results.

getVehicleStatusResponse_httpStatus :: Lens' GetVehicleStatusResponse Int Source #

The response's http status code.