Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.APIGateway.GetResources

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists information about a collection of Resource resources.

This operation returns paginated results.

Synopsis

Creating a Request

getResources #

Arguments

:: Text	`grsRestAPIId`
-> GetResources

Creates a value of GetResources with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

grsEmbed - A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET restapis{restapi_id}/resources?embed=methods .
grsLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
grsPosition - The current pagination position in the paged result set.
grsRestAPIId - [Required] The string identifier of the associated RestApi .

data GetResources #

Request to list information about a collection of resources.

See: getResources smart constructor.

Instances

Eq GetResources #
Methods (==) :: GetResources -> GetResources -> Bool # (/=) :: GetResources -> GetResources -> Bool #
Data GetResources #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetResources -> c GetResources # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetResources # toConstr :: GetResources -> Constr # dataTypeOf :: GetResources -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetResources) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetResources) # gmapT :: (forall b. Data b => b -> b) -> GetResources -> GetResources # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetResources -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetResources -> r # gmapQ :: (forall d. Data d => d -> u) -> GetResources -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetResources -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetResources -> m GetResources # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetResources -> m GetResources # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetResources -> m GetResources #
Read GetResources #
Methods readsPrec :: Int -> ReadS GetResources # readList :: ReadS [GetResources] # readPrec :: ReadPrec GetResources # readListPrec :: ReadPrec [GetResources] #
Show GetResources #
Methods showsPrec :: Int -> GetResources -> ShowS # show :: GetResources -> String # showList :: [GetResources] -> ShowS #
Generic GetResources #
Associated Types type Rep GetResources :: * -> * # Methods from :: GetResources -> Rep GetResources x # to :: Rep GetResources x -> GetResources #
Hashable GetResources #
Methods hashWithSalt :: Int -> GetResources -> Int # hash :: GetResources -> Int #
NFData GetResources #
Methods rnf :: GetResources -> () #
AWSPager GetResources #
Methods page :: GetResources -> Rs GetResources -> Maybe GetResources #
AWSRequest GetResources #
Associated Types type Rs GetResources :: * # Methods request :: GetResources -> Request GetResources # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetResources -> ClientResponse -> m (Response GetResources) #
ToHeaders GetResources #
Methods toHeaders :: GetResources -> [Header] #
ToPath GetResources #
Methods toPath :: GetResources -> ByteString #
ToQuery GetResources #
Methods toQuery :: GetResources -> QueryString #
type Rep GetResources #
type Rep GetResources = D1 * (MetaData "GetResources" "Network.AWS.APIGateway.GetResources" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" False) (C1 * (MetaCons "GetResources'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_grsEmbed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_grsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((::) (S1 * (MetaSel (Just Symbol "_grsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_grsRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs GetResources #
type Rs GetResources = GetResourcesResponse

Request Lenses

grsEmbed :: Lens' GetResources [Text] #

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET restapis{restapi_id}/resources?embed=methods .

grsLimit :: Lens' GetResources (Maybe Int) #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

grsPosition :: Lens' GetResources (Maybe Text) #

The current pagination position in the paged result set.

grsRestAPIId :: Lens' GetResources Text #

Required: The string identifier of the associated RestApi .

Destructuring the Response

getResourcesResponse #

Arguments

:: Int	`grrsResponseStatus`
-> GetResourcesResponse

Creates a value of GetResourcesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

grrsItems - The current page of elements from this collection.
grrsPosition - Undocumented member.
grrsResponseStatus - -- | The response status code.

data GetResourcesResponse #

Represents a collection of Resource resources.

Create an API

See: getResourcesResponse smart constructor.

Instances

Eq GetResourcesResponse #
Methods (==) :: GetResourcesResponse -> GetResourcesResponse -> Bool # (/=) :: GetResourcesResponse -> GetResourcesResponse -> Bool #
Data GetResourcesResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetResourcesResponse -> c GetResourcesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetResourcesResponse # toConstr :: GetResourcesResponse -> Constr # dataTypeOf :: GetResourcesResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetResourcesResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetResourcesResponse) # gmapT :: (forall b. Data b => b -> b) -> GetResourcesResponse -> GetResourcesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetResourcesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetResourcesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetResourcesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetResourcesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetResourcesResponse -> m GetResourcesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetResourcesResponse -> m GetResourcesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetResourcesResponse -> m GetResourcesResponse #
Read GetResourcesResponse #
Methods readsPrec :: Int -> ReadS GetResourcesResponse # readList :: ReadS [GetResourcesResponse] # readPrec :: ReadPrec GetResourcesResponse # readListPrec :: ReadPrec [GetResourcesResponse] #
Show GetResourcesResponse #
Methods showsPrec :: Int -> GetResourcesResponse -> ShowS # show :: GetResourcesResponse -> String # showList :: [GetResourcesResponse] -> ShowS #
Generic GetResourcesResponse #
Associated Types type Rep GetResourcesResponse :: * -> * # Methods from :: GetResourcesResponse -> Rep GetResourcesResponse x # to :: Rep GetResourcesResponse x -> GetResourcesResponse #
NFData GetResourcesResponse #
Methods rnf :: GetResourcesResponse -> () #
type Rep GetResourcesResponse #
type Rep GetResourcesResponse = D1 * (MetaData "GetResourcesResponse" "Network.AWS.APIGateway.GetResources" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" False) (C1 * (MetaCons "GetResourcesResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_grrsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Resource]))) ((::) (S1 * (MetaSel (Just Symbol "_grrsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_grrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

grrsItems :: Lens' GetResourcesResponse [Resource] #

The current page of elements from this collection.

grrsPosition :: Lens' GetResourcesResponse (Maybe Text) #

Undocumented member.

grrsResponseStatus :: Lens' GetResourcesResponse Int #

- | The response status code.