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

Class: Aws::APIGateway::Types::GetResourceRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetResourceRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  rest_api_id: "String", # required
  resource_id: "String", # required
  embed: ["String"],
}

Request to list information about a resource.

Instance Attribute Summary collapse

Instance Attribute Details

#embedArray<String>

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.

Returns:

  • (Array<String>)

    A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response.

#resource_idString

The identifier for the Resource resource.

Returns:

  • (String)

    The identifier for the Resource resource.

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

    The string identifier of the associated RestApi.