Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTFleetWise.ListSignalCatalogNodes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists of information about the signals (nodes) 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

data ListSignalCatalogNodes = ListSignalCatalogNodes' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- name :: Text
}
newListSignalCatalogNodes :: Text -> ListSignalCatalogNodes
listSignalCatalogNodes_maxResults :: Lens' ListSignalCatalogNodes (Maybe Natural)
listSignalCatalogNodes_nextToken :: Lens' ListSignalCatalogNodes (Maybe Text)
listSignalCatalogNodes_name :: Lens' ListSignalCatalogNodes Text
data ListSignalCatalogNodesResponse = ListSignalCatalogNodesResponse' {
- nextToken :: Maybe Text
- nodes :: Maybe [Node]
- httpStatus :: Int
}
newListSignalCatalogNodesResponse :: Int -> ListSignalCatalogNodesResponse
listSignalCatalogNodesResponse_nextToken :: Lens' ListSignalCatalogNodesResponse (Maybe Text)
listSignalCatalogNodesResponse_nodes :: Lens' ListSignalCatalogNodesResponse (Maybe [Node])
listSignalCatalogNodesResponse_httpStatus :: Lens' ListSignalCatalogNodesResponse Int

Creating a Request

data ListSignalCatalogNodes Source #

See: newListSignalCatalogNodes smart constructor.

Constructors

ListSignalCatalogNodes'

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.
name :: Text
The name of the signal catalog to list information about.

Instances

Instances details

ToJSON ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods toJSON :: ListSignalCatalogNodes -> Value # toEncoding :: ListSignalCatalogNodes -> Encoding # toJSONList :: [ListSignalCatalogNodes] -> Value # toEncodingList :: [ListSignalCatalogNodes] -> Encoding #
ToHeaders ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods toHeaders :: ListSignalCatalogNodes -> [Header] #
ToPath ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods toPath :: ListSignalCatalogNodes -> ByteString #
ToQuery ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods toQuery :: ListSignalCatalogNodes -> QueryString #
AWSPager ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods page :: ListSignalCatalogNodes -> AWSResponse ListSignalCatalogNodes -> Maybe ListSignalCatalogNodes #
AWSRequest ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Associated Types type AWSResponse ListSignalCatalogNodes # Methods request :: (Service -> Service) -> ListSignalCatalogNodes -> Request ListSignalCatalogNodes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSignalCatalogNodes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSignalCatalogNodes))) #
Generic ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Associated Types type Rep ListSignalCatalogNodes :: Type -> Type # Methods from :: ListSignalCatalogNodes -> Rep ListSignalCatalogNodes x # to :: Rep ListSignalCatalogNodes x -> ListSignalCatalogNodes #
Read ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods readsPrec :: Int -> ReadS ListSignalCatalogNodes # readList :: ReadS [ListSignalCatalogNodes] # readPrec :: ReadPrec ListSignalCatalogNodes # readListPrec :: ReadPrec [ListSignalCatalogNodes] #
Show ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods showsPrec :: Int -> ListSignalCatalogNodes -> ShowS # show :: ListSignalCatalogNodes -> String # showList :: [ListSignalCatalogNodes] -> ShowS #
NFData ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods rnf :: ListSignalCatalogNodes -> () #
Eq ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods (==) :: ListSignalCatalogNodes -> ListSignalCatalogNodes -> Bool # (/=) :: ListSignalCatalogNodes -> ListSignalCatalogNodes -> Bool #
Hashable ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods hashWithSalt :: Int -> ListSignalCatalogNodes -> Int # hash :: ListSignalCatalogNodes -> Int #
type AWSResponse ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes type AWSResponse ListSignalCatalogNodes = ListSignalCatalogNodesResponse
type Rep ListSignalCatalogNodes Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes type Rep ListSignalCatalogNodes = D1 ('MetaData "ListSignalCatalogNodes" "Amazonka.IoTFleetWise.ListSignalCatalogNodes" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "ListSignalCatalogNodes'" '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 "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSignalCatalogNodes Source #

Arguments

:: Text	`ListSignalCatalogNodes`
-> ListSignalCatalogNodes

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

ListSignalCatalogNodes, listSignalCatalogNodes_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.

ListSignalCatalogNodes, listSignalCatalogNodes_name - The name of the signal catalog to list information about.

Request Lenses

listSignalCatalogNodes_maxResults :: Lens' ListSignalCatalogNodes (Maybe Natural) Source #

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

listSignalCatalogNodes_nextToken :: Lens' ListSignalCatalogNodes (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.

listSignalCatalogNodes_name :: Lens' ListSignalCatalogNodes Text Source #

The name of the signal catalog to list information about.

Destructuring the Response

data ListSignalCatalogNodesResponse Source #

See: newListSignalCatalogNodesResponse smart constructor.

Constructors

ListSignalCatalogNodesResponse'
Fields nextToken :: Maybe Text The token to retrieve the next set of results, or `null` if there are no more results. nodes :: Maybe [Node] A list of information about nodes. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListSignalCatalogNodesResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Associated Types type Rep ListSignalCatalogNodesResponse :: Type -> Type # Methods from :: ListSignalCatalogNodesResponse -> Rep ListSignalCatalogNodesResponse x # to :: Rep ListSignalCatalogNodesResponse x -> ListSignalCatalogNodesResponse #
Read ListSignalCatalogNodesResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods readsPrec :: Int -> ReadS ListSignalCatalogNodesResponse # readList :: ReadS [ListSignalCatalogNodesResponse] # readPrec :: ReadPrec ListSignalCatalogNodesResponse # readListPrec :: ReadPrec [ListSignalCatalogNodesResponse] #
Show ListSignalCatalogNodesResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods showsPrec :: Int -> ListSignalCatalogNodesResponse -> ShowS # show :: ListSignalCatalogNodesResponse -> String # showList :: [ListSignalCatalogNodesResponse] -> ShowS #
NFData ListSignalCatalogNodesResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods rnf :: ListSignalCatalogNodesResponse -> () #
Eq ListSignalCatalogNodesResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes Methods (==) :: ListSignalCatalogNodesResponse -> ListSignalCatalogNodesResponse -> Bool # (/=) :: ListSignalCatalogNodesResponse -> ListSignalCatalogNodesResponse -> Bool #
type Rep ListSignalCatalogNodesResponse Source #
Instance details Defined in Amazonka.IoTFleetWise.ListSignalCatalogNodes type Rep ListSignalCatalogNodesResponse = D1 ('MetaData "ListSignalCatalogNodesResponse" "Amazonka.IoTFleetWise.ListSignalCatalogNodes" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "ListSignalCatalogNodesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Node])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSignalCatalogNodesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSignalCatalogNodesResponse'`
-> ListSignalCatalogNodesResponse

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

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

$sel:nodes:ListSignalCatalogNodesResponse', listSignalCatalogNodesResponse_nodes - A list of information about nodes.

$sel:httpStatus:ListSignalCatalogNodesResponse', listSignalCatalogNodesResponse_httpStatus - The response's http status code.

Response Lenses

listSignalCatalogNodesResponse_nextToken :: Lens' ListSignalCatalogNodesResponse (Maybe Text) Source #

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

listSignalCatalogNodesResponse_nodes :: Lens' ListSignalCatalogNodesResponse (Maybe [Node]) Source #

A list of information about nodes.

listSignalCatalogNodesResponse_httpStatus :: Lens' ListSignalCatalogNodesResponse Int Source #

The response's http status code.