aws_sdk_apigatewayv2/client/get_deployment.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetDeployment`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`api_id(impl Into<String>)`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::api_id) / [`set_api_id(Option<String>)`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::set_api_id):<br>required: **true**<br><p>The API identifier.</p><br>
7 /// - [`deployment_id(impl Into<String>)`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::deployment_id) / [`set_deployment_id(Option<String>)`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::set_deployment_id):<br>required: **true**<br><p>The deployment ID.</p><br>
8 /// - On success, responds with [`GetDeploymentOutput`](crate::operation::get_deployment::GetDeploymentOutput) with field(s):
9 /// - [`auto_deployed(Option<bool>)`](crate::operation::get_deployment::GetDeploymentOutput::auto_deployed): <p>Specifies whether a deployment was automatically released.</p>
10 /// - [`created_date(Option<DateTime>)`](crate::operation::get_deployment::GetDeploymentOutput::created_date): <p>The date and time when the Deployment resource was created.</p>
11 /// - [`deployment_id(Option<String>)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_id): <p>The identifier for the deployment.</p>
12 /// - [`deployment_status(Option<DeploymentStatus>)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_status): <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
13 /// - [`deployment_status_message(Option<String>)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_status_message): <p>May contain additional feedback on the status of an API deployment.</p>
14 /// - [`description(Option<String>)`](crate::operation::get_deployment::GetDeploymentOutput::description): <p>The description for the deployment.</p>
15 /// - On failure, responds with [`SdkError<GetDeploymentError>`](crate::operation::get_deployment::GetDeploymentError)
16 pub fn get_deployment(&self) -> crate::operation::get_deployment::builders::GetDeploymentFluentBuilder {
17 crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::new(self.handle.clone())
18 }
19}