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

Description

Retrieves information for each created fleet in an Amazon Web Services account.

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

See: newListFleets smart constructor.

Constructors

ListFleets' 

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.

Instances

Instances details
ToJSON ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

ToHeaders ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Methods

toHeaders :: ListFleets -> [Header] #

ToPath ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

ToQuery ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

AWSPager ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

AWSRequest ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Associated Types

type AWSResponse ListFleets #

Generic ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Associated Types

type Rep ListFleets :: Type -> Type #

Read ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Show ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

NFData ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Methods

rnf :: ListFleets -> () #

Eq ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Hashable ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

type AWSResponse ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

type Rep ListFleets Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

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

newListFleets :: ListFleets Source #

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

ListFleets, listFleets_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.

Request Lenses

listFleets_maxResults :: Lens' ListFleets (Maybe Natural) Source #

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

listFleets_nextToken :: Lens' ListFleets (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.

Destructuring the Response

data ListFleetsResponse Source #

See: newListFleetsResponse smart constructor.

Constructors

ListFleetsResponse' 

Fields

Instances

Instances details
Generic ListFleetsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Associated Types

type Rep ListFleetsResponse :: Type -> Type #

Read ListFleetsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Show ListFleetsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

NFData ListFleetsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

Methods

rnf :: ListFleetsResponse -> () #

Eq ListFleetsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

type Rep ListFleetsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListFleets

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

newListFleetsResponse Source #

Create a value of ListFleetsResponse 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:fleetSummaries:ListFleetsResponse', listFleetsResponse_fleetSummaries - A list of information for each fleet.

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

$sel:httpStatus:ListFleetsResponse', listFleetsResponse_httpStatus - The response's http status code.

Response Lenses

listFleetsResponse_nextToken :: Lens' ListFleetsResponse (Maybe Text) Source #

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