You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetResourcesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetResourcesRequest
- Defined in:
- (unknown)
Overview
When passing GetResourcesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", # required
position: "String",
limit: 1,
embed: ["String"],
}
Request to list information about a collection of resources.
Instance Attribute Summary collapse
-
#embed ⇒ Array<String>
A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
-
#limit ⇒ Integer
The maximum number of returned results per page.
-
#position ⇒ String
The current pagination position in the paged result set.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
Instance Attribute Details
#embed ⇒ Array<String>
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 ⇒ Integer
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
#position ⇒ String
The current pagination position in the paged result set.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.