Skip to content

get_deployment

Operation

get_deployment

get_deployment(request: GetDeploymentInput | GetDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDeploymentInputDict]) -> GetDeploymentOutput

Gets information about a Deployment resource.

Parameters:

Name Type Description Default
request GetDeploymentInput | GetDeploymentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDeploymentOutput

An instance of GetDeploymentOutput.

get_deployment async

get_deployment(request: GetDeploymentInput | GetDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDeploymentInputDict]) -> GetDeploymentOutput

Gets information about a Deployment resource.

Parameters:

Name Type Description Default
request GetDeploymentInput | GetDeploymentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetDeploymentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetDeploymentOutput

An instance of GetDeploymentOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetDeploymentInputDict

Bases: TypedDict

Dictionary form of GetDeploymentInput.

Attributes

deployment_id instance-attribute
deployment_id: Required[str]

The identifier of the Deployment resource to get information about.

embed instance-attribute
embed: Sequence[str] | None

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: Required[str]

The string identifier of the associated RestApi.

GetDeploymentInput dataclass

Bases: _SerdeShape

Requests API Gateway to get information about a Deployment resource.

Attributes

deployment_id class-attribute instance-attribute
deployment_id: str | None = ...

The identifier of the Deployment resource to get information about.

embed class-attribute instance-attribute
embed: list[str] | None = ...

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 class-attribute instance-attribute
rest_api_id: str | None = ...

The string identifier of the associated RestApi.

Output

GetDeploymentOutput dataclass

Bases: _SerdeShape

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

Attributes

api_summary class-attribute instance-attribute
api_summary: dict[str, dict[str, MethodSnapshot]] | None = ...

A summary of the RestApi at the date and time that the deployment resource was created.

created_date class-attribute instance-attribute
created_date: datetime | None = ...

The date and time that the deployment resource was created.

description class-attribute instance-attribute
description: str | None = ...

The description for the deployment resource.

id class-attribute instance-attribute
id: str | None = ...

The identifier for the deployment resource.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.