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

Description

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

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 ListFleetsForVehicle Source #

See: newListFleetsForVehicle smart constructor.

Constructors

ListFleetsForVehicle' 

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 ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

ToHeaders ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

ToPath ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

ToQuery ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

AWSPager ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

AWSRequest ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Associated Types

type AWSResponse ListFleetsForVehicle #

Generic ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Associated Types

type Rep ListFleetsForVehicle :: Type -> Type #

Read ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Show ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

NFData ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Methods

rnf :: ListFleetsForVehicle -> () #

Eq ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Hashable ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

type AWSResponse ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

type Rep ListFleetsForVehicle Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

type Rep ListFleetsForVehicle = D1 ('MetaData "ListFleetsForVehicle" "Amazonka.IoTFleetWise.ListFleetsForVehicle" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "ListFleetsForVehicle'" '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))))

newListFleetsForVehicle Source #

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

ListFleetsForVehicle, listFleetsForVehicle_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.

ListFleetsForVehicle, listFleetsForVehicle_vehicleName - The ID of the vehicle to retrieve information about.

Request Lenses

listFleetsForVehicle_maxResults :: Lens' ListFleetsForVehicle (Maybe Natural) Source #

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

listFleetsForVehicle_nextToken :: Lens' ListFleetsForVehicle (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.

listFleetsForVehicle_vehicleName :: Lens' ListFleetsForVehicle Text Source #

The ID of the vehicle to retrieve information about.

Destructuring the Response

data ListFleetsForVehicleResponse Source #

See: newListFleetsForVehicleResponse smart constructor.

Constructors

ListFleetsForVehicleResponse' 

Fields

  • fleets :: Maybe [Text]

    A list of fleet IDs that the vehicle is associated with.

  • nextToken :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListFleetsForVehicleResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Associated Types

type Rep ListFleetsForVehicleResponse :: Type -> Type #

Read ListFleetsForVehicleResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Show ListFleetsForVehicleResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

NFData ListFleetsForVehicleResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

Eq ListFleetsForVehicleResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

type Rep ListFleetsForVehicleResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleetsForVehicle

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

newListFleetsForVehicleResponse Source #

Create a value of ListFleetsForVehicleResponse 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:fleets:ListFleetsForVehicleResponse', listFleetsForVehicleResponse_fleets - A list of fleet IDs that the vehicle is associated with.

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

$sel:httpStatus:ListFleetsForVehicleResponse', listFleetsForVehicleResponse_httpStatus - The response's http status code.

Response Lenses

listFleetsForVehicleResponse_fleets :: Lens' ListFleetsForVehicleResponse (Maybe [Text]) Source #

A list of fleet IDs that the vehicle is associated with.

listFleetsForVehicleResponse_nextToken :: Lens' ListFleetsForVehicleResponse (Maybe Text) Source #

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