AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetDocumentationParts operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.APIGateway.AmazonAPIGatewayRequest
      Amazon.APIGateway.Model.GetDocumentationPartsRequest

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class GetDocumentationPartsRequest : AmazonAPIGatewayRequest
         IAmazonWebServiceRequest

The GetDocumentationPartsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Limit System.Int32

Gets and sets the property Limit.

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Public Property LocationStatus Amazon.APIGateway.LocationStatusType

Gets and sets the property LocationStatus.

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.

Public Property NameQuery System.String

Gets and sets the property NameQuery.

The name of API entities of the to-be-retrieved documentation parts.

Public Property Path System.String

Gets and sets the property Path.

The path of API entities of the to-be-retrieved documentation parts.

Public Property Position System.String

Gets and sets the property Position.

The current pagination position in the paged result set.

Public Property RestApiId System.String

Gets and sets the property RestApiId.

[Required] The string identifier of the associated RestApi.

Public Property Type Amazon.APIGateway.DocumentationPartType

Gets and sets the property Type.

The type of API entities of the to-be-retrieved documentation parts.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms