GetMaintenanceWindowTaskResult

import type { GetMaintenanceWindowTaskResult } from "https://aws-api.deno.dev/v0.3/services/ssm.ts?docs=full";

interface GetMaintenanceWindowTaskResult {

CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | null;

Description?: string | null;

LoggingInfo?: LoggingInfo | null;

MaxConcurrency?: string | null;

MaxErrors?: string | null;

Name?: string | null;

Priority?: number | null;

ServiceRoleArn?: string | null;

Targets?: Target[] | null;

TaskArn?: string | null;

TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | null;

TaskParameters?: {

[key: string]: MaintenanceWindowTaskParameterValueExpression | null | undefined;

} | null;

TaskType?: MaintenanceWindowTaskType | null;

WindowId?: string | null;

WindowTaskId?: string | null;

}

§Properties

CutoffBehavior?: MaintenanceWindowTaskCutoffBehavior | null

[src]

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.

Description?: string | null

[src]

The retrieved task description.

LoggingInfo?: LoggingInfo | null

[src]

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

Note: 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".

MaxConcurrency?: string | null

[src]

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

Note: 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.

MaxErrors?: string | null

[src]

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

Name?: string | null

[src]

The retrieved task name.

Priority?: number | null

[src]

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.

ServiceRoleArn?: string | null

[src]

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.

Targets?: Target[] | null

[src]

The targets where the task should run.

TaskArn?: string | null

[src]

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.

TaskInvocationParameters?: MaintenanceWindowTaskInvocationParameters | null

[src]

The parameters to pass to the task when it runs.

TaskParameters?: {

[key: string]: MaintenanceWindowTaskParameterValueExpression | null | undefined;

} | null

[src]

The parameters to pass to the task when it runs.

Note: 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".

TaskType?: MaintenanceWindowTaskType | null

[src]

The type of task to run.

WindowId?: string | null

[src]

The retrieved maintenance window ID.

WindowTaskId?: string | null

[src]

The retrieved maintenance window task ID.