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

Description

Lists all the created signal catalogs in an Amazon Web Services account.

You can use to list information about each signal (node) specified in a signal catalog.

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

See: newListSignalCatalogs smart constructor.

Constructors

ListSignalCatalogs' 

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

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

toJSON :: ListSignalCatalogs -> Value #

toEncoding :: ListSignalCatalogs -> Encoding #

toJSONList :: [ListSignalCatalogs] -> Value #

toEncodingList :: [ListSignalCatalogs] -> Encoding #

ToHeaders ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

toHeaders :: ListSignalCatalogs -> [Header] #

ToPath ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

toPath :: ListSignalCatalogs -> ByteString #

ToQuery ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

toQuery :: ListSignalCatalogs -> QueryString #

AWSPager ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

page :: ListSignalCatalogs -> AWSResponse ListSignalCatalogs -> Maybe ListSignalCatalogs #

AWSRequest ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Associated Types

type AWSResponse ListSignalCatalogs #

Methods

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

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

Generic ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Associated Types

type Rep ListSignalCatalogs :: Type -> Type #

Methods

from :: ListSignalCatalogs -> Rep ListSignalCatalogs x #

to :: Rep ListSignalCatalogs x -> ListSignalCatalogs #

Read ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

readsPrec :: Int -> ReadS ListSignalCatalogs #

readList :: ReadS [ListSignalCatalogs] #

readPrec :: ReadPrec ListSignalCatalogs #

readListPrec :: ReadPrec [ListSignalCatalogs] #

Show ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

showsPrec :: Int -> ListSignalCatalogs -> ShowS #

show :: ListSignalCatalogs -> String #

showList :: [ListSignalCatalogs] -> ShowS #

NFData ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

rnf :: ListSignalCatalogs -> () #

Eq ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

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

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

Hashable ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

hashWithSalt :: Int -> ListSignalCatalogs -> Int #

hash :: ListSignalCatalogs -> Int #

type AWSResponse ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

type AWSResponse ListSignalCatalogs = ListSignalCatalogsResponse
type Rep ListSignalCatalogs Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

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

newListSignalCatalogs :: ListSignalCatalogs Source #

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

ListSignalCatalogs, listSignalCatalogs_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

listSignalCatalogs_maxResults :: Lens' ListSignalCatalogs (Maybe Natural) Source #

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

listSignalCatalogs_nextToken :: Lens' ListSignalCatalogs (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 ListSignalCatalogsResponse Source #

See: newListSignalCatalogsResponse smart constructor.

Constructors

ListSignalCatalogsResponse' 

Fields

Instances

Instances details
Generic ListSignalCatalogsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Associated Types

type Rep ListSignalCatalogsResponse :: Type -> Type #

Methods

from :: ListSignalCatalogsResponse -> Rep ListSignalCatalogsResponse x #

to :: Rep ListSignalCatalogsResponse x -> ListSignalCatalogsResponse #

Read ListSignalCatalogsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

readsPrec :: Int -> ReadS ListSignalCatalogsResponse #

readList :: ReadS [ListSignalCatalogsResponse] #

readPrec :: ReadPrec ListSignalCatalogsResponse #

readListPrec :: ReadPrec [ListSignalCatalogsResponse] #

Show ListSignalCatalogsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

showsPrec :: Int -> ListSignalCatalogsResponse -> ShowS #

show :: ListSignalCatalogsResponse -> String #

showList :: [ListSignalCatalogsResponse] -> ShowS #

NFData ListSignalCatalogsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

rnf :: ListSignalCatalogsResponse -> () #

Eq ListSignalCatalogsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

Methods

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

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

type Rep ListSignalCatalogsResponse Source # 
Instance details

Defined in Amazonka.IoTFleetWise.ListSignalCatalogs

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

newListSignalCatalogsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListSignalCatalogsResponse'

-> ListSignalCatalogsResponse 

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

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

$sel:summaries:ListSignalCatalogsResponse', listSignalCatalogsResponse_summaries - A list of information about each signal catalog.

$sel:httpStatus:ListSignalCatalogsResponse', listSignalCatalogsResponse_httpStatus - The response's http status code.

Response Lenses

listSignalCatalogsResponse_nextToken :: Lens' ListSignalCatalogsResponse (Maybe Text) Source #

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

listSignalCatalogsResponse_summaries :: Lens' ListSignalCatalogsResponse (Maybe [SignalCatalogSummary]) Source #

A list of information about each signal catalog.

listSignalCatalogsResponse_httpStatus :: Lens' ListSignalCatalogsResponse Int Source #

The response's http status code.