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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

This operation returns paginated results.

Synopsis

data ListNetworkResources = ListNetworkResources' {
- filters :: Maybe (HashMap NetworkResourceFilterKeys [Text])
- maxResults :: Maybe Natural
- startToken :: Maybe Text
- networkArn :: Text
}
newListNetworkResources :: Text -> ListNetworkResources
listNetworkResources_filters :: Lens' ListNetworkResources (Maybe (HashMap NetworkResourceFilterKeys [Text]))
listNetworkResources_maxResults :: Lens' ListNetworkResources (Maybe Natural)
listNetworkResources_startToken :: Lens' ListNetworkResources (Maybe Text)
listNetworkResources_networkArn :: Lens' ListNetworkResources Text
data ListNetworkResourcesResponse = ListNetworkResourcesResponse' {
- networkResources :: Maybe [NetworkResource]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListNetworkResourcesResponse :: Int -> ListNetworkResourcesResponse
listNetworkResourcesResponse_networkResources :: Lens' ListNetworkResourcesResponse (Maybe [NetworkResource])
listNetworkResourcesResponse_nextToken :: Lens' ListNetworkResourcesResponse (Maybe Text)
listNetworkResourcesResponse_httpStatus :: Lens' ListNetworkResourcesResponse Int

Creating a Request

data ListNetworkResources Source #

See: newListNetworkResources smart constructor.

Constructors

ListNetworkResources'

Fields

filters :: Maybe (HashMap NetworkResourceFilterKeys [Text])
The filters.
- ORDER - The Amazon Resource Name (ARN) of the order.
- STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).
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.
networkArn :: Text
The Amazon Resource Name (ARN) of the network.

Instances

Instances details

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

newListNetworkResources Source #

Arguments

:: Text	`ListNetworkResources`
-> ListNetworkResources

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

ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).

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:ListNetworkResources', listNetworkResources_maxResults - The maximum number of results to return.

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

ListNetworkResources, listNetworkResources_networkArn - The Amazon Resource Name (ARN) of the network.

Request Lenses

listNetworkResources_filters :: Lens' ListNetworkResources (Maybe (HashMap NetworkResourceFilterKeys [Text])) Source #

The filters.

ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).

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.

listNetworkResources_maxResults :: Lens' ListNetworkResources (Maybe Natural) Source #

The maximum number of results to return.

listNetworkResources_startToken :: Lens' ListNetworkResources (Maybe Text) Source #

The token for the next page of results.

listNetworkResources_networkArn :: Lens' ListNetworkResources Text Source #

The Amazon Resource Name (ARN) of the network.

Destructuring the Response

data ListNetworkResourcesResponse Source #

See: newListNetworkResourcesResponse smart constructor.

Constructors

ListNetworkResourcesResponse'
Fields networkResources :: Maybe [NetworkResource] Information about network resources. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListNetworkResourcesResponse Source #

Arguments

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

Create a value of ListNetworkResourcesResponse 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:networkResources:ListNetworkResourcesResponse', listNetworkResourcesResponse_networkResources - Information about network resources.

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

$sel:httpStatus:ListNetworkResourcesResponse', listNetworkResourcesResponse_httpStatus - The response's http status code.

Response Lenses

listNetworkResourcesResponse_networkResources :: Lens' ListNetworkResourcesResponse (Maybe [NetworkResource]) Source #

Information about network resources.

listNetworkResourcesResponse_nextToken :: Lens' ListNetworkResourcesResponse (Maybe Text) Source #

The token for the next page of results.

listNetworkResourcesResponse_httpStatus :: Lens' ListNetworkResourcesResponse Int Source #

The response's http status code.