aws_sdk_greengrass/client/get_deployment_status.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 [`GetDeploymentStatus`](crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`deployment_id(impl Into<String>)`](crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder::deployment_id) / [`set_deployment_id(Option<String>)`](crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder::set_deployment_id):<br>required: **true**<br>The ID of the deployment.<br>
7 /// - [`group_id(impl Into<String>)`](crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder::set_group_id):<br>required: **true**<br>The ID of the Greengrass group.<br>
8 /// - On success, responds with [`GetDeploymentStatusOutput`](crate::operation::get_deployment_status::GetDeploymentStatusOutput) with field(s):
9 /// - [`deployment_status(Option<String>)`](crate::operation::get_deployment_status::GetDeploymentStatusOutput::deployment_status): The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
10 /// - [`deployment_type(Option<DeploymentType>)`](crate::operation::get_deployment_status::GetDeploymentStatusOutput::deployment_type): The type of the deployment.
11 /// - [`error_details(Option<Vec::<ErrorDetail>>)`](crate::operation::get_deployment_status::GetDeploymentStatusOutput::error_details): Error details
12 /// - [`error_message(Option<String>)`](crate::operation::get_deployment_status::GetDeploymentStatusOutput::error_message): Error message
13 /// - [`updated_at(Option<String>)`](crate::operation::get_deployment_status::GetDeploymentStatusOutput::updated_at): The time, in milliseconds since the epoch, when the deployment status was updated.
14 /// - On failure, responds with [`SdkError<GetDeploymentStatusError>`](crate::operation::get_deployment_status::GetDeploymentStatusError)
15 pub fn get_deployment_status(&self) -> crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder {
16 crate::operation::get_deployment_status::builders::GetDeploymentStatusFluentBuilder::new(self.handle.clone())
17 }
18}