aws_sdk_ssm/client/
get_maintenance_window_execution_task.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 [`GetMaintenanceWindowExecutionTask`](crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`window_execution_id(impl Into<String>)`](crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder::window_execution_id) / [`set_window_execution_id(Option<String>)`](crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder::set_window_execution_id):<br>required: **true**<br><p>The ID of the maintenance window execution that includes the task.</p><br>
7    ///   - [`task_id(impl Into<String>)`](crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder::set_task_id):<br>required: **true**<br><p>The ID of the specific task execution in the maintenance window task that should be retrieved.</p><br>
8    /// - On success, responds with [`GetMaintenanceWindowExecutionTaskOutput`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput) with field(s):
9    ///   - [`window_execution_id(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::window_execution_id): <p>The ID of the maintenance window execution that includes the task.</p>
10    ///   - [`task_execution_id(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::task_execution_id): <p>The ID of the specific task execution in the maintenance window task that was retrieved.</p>
11    ///   - [`task_arn(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::task_arn): <p>The Amazon Resource Name (ARN) of the task that ran.</p>
12    ///   - [`service_role(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::service_role): <p>The role that was assumed when running the task.</p>
13    ///   - [`r#type(Option<MaintenanceWindowTaskType>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::type): <p>The type of task that was run.</p>
14    ///   - [`task_parameters(Option<Vec::<HashMap::<String, MaintenanceWindowTaskParameterValueExpression>>>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::task_parameters): <p>The parameters passed to the task when it was run.</p><note>  <p><code>TaskParameters</code> has been deprecated. To specify parameters to pass to a task when it runs, instead use the <code>Parameters</code> option in the <code>TaskInvocationParameters</code> structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see <code>MaintenanceWindowTaskInvocationParameters</code>.</p> </note> <p>The map has the following format:</p> <ul>  <li>   <p><code>Key</code>: string, between 1 and 255 characters</p></li>  <li>   <p><code>Value</code>: an array of strings, each between 1 and 255 characters</p></li> </ul>
15    ///   - [`priority(i32)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::priority): <p>The priority of the task.</p>
16    ///   - [`max_concurrency(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::max_concurrency): <p>The defined maximum number of task executions that could be run in parallel.</p>
17    ///   - [`max_errors(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::max_errors): <p>The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.</p>
18    ///   - [`status(Option<MaintenanceWindowExecutionStatus>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::status): <p>The status of the task.</p>
19    ///   - [`status_details(Option<String>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::status_details): <p>The details explaining the status. Not available for all status values.</p>
20    ///   - [`start_time(Option<DateTime>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::start_time): <p>The time the task execution started.</p>
21    ///   - [`end_time(Option<DateTime>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::end_time): <p>The time the task execution completed.</p>
22    ///   - [`alarm_configuration(Option<AlarmConfiguration>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::alarm_configuration): <p>The details for the CloudWatch alarm you applied to your maintenance window task.</p>
23    ///   - [`triggered_alarms(Option<Vec::<AlarmStateInformation>>)`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskOutput::triggered_alarms): <p>The CloudWatch alarms that were invoked by the maintenance window task.</p>
24    /// - On failure, responds with [`SdkError<GetMaintenanceWindowExecutionTaskError>`](crate::operation::get_maintenance_window_execution_task::GetMaintenanceWindowExecutionTaskError)
25    pub fn get_maintenance_window_execution_task(
26        &self,
27    ) -> crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder {
28        crate::operation::get_maintenance_window_execution_task::builders::GetMaintenanceWindowExecutionTaskFluentBuilder::new(self.handle.clone())
29    }
30}
aws_sdk_ssm/client/get_maintenance_window_execution_task.rs

aws_sdk_ssm/client/
get_maintenance_window_execution_task.rs
