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

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

Overview

Note:

When making an API call, you may pass GetResourceRequest data as a hash:

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

Request to list information about a resource.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#embed ⇒ Array<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>) 


3991
3992
3993
3994
3995
3996
3997
 
# File 'lib/aws-sdk-apigateway/types.rb', line 3991

class GetResourceRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :embed)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

[Required] The identifier for the Resource resource.

Returns:

  • (String) 


3991
3992
3993
3994
3995
3996
3997
 
# File 'lib/aws-sdk-apigateway/types.rb', line 3991

class GetResourceRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :embed)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) 


3991
3992
3993
3994
3995
3996
3997
 
# File 'lib/aws-sdk-apigateway/types.rb', line 3991

class GetResourceRequest < Struct.new(
  :rest_api_id,
  :resource_id,
  :embed)
  SENSITIVE = []
  include Aws::Structure
end