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

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.getDocumentationVersion

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::DocumentationVersion resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

    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 to-be-updated documentation version.
    RestApiId string
    The string identifier of the associated RestApi.
    DocumentationVersion string
    The version identifier of the to-be-updated documentation version.
    RestApiId string
    The string identifier of the associated RestApi.
    documentationVersion String
    The version identifier of the to-be-updated documentation version.
    restApiId String
    The string identifier of the associated RestApi.
    documentationVersion string
    The version identifier of the to-be-updated documentation version.
    restApiId string
    The string identifier of the associated RestApi.
    documentation_version str
    The version identifier of the to-be-updated documentation version.
    rest_api_id str
    The string identifier of the associated RestApi.
    documentationVersion String
    The version identifier of the to-be-updated documentation version.
    restApiId String
    The string identifier of the associated RestApi.

    getDocumentationVersion Result

    The following output properties are available:

    Description string
    A description about the new documentation snapshot.
    Description string
    A description about the new documentation snapshot.
    description String
    A description about the new documentation snapshot.
    description string
    A description about the new documentation snapshot.
    description str
    A description about the new documentation snapshot.
    description String
    A description about the new documentation snapshot.

    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