You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::GetResourcesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass GetResourcesRequest data as a 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

Instance Attribute Details

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

Returns:

  • (Array<String>)


3330
3331
3332
3333
3334
3335
3336
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3330

class GetResourcesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit,
  :embed)
  include Aws::Structure
end

#limitInteger

The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.

Returns:

  • (Integer)


3330
3331
3332
3333
3334
3335
3336
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3330

class GetResourcesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit,
  :embed)
  include Aws::Structure
end

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3330
3331
3332
3333
3334
3335
3336
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3330

class GetResourcesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit,
  :embed)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


3330
3331
3332
3333
3334
3335
3336
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3330

class GetResourcesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit,
  :embed)
  include Aws::Structure
end