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

data GetResources = GetResources' {
- embed :: Maybe [Text]
- limit :: Maybe Int
- position :: Maybe Text
- restApiId :: Text
}
newGetResources :: Text -> GetResources
getResources_embed :: Lens' GetResources (Maybe [Text])
getResources_limit :: Lens' GetResources (Maybe Int)
getResources_position :: Lens' GetResources (Maybe Text)
getResources_restApiId :: Lens' GetResources Text
data GetResourcesResponse = GetResourcesResponse' {
- items :: Maybe [Resource]
- position :: Maybe Text
- httpStatus :: Int
}
newGetResourcesResponse :: Int -> GetResourcesResponse
getResourcesResponse_items :: Lens' GetResourcesResponse (Maybe [Resource])
getResourcesResponse_position :: Lens' GetResourcesResponse (Maybe Text)
getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int

Creating a Request

data GetResources Source #

Request to list information about a collection of resources.

See: newGetResources smart constructor.

Constructors

GetResources'

Fields

embed :: Maybe [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.
limit :: Maybe Int
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position :: Maybe Text
The current pagination position in the paged result set.
restApiId :: Text
Required
The string identifier of the associated RestApi.

Instances

Instances details

Eq GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods (==) :: GetResources -> GetResources -> Bool # (/=) :: GetResources -> GetResources -> Bool #
Read GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods readsPrec :: Int -> ReadS GetResources # readList :: ReadS [GetResources] # readPrec :: ReadPrec GetResources # readListPrec :: ReadPrec [GetResources] #
Show GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods showsPrec :: Int -> GetResources -> ShowS # show :: GetResources -> String # showList :: [GetResources] -> ShowS #
Generic GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Associated Types type Rep GetResources :: Type -> Type # Methods from :: GetResources -> Rep GetResources x # to :: Rep GetResources x -> GetResources #
NFData GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods rnf :: GetResources -> () #
Hashable GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods hashWithSalt :: Int -> GetResources -> Int # hash :: GetResources -> Int #
AWSPager GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods page :: GetResources -> AWSResponse GetResources -> Maybe GetResources #
AWSRequest GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Associated Types type AWSResponse GetResources # Methods request :: GetResources -> Request GetResources # response :: MonadResource m => Logger -> Service -> Proxy GetResources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResources))) #
ToHeaders GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods toHeaders :: GetResources -> [Header] #
ToPath GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods toPath :: GetResources -> ByteString #
ToQuery GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods toQuery :: GetResources -> QueryString #
type Rep GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources type Rep GetResources = D1 ('MetaData "GetResources" "Amazonka.APIGateway.GetResources" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetResources'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources type AWSResponse GetResources = GetResourcesResponse

newGetResources Source #

Arguments

:: Text	`$sel:restApiId:GetResources'`
-> GetResources

Create a value of GetResources 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:embed:GetResources', getResources_embed - 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.

$sel:limit:GetResources', getResources_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetResources', getResources_position - The current pagination position in the paged result set.

$sel:restApiId:GetResources', getResources_restApiId - [Required] The string identifier of the associated RestApi.

Request Lenses

getResources_embed :: Lens' GetResources (Maybe [Text]) Source #

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.

getResources_limit :: Lens' GetResources (Maybe Int) Source #

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

getResources_position :: Lens' GetResources (Maybe Text) Source #

The current pagination position in the paged result set.

getResources_restApiId :: Lens' GetResources Text Source #

Required: The string identifier of the associated RestApi.

Destructuring the Response

data GetResourcesResponse Source #

Represents a collection of Resource resources.

Create an API

See: newGetResourcesResponse smart constructor.

Constructors

GetResourcesResponse'
Fields items :: Maybe [Resource] The current page of elements from this collection. position :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods (==) :: GetResourcesResponse -> GetResourcesResponse -> Bool # (/=) :: GetResourcesResponse -> GetResourcesResponse -> Bool #
Read GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods readsPrec :: Int -> ReadS GetResourcesResponse # readList :: ReadS [GetResourcesResponse] # readPrec :: ReadPrec GetResourcesResponse # readListPrec :: ReadPrec [GetResourcesResponse] #
Show GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods showsPrec :: Int -> GetResourcesResponse -> ShowS # show :: GetResourcesResponse -> String # showList :: [GetResourcesResponse] -> ShowS #
Generic GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Associated Types type Rep GetResourcesResponse :: Type -> Type # Methods from :: GetResourcesResponse -> Rep GetResourcesResponse x # to :: Rep GetResourcesResponse x -> GetResourcesResponse #
NFData GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods rnf :: GetResourcesResponse -> () #
type Rep GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources type Rep GetResourcesResponse = D1 ('MetaData "GetResourcesResponse" "Amazonka.APIGateway.GetResources" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourcesResponse Source #

Arguments

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

Create a value of GetResourcesResponse 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:items:GetResourcesResponse', getResourcesResponse_items - The current page of elements from this collection.

$sel:position:GetResources', getResourcesResponse_position - Undocumented member.

$sel:httpStatus:GetResourcesResponse', getResourcesResponse_httpStatus - The response's http status code.

Response Lenses

getResourcesResponse_items :: Lens' GetResourcesResponse (Maybe [Resource]) Source #

The current page of elements from this collection.

getResourcesResponse_position :: Lens' GetResourcesResponse (Maybe Text) Source #

Undocumented member.

getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int Source #

The response's http status code.