Skip to main content

aws_sdk_networksecuritymanager/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    ///   - [`deployment_identifier(impl Into<String>)`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::deployment_identifier) / [`set_deployment_identifier(Option<String>)`](crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::set_deployment_identifier):<br>required: **true**<br><p>The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).</p><br>
7    /// - On success, responds with [`GetDeploymentOutput`](crate::operation::get_deployment::GetDeploymentOutput) with field(s):
8    ///   - [`deployment_id(String)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_id): <p>The service-generated id of the deployment.</p>
9    ///   - [`deployment_arn(String)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_arn): <p>The Amazon Resource Name (ARN) of the deployment.</p>
10    ///   - [`deployment_name(String)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_name): <p>The name of the deployment.</p>
11    ///   - [`deployment_description(Option<String>)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_description): <p>A description of the deployment.</p>
12    ///   - [`status(EntityStatus)`](crate::operation::get_deployment::GetDeploymentOutput::status): <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable), <code>ACTIVE</code> (published, in use), or <code>DISABLED</code> (deactivated; changes cannot be published until the resource is re-enabled).</p>
13    ///   - [`deployment_configuration(Option<DeploymentConfiguration>)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_configuration): <p>The configuration settings for the deployment.</p>
14    ///   - [`associated_policy_list(Vec::<AssociatedPolicy>)`](crate::operation::get_deployment::GetDeploymentOutput::associated_policy_list): <p>The policies associated with the deployment.</p>
15    ///   - [`associated_scope_list(Vec::<AssociatedScope>)`](crate::operation::get_deployment::GetDeploymentOutput::associated_scope_list): <p>The scope associated with the deployment. A deployment has exactly one scope.</p>
16    ///   - [`version(String)`](crate::operation::get_deployment::GetDeploymentOutput::version): <p>The version of the resource.</p>
17    ///   - [`update_token(Option<String>)`](crate::operation::get_deployment::GetDeploymentOutput::update_token): <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
18    ///   - [`is_snapshot(Option<bool>)`](crate::operation::get_deployment::GetDeploymentOutput::is_snapshot): <p>Specifies whether the resource is a snapshot of a published version.</p>
19    ///   - [`has_published_version(Option<bool>)`](crate::operation::get_deployment::GetDeploymentOutput::has_published_version): <p>Specifies whether a published version of the resource exists.</p>
20    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_deployment::GetDeploymentOutput::updated_at): <p>The time when the resource was last updated.</p>
21    ///   - [`deployment_coverage(Option<Vec::<DeploymentCoverageEntry>>)`](crate::operation::get_deployment::GetDeploymentOutput::deployment_coverage): <p>The coverage information for the deployment. For each firewall type, it shows which policies have that firewall type and which in-scope resource types the firewall type protects.</p>
22    ///   - [`warnings(Option<Vec::<DeploymentWarningEntry>>)`](crate::operation::get_deployment::GetDeploymentOutput::warnings): <p>Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.</p>
23    /// - On failure, responds with [`SdkError<GetDeploymentError>`](crate::operation::get_deployment::GetDeploymentError)
24    pub fn get_deployment(&self) -> crate::operation::get_deployment::builders::GetDeploymentFluentBuilder {
25        crate::operation::get_deployment::builders::GetDeploymentFluentBuilder::new(self.handle.clone())
26    }
27}