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

Description

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

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

This operation returns paginated results.

Synopsis

Creating a Request

data ListVehiclesInFleet Source #

See: newListVehiclesInFleet smart constructor.

Constructors

ListVehiclesInFleet' 

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.

  • fleetId :: Text

    The ID of a fleet.

Instances

Instances details
ToJSON ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

toJSON :: ListVehiclesInFleet -> Value #

toEncoding :: ListVehiclesInFleet -> Encoding #

toJSONList :: [ListVehiclesInFleet] -> Value #

toEncodingList :: [ListVehiclesInFleet] -> Encoding #

ToHeaders ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

toHeaders :: ListVehiclesInFleet -> [Header] #

ToPath ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

toPath :: ListVehiclesInFleet -> ByteString #

ToQuery ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

toQuery :: ListVehiclesInFleet -> QueryString #

AWSPager ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

page :: ListVehiclesInFleet -> AWSResponse ListVehiclesInFleet -> Maybe ListVehiclesInFleet #

AWSRequest ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Associated Types

type AWSResponse ListVehiclesInFleet #

Methods

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

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

Generic ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Associated Types

type Rep ListVehiclesInFleet :: Type -> Type #

Methods

from :: ListVehiclesInFleet -> Rep ListVehiclesInFleet x #

to :: Rep ListVehiclesInFleet x -> ListVehiclesInFleet #

Read ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

readsPrec :: Int -> ReadS ListVehiclesInFleet #

readList :: ReadS [ListVehiclesInFleet] #

readPrec :: ReadPrec ListVehiclesInFleet #

readListPrec :: ReadPrec [ListVehiclesInFleet] #

Show ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

showsPrec :: Int -> ListVehiclesInFleet -> ShowS #

show :: ListVehiclesInFleet -> String #

showList :: [ListVehiclesInFleet] -> ShowS #

NFData ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

rnf :: ListVehiclesInFleet -> () #

Eq ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

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

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

Hashable ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

hashWithSalt :: Int -> ListVehiclesInFleet -> Int #

hash :: ListVehiclesInFleet -> Int #

type AWSResponse ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

type AWSResponse ListVehiclesInFleet = ListVehiclesInFleetResponse
type Rep ListVehiclesInFleet Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

type Rep ListVehiclesInFleet = D1 ('MetaData "ListVehiclesInFleet" "Amazonka.IoTFleetWise.ListVehiclesInFleet" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "ListVehiclesInFleet'" '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 "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListVehiclesInFleet Source #

Arguments

:: Text

$sel:fleetId:ListVehiclesInFleet'

-> ListVehiclesInFleet 

Create a value of ListVehiclesInFleet 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:ListVehiclesInFleet', listVehiclesInFleet_maxResults - The maximum number of items to return, between 1 and 100, inclusive.

ListVehiclesInFleet, listVehiclesInFleet_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.

$sel:fleetId:ListVehiclesInFleet', listVehiclesInFleet_fleetId - The ID of a fleet.

Request Lenses

listVehiclesInFleet_maxResults :: Lens' ListVehiclesInFleet (Maybe Natural) Source #

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

listVehiclesInFleet_nextToken :: Lens' ListVehiclesInFleet (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.

listVehiclesInFleet_fleetId :: Lens' ListVehiclesInFleet Text Source #

The ID of a fleet.

Destructuring the Response

data ListVehiclesInFleetResponse Source #

See: newListVehiclesInFleetResponse smart constructor.

Constructors

ListVehiclesInFleetResponse' 

Fields

Instances

Instances details
Generic ListVehiclesInFleetResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Associated Types

type Rep ListVehiclesInFleetResponse :: Type -> Type #

Methods

from :: ListVehiclesInFleetResponse -> Rep ListVehiclesInFleetResponse x #

to :: Rep ListVehiclesInFleetResponse x -> ListVehiclesInFleetResponse #

Read ListVehiclesInFleetResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

readsPrec :: Int -> ReadS ListVehiclesInFleetResponse #

readList :: ReadS [ListVehiclesInFleetResponse] #

readPrec :: ReadPrec ListVehiclesInFleetResponse #

readListPrec :: ReadPrec [ListVehiclesInFleetResponse] #

Show ListVehiclesInFleetResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

showsPrec :: Int -> ListVehiclesInFleetResponse -> ShowS #

show :: ListVehiclesInFleetResponse -> String #

showList :: [ListVehiclesInFleetResponse] -> ShowS #

NFData ListVehiclesInFleetResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

rnf :: ListVehiclesInFleetResponse -> () #

Eq ListVehiclesInFleetResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

Methods

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

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

type Rep ListVehiclesInFleetResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListVehiclesInFleet

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

newListVehiclesInFleetResponse Source #

Arguments

:: Int

$sel:httpStatus:ListVehiclesInFleetResponse'

-> ListVehiclesInFleetResponse 

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

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

$sel:vehicles:ListVehiclesInFleetResponse', listVehiclesInFleetResponse_vehicles - A list of vehicles associated with the fleet.

$sel:httpStatus:ListVehiclesInFleetResponse', listVehiclesInFleetResponse_httpStatus - The response's http status code.

Response Lenses

listVehiclesInFleetResponse_nextToken :: Lens' ListVehiclesInFleetResponse (Maybe Text) Source #

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

listVehiclesInFleetResponse_vehicles :: Lens' ListVehiclesInFleetResponse (Maybe [Text]) Source #

A list of vehicles associated with the fleet.

listVehiclesInFleetResponse_httpStatus :: Lens' ListVehiclesInFleetResponse Int Source #

The response's http status code.