aws-native logo
AWS Native v0.54.0, Mar 21 23

aws-native.apigateway.getDocumentationVersion

A snapshot of the documentation of an API.

Using getDocumentationVersion

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 getDocumentationVersion(args: GetDocumentationVersionArgs, opts?: InvokeOptions): Promise<GetDocumentationVersionResult>
function getDocumentationVersionOutput(args: GetDocumentationVersionOutputArgs, opts?: InvokeOptions): Output<GetDocumentationVersionResult>
def get_documentation_version(documentation_version: Optional[str] = None,
                              rest_api_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDocumentationVersionResult
def get_documentation_version_output(documentation_version: Optional[pulumi.Input[str]] = None,
                              rest_api_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDocumentationVersionResult]
func LookupDocumentationVersion(ctx *Context, args *LookupDocumentationVersionArgs, opts ...InvokeOption) (*LookupDocumentationVersionResult, error)
func LookupDocumentationVersionOutput(ctx *Context, args *LookupDocumentationVersionOutputArgs, opts ...InvokeOption) LookupDocumentationVersionResultOutput

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

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

The following arguments are supported:

DocumentationVersionValue string

The version identifier of the API documentation snapshot.

RestApiId string

The identifier of the API.

DocumentationVersion string

The version identifier of the API documentation snapshot.

RestApiId string

The identifier of the API.

documentationVersion String

The version identifier of the API documentation snapshot.

restApiId String

The identifier of the API.

documentationVersion string

The version identifier of the API documentation snapshot.

restApiId string

The identifier of the API.

documentation_version str

The version identifier of the API documentation snapshot.

rest_api_id str

The identifier of the API.

documentationVersion String

The version identifier of the API documentation snapshot.

restApiId String

The identifier of the API.

getDocumentationVersion Result

The following output properties are available:

Description string

The description of the API documentation snapshot.

Description string

The description of the API documentation snapshot.

description String

The description of the API documentation snapshot.

description string

The description of the API documentation snapshot.

description str

The description of the API documentation snapshot.

description String

The description of the API documentation snapshot.

Package Details

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