Class: Aws::APIGateway::Types::GetResourcesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetResourcesRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
Request to list information about a collection of resources.
Constant Summary collapse
- SENSITIVE =
[]
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
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
.
2842 2843 2844 2845 2846 2847 2848 2849 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2842 class GetResourcesRequest < Struct.new( :rest_api_id, :position, :limit, :embed) SENSITIVE = [] include Aws::Structure end |
#limit ⇒ Integer
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2842 2843 2844 2845 2846 2847 2848 2849 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2842 class GetResourcesRequest < Struct.new( :rest_api_id, :position, :limit, :embed) SENSITIVE = [] include Aws::Structure end |
#position ⇒ String
The current pagination position in the paged result set.
2842 2843 2844 2845 2846 2847 2848 2849 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2842 class GetResourcesRequest < Struct.new( :rest_api_id, :position, :limit, :embed) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
2842 2843 2844 2845 2846 2847 2848 2849 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2842 class GetResourcesRequest < Struct.new( :rest_api_id, :position, :limit, :embed) SENSITIVE = [] include Aws::Structure end |