software.amazon.awssdk.services.ssm.model

Class UpdateMaintenanceWindowTaskResponse

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.UpdateMaintenanceWindowTaskResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateMaintenanceWindowTaskResponse.Builder,UpdateMaintenanceWindowTaskResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateMaintenanceWindowTaskResponse.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 UpdateMaintenanceWindowTaskResponse.Builder	builder()
MaintenanceWindowTaskCutoffBehavior	cutoffBehavior() The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
String	cutoffBehaviorAsString() The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
String	description() The updated 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 updated logging information in Amazon S3.
String	maxConcurrency() The updated MaxConcurrency value.
String	maxErrors() The updated MaxErrors value.
String	name() The updated task name.
Integer	priority() The updated priority value.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateMaintenanceWindowTaskResponse.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 updated target values.
String	taskArn() The updated task ARN value.
MaintenanceWindowTaskInvocationParameters	taskInvocationParameters() The updated parameter values.
Map<String,MaintenanceWindowTaskParameterValueExpression>	taskParameters() The updated parameter values.
UpdateMaintenanceWindowTaskResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	windowId() The ID of the maintenance window that was updated.
String	windowTaskId() The task ID of the maintenance window that was updated.

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 ID of the maintenance window that was updated.

Returns:

The ID of the maintenance window that was updated.

windowTaskId

public final String windowTaskId()

The task ID of the maintenance window that was updated.

Returns:

The task ID of the maintenance window that was updated.

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 updated target values.

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 updated target values.

taskArn

public final String taskArn()

The updated task ARN value.

Returns:

The updated task ARN value.

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.

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 updated parameter values.

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 updated parameter values.

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 updated parameter values.

Returns:

The updated parameter values.

priority

public final Integer priority()

The updated priority value.

Returns:

The updated priority value.

maxConcurrency

public final String maxConcurrency()

The updated MaxConcurrency value.

Returns:

The updated MaxConcurrency value.

maxErrors

public final String maxErrors()

The updated MaxErrors value.

Returns:

The updated MaxErrors value.

loggingInfo

public final LoggingInfo loggingInfo()

The updated logging information in Amazon S3.

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 updated logging information in Amazon S3.

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 updated task name.

Returns:

The updated task name.

description

public final String description()

The updated task description.

Returns:

The updated task description.

cutoffBehavior

public final MaintenanceWindowTaskCutoffBehavior cutoffBehavior()

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

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 specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

See Also:

MaintenanceWindowTaskCutoffBehavior

cutoffBehaviorAsString

public final String cutoffBehaviorAsString()

The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

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 specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

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 UpdateMaintenanceWindowTaskResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateMaintenanceWindowTaskResponse.Builder,UpdateMaintenanceWindowTaskResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static UpdateMaintenanceWindowTaskResponse.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateMaintenanceWindowTaskResponse.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