Class GetMaintenanceWindowTaskResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,
GetMaintenanceWindowTaskResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AlarmConfiguration
The details for the CloudWatch alarm you applied to your maintenance window task.builder()
The action to take on tasks when the maintenance window cutoff time is reached.final String
The action to take on tasks when the maintenance window cutoff time is reached.final String
The retrieved task description.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Targets property.final boolean
For responses, this returns true if the service returned a value for the TaskParameters property.final LoggingInfo
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.final String
The maximum number of targets allowed to run this task in parallel.final String
The maximum number of errors allowed before the task stops being scheduled.final String
name()
The retrieved task name.final Integer
priority()
The priority of the task when it runs.static Class
<? extends GetMaintenanceWindowTaskResponse.Builder> final 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.targets()
The targets where the task should run.final String
taskArn()
The resource that the task used during execution.The parameters to pass to the task when it runs.The parameters to pass to the task when it runs.taskType()
The type of task to run.final String
The type of task to run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
windowId()
The retrieved maintenance window ID.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
windowId
The retrieved maintenance window ID.
- Returns:
- The retrieved maintenance window ID.
-
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 theisEmpty()
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
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
The resource that the task used during execution. For
RUN_COMMAND
andAUTOMATION
task types, the value ofTaskArn
is the SSM document name/ARN. ForLAMBDA
tasks, the value is the function name/ARN. ForSTEP_FUNCTIONS
tasks, the value is the state machine ARN.- Returns:
- The resource that the task used during execution. For
RUN_COMMAND
andAUTOMATION
task types, the value ofTaskArn
is the SSM document name/ARN. ForLAMBDA
tasks, the value is the function name/ARN. ForSTEP_FUNCTIONS
tasks, the value is the state machine ARN.
-
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
The type of task to run.
If the service returns an enum value that is not available in the current SDK version,
taskType
will returnMaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- The type of task to run.
- See Also:
-
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 returnMaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskTypeAsString()
.- Returns:
- The type of task to run.
- See Also:
-
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 theisEmpty()
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
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 theParameters
option in theTaskInvocationParameters
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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
-
taskInvocationParameters
The parameters to pass to the task when it runs.
- Returns:
- The parameters to pass to the task when it runs.
-
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
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
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
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 theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
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 theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
-
name
The retrieved task name.
- Returns:
- The retrieved task name.
-
description
The retrieved task description.
- Returns:
- The retrieved task description.
-
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 aCancelCommand
operation.If the service returns an enum value that is not available in the current SDK version,
cutoffBehavior
will returnMaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcutoffBehaviorAsString()
.- 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 aCancelCommand
operation. - See Also:
-
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 aCancelCommand
operation.If the service returns an enum value that is not available in the current SDK version,
cutoffBehavior
will returnMaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcutoffBehaviorAsString()
.- 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 aCancelCommand
operation. - See Also:
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,
GetMaintenanceWindowTaskResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-