AWS Native v0.54.0, Mar 21 23

aws-native.apigateway.getDocumentationPart

Resource Type definition for AWS::ApiGateway::DocumentationPart

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: The identifier of the documentation Part.
RestApiId string: Identifier of the targeted API entity

DocumentationPartId string: The identifier of the documentation Part.
RestApiId string: Identifier of the targeted API entity

documentationPartId String: The identifier of the documentation Part.
restApiId String: Identifier of the targeted API entity

documentationPartId string: The identifier of the documentation Part.
restApiId string: Identifier of the targeted API entity

documentation_part_id str: The identifier of the documentation Part.
rest_api_id str: Identifier of the targeted API entity

documentationPartId String: The identifier of the documentation Part.
restApiId String: Identifier of the targeted API entity

getDocumentationPart Result

The following output properties are available:

DocumentationPartId string: The identifier of the documentation Part.
Properties string: The documentation content map of the targeted API entity.

DocumentationPartId string: The identifier of the documentation Part.
Properties string: The documentation content map of the targeted API entity.

documentationPartId String: The identifier of the documentation Part.
properties String: The documentation content map of the targeted API entity.

documentationPartId string: The identifier of the documentation Part.
properties string: The documentation content map of the targeted API entity.

documentation_part_id str: The identifier of the documentation Part.
properties str: The documentation content map of the targeted API entity.

documentationPartId String: The identifier of the documentation Part.
properties String: The documentation content map of the targeted API entity.

Package Details

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

aws-native.apigateway.getDocumentationPart

Using getDocumentationPart

getDocumentationPart Result

Package Details

Contents