Class: Aws::APIGateway::Types::GetDocumentationPartsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetDocumentationPartsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-apigateway/types.rb
Overview
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#limit ⇒ Integer
The maximum number of returned results per page.
-
#location_status ⇒ String
The status of the API documentation parts to retrieve.
-
#name_query ⇒ String
The name of API entities of the to-be-retrieved documentation parts.
-
#path ⇒ String
The path of API entities of the to-be-retrieved documentation parts.
-
#position ⇒ String
The current pagination position in the paged result set.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
-
#type ⇒ String
The type of API entities of the to-be-retrieved documentation parts.
Instance Attribute Details
#limit ⇒ Integer
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |
#location_status ⇒ String
The status of the API documentation parts to retrieve. Valid values are ‘DOCUMENTED` for retrieving DocumentationPart resources with content and `UNDOCUMENTED` for DocumentationPart resources without content.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |
#name_query ⇒ String
The name of API entities of the to-be-retrieved documentation parts.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |
#path ⇒ String
The path of API entities of the to-be-retrieved documentation parts.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |
#position ⇒ String
The current pagination position in the paged result set.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of API entities of the to-be-retrieved documentation parts.
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 |
# File 'lib/aws-sdk-apigateway/types.rb', line 2563 class GetDocumentationPartsRequest < Struct.new( :rest_api_id, :type, :name_query, :path, :position, :limit, :location_status) SENSITIVE = [] include Aws::Structure end |