Skip to content

GetDeploymentRequest

Source code in docs_src/capo_api_gateway/types/get_deployment_request.py 
12
13
14
15
16
17
18
class GetDeploymentRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    deployment_id: "capo_api_gateway.types.string.String"
    """<p>The identifier of the Deployment resource to get information about.</p>"""
    embed: NotRequired["capo_api_gateway.types.list_of_string.ListOfString"]
    """<p>A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2</code>. 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 <code>"apisummary"</code> string. For example, <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary</code>.</p>"""

deployment_id instance-attribute 

deployment_id: String

The identifier of the Deployment resource to get information about.

embed instance-attribute 

embed: NotRequired[ListOfString]

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.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.