1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. getDocumentationPart

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.apigateway.getDocumentationPart

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

    Using getDocumentationPart

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDocumentationPart(args: GetDocumentationPartArgs, opts?: InvokeOptions): Promise<GetDocumentationPartResult>
    function getDocumentationPartOutput(args: GetDocumentationPartOutputArgs, opts?: InvokeOptions): Output<GetDocumentationPartResult>
    def get_documentation_part(documentation_part_id: Optional[str] = None,
                               rest_api_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetDocumentationPartResult
    def get_documentation_part_output(documentation_part_id: Optional[pulumi.Input[str]] = None,
                               rest_api_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetDocumentationPartResult]
    func LookupDocumentationPart(ctx *Context, args *LookupDocumentationPartArgs, opts ...InvokeOption) (*LookupDocumentationPartResult, error)
    func LookupDocumentationPartOutput(ctx *Context, args *LookupDocumentationPartOutputArgs, opts ...InvokeOption) LookupDocumentationPartResultOutput

    > Note: This function is named LookupDocumentationPart in the Go SDK.

    public static class GetDocumentationPart 
    {
        public static Task<GetDocumentationPartResult> InvokeAsync(GetDocumentationPartArgs args, InvokeOptions? opts = null)
        public static Output<GetDocumentationPartResult> Invoke(GetDocumentationPartInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDocumentationPartResult> getDocumentationPart(GetDocumentationPartArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:apigateway:getDocumentationPart
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DocumentationPartId string
    RestApiId string
    The string identifier of the associated RestApi.
    DocumentationPartId string
    RestApiId string
    The string identifier of the associated RestApi.
    documentationPartId String
    restApiId String
    The string identifier of the associated RestApi.
    documentationPartId string
    restApiId string
    The string identifier of the associated RestApi.
    documentation_part_id str
    rest_api_id str
    The string identifier of the associated RestApi.
    documentationPartId String
    restApiId String
    The string identifier of the associated RestApi.

    getDocumentationPart Result

    The following output properties are available:

    DocumentationPartId string
    Properties string
    The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
    DocumentationPartId string
    Properties string
    The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
    documentationPartId String
    properties String
    The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
    documentationPartId string
    properties string
    The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
    documentation_part_id str
    properties str
    The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
    documentationPartId String
    properties String
    The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi