Copyright | (c) 2013-2017 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 |
Lists information about a collection of Resource
resources.
This operation returns paginated results.
- getResources :: Text -> GetResources
- data GetResources
- grsEmbed :: Lens' GetResources [Text]
- grsLimit :: Lens' GetResources (Maybe Int)
- grsPosition :: Lens' GetResources (Maybe Text)
- grsRestAPIId :: Lens' GetResources Text
- getResourcesResponse :: Int -> GetResourcesResponse
- data GetResourcesResponse
- grrsItems :: Lens' GetResourcesResponse [Resource]
- grrsPosition :: Lens' GetResourcesResponse (Maybe Text)
- grrsResponseStatus :: Lens' GetResourcesResponse Int
Creating a Request
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 returnedResources
resource in the response. Thisembed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embeddedMethod
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 value is 25 by default and could be between 1 - 500.grsPosition
- The current pagination position in the paged result set.grsRestAPIId
- The string identifier of the associatedRestApi
.
data GetResources Source #
Request to list information about a collection of resources.
See: getResources
smart constructor.
Request Lenses
grsEmbed :: Lens' GetResources [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
.
grsLimit :: Lens' GetResources (Maybe Int) Source #
The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.
grsPosition :: Lens' GetResources (Maybe Text) Source #
The current pagination position in the paged result set.
grsRestAPIId :: Lens' GetResources Text Source #
The string identifier of the associated RestApi
.
Destructuring the Response
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 Source #
Represents a collection of Resource
resources.
See: getResourcesResponse
smart constructor.
Response Lenses
grrsItems :: Lens' GetResourcesResponse [Resource] Source #
The current page of elements from this collection.
grrsPosition :: Lens' GetResourcesResponse (Maybe Text) Source #
Undocumented member.
grrsResponseStatus :: Lens' GetResourcesResponse Int Source #
- - | The response status code.