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.PrivateNetworks.ListNetworks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

This operation returns paginated results.

Creating a Request

data ListNetworks Source #

See: newListNetworks smart constructor.

Constructors

ListNetworks'

Fields

filters :: Maybe (HashMap NetworkFilterKeys [Text])
The filters.
- STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
maxResults :: Maybe Natural
The maximum number of results to return.
startToken :: Maybe Text
The token for the next page of results.

Instances

Instances details

ToJSON ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods toJSON :: ListNetworks -> Value # toEncoding :: ListNetworks -> Encoding # toJSONList :: [ListNetworks] -> Value # toEncodingList :: [ListNetworks] -> Encoding #
ToHeaders ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods toHeaders :: ListNetworks -> [Header] #
ToPath ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods toPath :: ListNetworks -> ByteString #
ToQuery ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods toQuery :: ListNetworks -> QueryString #
AWSPager ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods page :: ListNetworks -> AWSResponse ListNetworks -> Maybe ListNetworks #
AWSRequest ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Associated Types type AWSResponse ListNetworks # Methods request :: (Service -> Service) -> ListNetworks -> Request ListNetworks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListNetworks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListNetworks))) #
Generic ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Associated Types type Rep ListNetworks :: Type -> Type # Methods from :: ListNetworks -> Rep ListNetworks x # to :: Rep ListNetworks x -> ListNetworks #
Read ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods readsPrec :: Int -> ReadS ListNetworks # readList :: ReadS [ListNetworks] # readPrec :: ReadPrec ListNetworks # readListPrec :: ReadPrec [ListNetworks] #
Show ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods showsPrec :: Int -> ListNetworks -> ShowS # show :: ListNetworks -> String # showList :: [ListNetworks] -> ShowS #
NFData ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods rnf :: ListNetworks -> () #
Eq ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods (==) :: ListNetworks -> ListNetworks -> Bool # (/=) :: ListNetworks -> ListNetworks -> Bool #
Hashable ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks Methods hashWithSalt :: Int -> ListNetworks -> Int # hash :: ListNetworks -> Int #
type AWSResponse ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks type AWSResponse ListNetworks = ListNetworksResponse
type Rep ListNetworks Source #
Instance details Defined in Amazonka.PrivateNetworks.ListNetworks type Rep ListNetworks = D1 ('MetaData "ListNetworks" "Amazonka.PrivateNetworks.ListNetworks" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListNetworks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap NetworkFilterKeys [Text]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "startToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListNetworks :: ListNetworks Source #

Create a value of ListNetworks 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:filters:ListNetworks', listNetworks_filters - The filters.

STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

$sel:maxResults:ListNetworks', listNetworks_maxResults - The maximum number of results to return.

$sel:startToken:ListNetworks', listNetworks_startToken - The token for the next page of results.

Request Lenses

listNetworks_filters :: Lens' ListNetworks (Maybe (HashMap NetworkFilterKeys [Text])) Source #

The filters.

STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listNetworks_maxResults :: Lens' ListNetworks (Maybe Natural) Source #

The maximum number of results to return.

listNetworks_startToken :: Lens' ListNetworks (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data ListNetworksResponse Source #

See: newListNetworksResponse smart constructor.

Constructors

ListNetworksResponse'
Fields networks :: Maybe [Network] The networks. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListNetworksResponse Source #

Arguments

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

Create a value of ListNetworksResponse 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:networks:ListNetworksResponse', listNetworksResponse_networks - The networks.

$sel:nextToken:ListNetworksResponse', listNetworksResponse_nextToken - The token for the next page of results.

$sel:httpStatus:ListNetworksResponse', listNetworksResponse_httpStatus - The response's http status code.

Response Lenses

listNetworksResponse_networks :: Lens' ListNetworksResponse (Maybe [Network]) Source #

The networks.

listNetworksResponse_nextToken :: Lens' ListNetworksResponse (Maybe Text) Source #

The token for the next page of results.

listNetworksResponse_httpStatus :: Lens' ListNetworksResponse Int Source #

The response's http status code.