Struct aws_sdk_ssm::operation::get_maintenance_window_task::GetMaintenanceWindowTaskOutput

#[non_exhaustive]
pub struct GetMaintenanceWindowTaskOutput {

    pub window_id: Option<String>,
    pub window_task_id: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub task_arn: Option<String>,
    pub service_role_arn: Option<String>,
    pub task_type: Option<MaintenanceWindowTaskType>,
    pub task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>,
    pub task_invocation_parameters: Option<MaintenanceWindowTaskInvocationParameters>,
    pub priority: i32,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub logging_info: Option<LoggingInfo>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub cutoff_behavior: Option<MaintenanceWindowTaskCutoffBehavior>,
    pub alarm_configuration: Option<AlarmConfiguration>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

window_id: Option<String>

The retrieved maintenance window ID.

window_task_id: Option<String>

The retrieved maintenance window task ID.

targets: Option<Vec<Target>>

The targets where the task should run.

task_arn: Option<String>

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

service_role_arn: Option<String>

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

task_type: Option<MaintenanceWindowTaskType>

The type of task to run.

task_parameters: Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>

The parameters to pass to the task when it runs.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

task_invocation_parameters: Option<MaintenanceWindowTaskInvocationParameters>

The parameters to pass to the task when it runs.

priority: i32

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

max_concurrency: Option<String>

The maximum number of targets allowed to run this task in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

max_errors: Option<String>

The maximum number of errors allowed before the task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

logging_info: Option<LoggingInfo>

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

name: Option<String>

The retrieved task name.

description: Option<String>

The retrieved task description.

cutoff_behavior: Option<MaintenanceWindowTaskCutoffBehavior>

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

alarm_configuration: Option<AlarmConfiguration>

The details for the CloudWatch alarm you applied to your maintenance window task.

Implementations

impl GetMaintenanceWindowTaskOutput

pub fn window_id(&self) -> Option<&str>

The retrieved maintenance window ID.

pub fn window_task_id(&self) -> Option<&str>

The retrieved maintenance window task ID.

pub fn targets(&self) -> &[Target]

The targets where the task should run.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none().

pub fn task_arn(&self) -> Option<&str>

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

pub fn service_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

pub fn task_type(&self) -> Option<&MaintenanceWindowTaskType>

The type of task to run.

pub fn task_parameters( &self ) -> Option<&HashMap<String, MaintenanceWindowTaskParameterValueExpression>>

The parameters to pass to the task when it runs.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

pub fn task_invocation_parameters( &self ) -> Option<&MaintenanceWindowTaskInvocationParameters>

The parameters to pass to the task when it runs.

pub fn priority(&self) -> i32

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

pub fn max_concurrency(&self) -> Option<&str>

The maximum number of targets allowed to run this task in parallel.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

pub fn max_errors(&self) -> Option<&str>

The maximum number of errors allowed before the task stops being scheduled.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

pub fn logging_info(&self) -> Option<&LoggingInfo>

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

pub fn name(&self) -> Option<&str>

The retrieved task name.

pub fn description(&self) -> Option<&str>

The retrieved task description.

pub fn cutoff_behavior(&self) -> Option<&MaintenanceWindowTaskCutoffBehavior>

The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

The details for the CloudWatch alarm you applied to your maintenance window task.

impl GetMaintenanceWindowTaskOutput

pub fn builder() -> GetMaintenanceWindowTaskOutputBuilder

Creates a new builder-style object to manufacture GetMaintenanceWindowTaskOutput.

Trait Implementations

impl Clone for GetMaintenanceWindowTaskOutput

fn clone(&self) -> GetMaintenanceWindowTaskOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetMaintenanceWindowTaskOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetMaintenanceWindowTaskOutput

fn eq(&self, other: &GetMaintenanceWindowTaskOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetMaintenanceWindowTaskOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetMaintenanceWindowTaskOutput