GetDeploymentRequest

import type { GetDeploymentRequest } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

Requests API Gateway to get information about a "Deployment" resource.

interface GetDeploymentRequest {

deploymentId: string;

embed?: string[] | null;

restApiId: string;

}

§Properties

deploymentId: string

[src]

[Required] The identifier of the "Deployment" resource to get information about.

embed?: string[] | null

[src]

A query parameter to retrieve the specified embedded resources of the returned "Deployment" resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

restApiId: string

[src]

[Required] The string identifier of the associated "RestApi".