GetDocumentationVersion - Amazon API Gateway

GetDocumentationVersion

Gets a documentation version.

Request Syntax

GET /restapis/restapi_id/documentation/versions/doc_version HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

doc_version

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

Required: Yes

restapi_id

The string identifier of the associated RestApi.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdDate": number, "description": "string", "version": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdDate

The date when the API documentation snapshot is created.

Type: Timestamp

description

The description of the API documentation snapshot.

Type: String

version

The version identifier of the API documentation snapshot.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

NotFoundException

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

HTTP Status Code: 404

TooManyRequestsException

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

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: