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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

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


3288
3289
3290
3291
3292
3293
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3288

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

#resource_idString

The identifier for the Resource resource.

Returns:

  • (String)


3288
3289
3290
3291
3292
3293
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3288

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


3288
3289
3290
3291
3292
3293
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3288

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