Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Panorama.ListNodes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of nodes.

Synopsis

data ListNodes = ListNodes' {
- patchVersion :: Maybe Text
- packageName :: Maybe Text
- packageVersion :: Maybe Text
- category :: Maybe NodeCategory
- nextToken :: Maybe Text
- ownerAccount :: Maybe Text
- maxResults :: Maybe Natural
}
newListNodes :: ListNodes
listNodes_patchVersion :: Lens' ListNodes (Maybe Text)
listNodes_packageName :: Lens' ListNodes (Maybe Text)
listNodes_packageVersion :: Lens' ListNodes (Maybe Text)
listNodes_category :: Lens' ListNodes (Maybe NodeCategory)
listNodes_nextToken :: Lens' ListNodes (Maybe Text)
listNodes_ownerAccount :: Lens' ListNodes (Maybe Text)
listNodes_maxResults :: Lens' ListNodes (Maybe Natural)
data ListNodesResponse = ListNodesResponse' {
- nextToken :: Maybe Text
- nodes :: Maybe [Node]
- httpStatus :: Int
}
newListNodesResponse :: Int -> ListNodesResponse
listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text)
listNodesResponse_nodes :: Lens' ListNodesResponse (Maybe [Node])
listNodesResponse_httpStatus :: Lens' ListNodesResponse Int

Creating a Request

data ListNodes Source #

See: newListNodes smart constructor.

Constructors

ListNodes'

Fields

patchVersion :: Maybe Text
Search for nodes by patch version.
packageName :: Maybe Text
Search for nodes by name.
packageVersion :: Maybe Text
Search for nodes by version.
category :: Maybe NodeCategory
Search for nodes by category.
nextToken :: Maybe Text
Specify the pagination token from a previous request to retrieve the next page of results.
ownerAccount :: Maybe Text
Search for nodes by the account ID of the nodes' owner.
maxResults :: Maybe Natural
The maximum number of nodes to return in one page of results.

Instances

Instances details

Eq ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods (==) :: ListNodes -> ListNodes -> Bool # (/=) :: ListNodes -> ListNodes -> Bool #
Read ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods readsPrec :: Int -> ReadS ListNodes # readList :: ReadS [ListNodes] # readPrec :: ReadPrec ListNodes # readListPrec :: ReadPrec [ListNodes] #
Show ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods showsPrec :: Int -> ListNodes -> ShowS # show :: ListNodes -> String # showList :: [ListNodes] -> ShowS #
Generic ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Associated Types type Rep ListNodes :: Type -> Type # Methods from :: ListNodes -> Rep ListNodes x # to :: Rep ListNodes x -> ListNodes #
NFData ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods rnf :: ListNodes -> () #
Hashable ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods hashWithSalt :: Int -> ListNodes -> Int # hash :: ListNodes -> Int #
AWSRequest ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Associated Types type AWSResponse ListNodes # Methods request :: ListNodes -> Request ListNodes # response :: MonadResource m => Logger -> Service -> Proxy ListNodes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListNodes))) #
ToHeaders ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods toHeaders :: ListNodes -> [Header] #
ToPath ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods toPath :: ListNodes -> ByteString #
ToQuery ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods toQuery :: ListNodes -> QueryString #
type Rep ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes type Rep ListNodes = D1 ('MetaData "ListNodes" "Amazonka.Panorama.ListNodes" "libZSservicesZSamazonka-panoramaZSamazonka-panorama" 'False) (C1 ('MetaCons "ListNodes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "packageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "packageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeCategory)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListNodes Source #
Instance details Defined in Amazonka.Panorama.ListNodes type AWSResponse ListNodes = ListNodesResponse

newListNodes :: ListNodes Source #

Create a value of ListNodes 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:patchVersion:ListNodes', listNodes_patchVersion - Search for nodes by patch version.

$sel:packageName:ListNodes', listNodes_packageName - Search for nodes by name.

$sel:packageVersion:ListNodes', listNodes_packageVersion - Search for nodes by version.

$sel:category:ListNodes', listNodes_category - Search for nodes by category.

$sel:nextToken:ListNodes', listNodes_nextToken - Specify the pagination token from a previous request to retrieve the next page of results.

$sel:ownerAccount:ListNodes', listNodes_ownerAccount - Search for nodes by the account ID of the nodes' owner.

$sel:maxResults:ListNodes', listNodes_maxResults - The maximum number of nodes to return in one page of results.

Request Lenses

listNodes_patchVersion :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by patch version.

listNodes_packageName :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by name.

listNodes_packageVersion :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by version.

listNodes_category :: Lens' ListNodes (Maybe NodeCategory) Source #

Search for nodes by category.

listNodes_nextToken :: Lens' ListNodes (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listNodes_ownerAccount :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by the account ID of the nodes' owner.

listNodes_maxResults :: Lens' ListNodes (Maybe Natural) Source #

The maximum number of nodes to return in one page of results.

Destructuring the Response

data ListNodesResponse Source #

See: newListNodesResponse smart constructor.

Constructors

ListNodesResponse'
Fields nextToken :: Maybe Text A pagination token that's included if more results are available. nodes :: Maybe [Node] A list of nodes. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListNodesResponse Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods (==) :: ListNodesResponse -> ListNodesResponse -> Bool # (/=) :: ListNodesResponse -> ListNodesResponse -> Bool #
Read ListNodesResponse Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods readsPrec :: Int -> ReadS ListNodesResponse # readList :: ReadS [ListNodesResponse] # readPrec :: ReadPrec ListNodesResponse # readListPrec :: ReadPrec [ListNodesResponse] #
Show ListNodesResponse Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods showsPrec :: Int -> ListNodesResponse -> ShowS # show :: ListNodesResponse -> String # showList :: [ListNodesResponse] -> ShowS #
Generic ListNodesResponse Source #
Instance details Defined in Amazonka.Panorama.ListNodes Associated Types type Rep ListNodesResponse :: Type -> Type # Methods from :: ListNodesResponse -> Rep ListNodesResponse x # to :: Rep ListNodesResponse x -> ListNodesResponse #
NFData ListNodesResponse Source #
Instance details Defined in Amazonka.Panorama.ListNodes Methods rnf :: ListNodesResponse -> () #
type Rep ListNodesResponse Source #
Instance details Defined in Amazonka.Panorama.ListNodes type Rep ListNodesResponse = D1 ('MetaData "ListNodesResponse" "Amazonka.Panorama.ListNodes" "libZSservicesZSamazonka-panoramaZSamazonka-panorama" 'False) (C1 ('MetaCons "ListNodesResponse'" '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))))

newListNodesResponse Source #

Arguments

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

Create a value of ListNodesResponse 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:nextToken:ListNodes', listNodesResponse_nextToken - A pagination token that's included if more results are available.

$sel:nodes:ListNodesResponse', listNodesResponse_nodes - A list of nodes.

$sel:httpStatus:ListNodesResponse', listNodesResponse_httpStatus - The response's http status code.

Response Lenses

listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

listNodesResponse_nodes :: Lens' ListNodesResponse (Maybe [Node]) Source #

A list of nodes.

listNodesResponse_httpStatus :: Lens' ListNodesResponse Int Source #

The response's http status code.