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

Class: Aws::SSM::Types::DescribeAutomationStepExecutionsRequest

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 DescribeAutomationStepExecutionsRequest data as a hash:

{
  automation_execution_id: "AutomationExecutionId", # required
  filters: [
    {
      key: "StartTimeBefore", # required, accepts StartTimeBefore, StartTimeAfter, StepExecutionStatus, StepExecutionId, StepName, Action
      values: ["StepExecutionFilterValue"], # required
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  reverse_order: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#automation_execution_idString

The Automation execution ID for which you want step execution descriptions.

Returns:

  • (String)


3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3169

class DescribeAutomationStepExecutionsRequest < Struct.new(
  :automation_execution_id,
  :filters,
  :next_token,
  :max_results,
  :reverse_order)
  include Aws::Structure
end

#filtersArray<Types::StepExecutionFilter>

One or more filters to limit the number of step executions returned by the request.

Returns:



3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3169

class DescribeAutomationStepExecutionsRequest < Struct.new(
  :automation_execution_id,
  :filters,
  :next_token,
  :max_results,
  :reverse_order)
  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)


3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3169

class DescribeAutomationStepExecutionsRequest < Struct.new(
  :automation_execution_id,
  :filters,
  :next_token,
  :max_results,
  :reverse_order)
  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)


3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3169

class DescribeAutomationStepExecutionsRequest < Struct.new(
  :automation_execution_id,
  :filters,
  :next_token,
  :max_results,
  :reverse_order)
  include Aws::Structure
end

#reverse_orderBoolean

A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.

Returns:

  • (Boolean)


3169
3170
3171
3172
3173
3174
3175
3176
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3169

class DescribeAutomationStepExecutionsRequest < Struct.new(
  :automation_execution_id,
  :filters,
  :next_token,
  :max_results,
  :reverse_order)
  include Aws::Structure
end