software.amazon.awssdk.services.ssm.model

Class GetMaintenanceWindowTaskResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssm.model.SsmResponse

software.amazon.awssdk.services.ssm.model.GetMaintenanceWindowTaskResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMaintenanceWindowTaskResponse
extends SsmResponse
implements ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMaintenanceWindowTaskResponse.Builder

Method Summary

Modifier and Type	Method and Description
AlarmConfiguration	alarmConfiguration() The details for the CloudWatch alarm you applied to your maintenance window task.
static GetMaintenanceWindowTaskResponse.Builder	builder()
MaintenanceWindowTaskCutoffBehavior	cutoffBehavior() The action to take on tasks when the maintenance window cutoff time is reached.
String	cutoffBehaviorAsString() The action to take on tasks when the maintenance window cutoff time is reached.
String	description() The retrieved task description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets() For responses, this returns true if the service returned a value for the Targets property.
boolean	hasTaskParameters() For responses, this returns true if the service returned a value for the TaskParameters property.
LoggingInfo	loggingInfo() The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
String	maxConcurrency() The maximum number of targets allowed to run this task in parallel.
String	maxErrors() The maximum number of errors allowed before the task stops being scheduled.
String	name() The retrieved task name.
Integer	priority() The priority of the task when it runs.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMaintenanceWindowTaskResponse.Builder>	serializableBuilderClass()
String	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.
List<Target>	targets() The targets where the task should run.
String	taskArn() The resource that the task used during execution.
MaintenanceWindowTaskInvocationParameters	taskInvocationParameters() The parameters to pass to the task when it runs.
Map<String,MaintenanceWindowTaskParameterValueExpression>	taskParameters() The parameters to pass to the task when it runs.
MaintenanceWindowTaskType	taskType() The type of task to run.
String	taskTypeAsString() The type of task to run.
GetMaintenanceWindowTaskResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	windowId() The retrieved maintenance window ID.
String	windowTaskId() The retrieved maintenance window task ID.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

windowId

public final String windowId()

The retrieved maintenance window ID.

Returns:

The retrieved maintenance window ID.

windowTaskId

public final String windowTaskId()

The retrieved maintenance window task ID.

Returns:

The retrieved maintenance window task ID.

hasTargets

public final boolean hasTargets()

For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targets

public final List<Target> targets()

The targets where the task should run.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargets() method.

Returns:

The targets where the task should run.

taskArn

public final String 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.

Returns:

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.

serviceRoleArn

public final String 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.

Returns:

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.

taskType

public final MaintenanceWindowTaskType taskType()

The type of task to run.

If the service returns an enum value that is not available in the current SDK version, taskType will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskTypeAsString().

Returns:

The type of task to run.

See Also:

MaintenanceWindowTaskType

taskTypeAsString

public final String taskTypeAsString()

The type of task to run.

If the service returns an enum value that is not available in the current SDK version, taskType will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskTypeAsString().

Returns:

The type of task to run.

See Also:

MaintenanceWindowTaskType

hasTaskParameters

public final boolean hasTaskParameters()

For responses, this returns true if the service returned a value for the TaskParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

taskParameters

public final Map<String,MaintenanceWindowTaskParameterValueExpression> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTaskParameters() method.

Returns:

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.

taskInvocationParameters

public final MaintenanceWindowTaskInvocationParameters taskInvocationParameters()

The parameters to pass to the task when it runs.

Returns:

The parameters to pass to the task when it runs.

priority

public final Integer 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.

Returns:

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.

maxConcurrency

public final String 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.

Returns:

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.

maxErrors

public final String 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.

Returns:

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.

loggingInfo

public final LoggingInfo 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.

Returns:

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

public final String name()

The retrieved task name.

Returns:

The retrieved task name.

description

public final String description()

The retrieved task description.

Returns:

The retrieved task description.

cutoffBehavior

public final MaintenanceWindowTaskCutoffBehavior 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.

If the service returns an enum value that is not available in the current SDK version, cutoffBehavior will return MaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cutoffBehaviorAsString().

Returns:

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.

See Also:

MaintenanceWindowTaskCutoffBehavior

cutoffBehaviorAsString

public final String cutoffBehaviorAsString()

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.

If the service returns an enum value that is not available in the current SDK version, cutoffBehavior will return MaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cutoffBehaviorAsString().

Returns:

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.

See Also:

MaintenanceWindowTaskCutoffBehavior

alarmConfiguration

public final AlarmConfiguration alarmConfiguration()

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

Returns:

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

toBuilder

public GetMaintenanceWindowTaskResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetMaintenanceWindowTaskResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetMaintenanceWindowTaskResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo