get_documentation_version ¶

get_documentation_version(
    rest_api_id: String,
    documentation_version: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
) -> DocumentationVersion

Gets a documentation version.

Parameters:

rest_api_id (String) –

The string identifier of the associated RestApi.
documentation_version (String) –

The version identifier of the to-be-retrieved documentation snapshot.

Raises:

NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def get_documentation_version(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    documentation_version: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
) -> "capo_api_gateway.types.documentation_version.DocumentationVersion":
    """<p>Gets a documentation version.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        documentation_version: <p>The version identifier of the to-be-retrieved documentation snapshot.</p>

    Raises:
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.get_documentation_version_request.GetDocumentationVersionRequest]",
    ) -> OperationResponse[
        "capo_api_gateway.types.documentation_version.DocumentationVersion"
    ]:
        import capo_api_gateway._operations.backplane_control_service.get_documentation_version

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.get_documentation_version.get_documentation_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDocumentationVersion")
    )
    input_: capo_api_gateway.types.get_documentation_version_request.GetDocumentationVersionRequest = {
        "rest_api_id": rest_api_id,
        "documentation_version": documentation_version,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output