Amazon API Gateway REST API Reference

Resources

Represents a collection of Resource resources.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
resource:by-id

Gets an API resource of the given resource identifier.

This link relation offers the following templated variable(s):

  • resource_id: Required.

    The identifier for the Resource resource.

  • embed: Optional.

    A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

GET Yes
resource:create

Creates a Resource resource.

This link relation offers the following templated variable(s):

  • parent_id: Required.

    The parent resource's identifier.

POST Yes
next

Gets the next Resource resource in the collection. This is not valid for the last Resource in a collection.

GET No
first

Gets the first Resource resource in the collection.

GET No
item

Gets the current Resource resource in the collection.

GET No


Properties

The Resources resource does not have any properties.

Remarks

See Also

Create an API