Amazon API Gateway REST API Reference

Resource

Represents an API resource.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
resource:update

Update an API resource represented by a Resource instance only.

PATCH No
resource:delete

Deletes an API resource represented by a Resource instance.

DELETE No
resource:create-child

Creates a child API resource of a given API resource.

POST No
method:by-http-method

Gets the method (as a Method resource) on a specified API resource (as Resource resource) of the given HTTP method type.

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

  • http_method: Required.

    Specifies the method request's HTTP method type.

GET Yes
method:put

Create a Method resource on a specified Resource resource.

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

  • http_method: Required.

    Specifies the method request's HTTP method type.

PUT Yes
resource:methods

Gets an API resource's method of a given HTTP verb.

GET No


Properties

{
  "id" : "String",
  "parentId" : "String",
  "pathPart" : "String",
  "path" : "String"
}

  • id
  • The resource's identifier.

  • parentId
  • The parent resource's identifier.

  • pathPart
  • The last path segment for this resource.

  • path
  • The full path for this resource.

Remarks

See Also

Create an API