Struct aws_sdk_ssm::output::GetMaintenanceWindowTaskOutput [−][src]
#[non_exhaustive]pub struct GetMaintenanceWindowTaskOutput {Show 15 fields
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>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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.
Implementations
The retrieved maintenance window task ID.
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.
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.
The type of task to run.
pub fn task_parameters(
&self
) -> Option<&HashMap<String, MaintenanceWindowTaskParameterValueExpression>>
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>
pub fn task_invocation_parameters(
&self
) -> Option<&MaintenanceWindowTaskInvocationParameters>
The parameters to pass to the task when it runs.
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.
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.
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.
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.
The retrieved task description.
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.
Creates a new builder-style object to manufacture GetMaintenanceWindowTaskOutput
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl Send for GetMaintenanceWindowTaskOutput
impl Sync for GetMaintenanceWindowTaskOutput
impl Unpin for GetMaintenanceWindowTaskOutput
impl UnwindSafe for GetMaintenanceWindowTaskOutput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more