You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::DescribeMaintenanceWindowExecutionTaskInvocationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DescribeMaintenanceWindowExecutionTaskInvocationsRequest data as a hash:

{
  window_execution_id: "MaintenanceWindowExecutionId", # required
  task_id: "MaintenanceWindowExecutionTaskId", # required
  filters: [
    {
      key: "MaintenanceWindowFilterKey",
      values: ["MaintenanceWindowFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::MaintenanceWindowFilter>

Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

Returns:



3253
3254
3255
3256
3257
3258
3259
3260
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3253

class DescribeMaintenanceWindowExecutionTaskInvocationsRequest < Struct.new(
  :window_execution_id,
  :task_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

  • (Integer)


3253
3254
3255
3256
3257
3258
3259
3260
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3253

class DescribeMaintenanceWindowExecutionTaskInvocationsRequest < Struct.new(
  :window_execution_id,
  :task_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String)


3253
3254
3255
3256
3257
3258
3259
3260
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3253

class DescribeMaintenanceWindowExecutionTaskInvocationsRequest < Struct.new(
  :window_execution_id,
  :task_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#task_idString

The ID of the specific task in the Maintenance Window task that should be retrieved.

Returns:

  • (String)


3253
3254
3255
3256
3257
3258
3259
3260
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3253

class DescribeMaintenanceWindowExecutionTaskInvocationsRequest < Struct.new(
  :window_execution_id,
  :task_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#window_execution_idString

The ID of the Maintenance Window execution the task is part of.

Returns:

  • (String)


3253
3254
3255
3256
3257
3258
3259
3260
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3253

class DescribeMaintenanceWindowExecutionTaskInvocationsRequest < Struct.new(
  :window_execution_id,
  :task_id,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end