aws_sdk_ssm/client/start_execution_preview.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 [`StartExecutionPreview`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`document_name(impl Into<String>)`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::document_name) / [`set_document_name(Option<String>)`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::set_document_name):<br>required: **true**<br><p>The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.</p><br>
7 /// - [`document_version(impl Into<String>)`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::document_version) / [`set_document_version(Option<String>)`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::set_document_version):<br>required: **false**<br><p>The version of the Automation runbook to run. The default value is <code>$DEFAULT</code>.</p><br>
8 /// - [`execution_inputs(ExecutionInputs)`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::execution_inputs) / [`set_execution_inputs(Option<ExecutionInputs>)`](crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::set_execution_inputs):<br>required: **false**<br><p>Information about the inputs that can be specified for the preview operation.</p><br>
9 /// - On success, responds with [`StartExecutionPreviewOutput`](crate::operation::start_execution_preview::StartExecutionPreviewOutput) with field(s):
10 /// - [`execution_preview_id(Option<String>)`](crate::operation::start_execution_preview::StartExecutionPreviewOutput::execution_preview_id): <p>The ID of the execution preview generated by the system.</p>
11 /// - On failure, responds with [`SdkError<StartExecutionPreviewError>`](crate::operation::start_execution_preview::StartExecutionPreviewError)
12 pub fn start_execution_preview(&self) -> crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder {
13 crate::operation::start_execution_preview::builders::StartExecutionPreviewFluentBuilder::new(self.handle.clone())
14 }
15}