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
show all
Defined in:
(unknown)

Overview

Note:

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

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

    A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.

#limitInteger

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

Returns:

  • (Integer)

    The maximum number of returned results per page.

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)

    The current pagination position in the paged result set.

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

    The string identifier of the associated RestApi.