AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the GetMaintenanceWindowTask operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SimpleSystemsManagement.Model.GetMaintenanceWindowTaskResponse

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C# 
public class GetMaintenanceWindowTaskResponse : AmazonWebServiceResponse

The GetMaintenanceWindowTaskResponse type exposes the following members

Constructors

NameDescription
Public Method GetMaintenanceWindowTaskResponse()

Properties

NameTypeDescription
Public Property AlarmConfiguration Amazon.SimpleSystemsManagement.Model.AlarmConfiguration

Gets and sets the property AlarmConfiguration.

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

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CutoffBehavior Amazon.SimpleSystemsManagement.MaintenanceWindowTaskCutoffBehavior

Gets and sets the property CutoffBehavior.

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.

Public Property Description System.String

Gets and sets the property Description.

The retrieved task description.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property LoggingInfo Amazon.SimpleSystemsManagement.Model.LoggingInfo

Gets and sets the property 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.

Public Property MaxConcurrency System.String

Gets and sets the property MaxConcurrency.

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.

Public Property MaxErrors System.String

Gets and sets the property MaxErrors.

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.

Public Property Name System.String

Gets and sets the property Name.

The retrieved task name.

Public Property Priority System.Int32

Gets and sets the property Priority.

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.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

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.

Public Property Targets System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Target>

Gets and sets the property Targets.

The targets where the task should run.

Public Property TaskArn System.String

Gets and sets the property TaskArn.

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.

Public Property TaskInvocationParameters Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskInvocationParameters

Gets and sets the property TaskInvocationParameters.

The parameters to pass to the task when it runs.

Public Property TaskParameters System.Collections.Generic.Dictionary<System.String, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression>

Gets and sets the property TaskParameters.

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.

Public Property TaskType Amazon.SimpleSystemsManagement.MaintenanceWindowTaskType

Gets and sets the property TaskType.

The type of task to run.

Public Property WindowId System.String

Gets and sets the property WindowId.

The retrieved maintenance window ID.

Public Property WindowTaskId System.String

Gets and sets the property WindowTaskId.

The retrieved maintenance window task ID.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5