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

Class: Aws::CodePipeline::Types::PollForJobsInput

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

Overview

Note:

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

{
  action_type_id: { # required
    category: "Source", # required, accepts Source, Build, Deploy, Test, Invoke, Approval
    owner: "AWS", # required, accepts AWS, ThirdParty, Custom
    provider: "ActionProvider", # required
    version: "Version", # required
  },
  max_batch_size: 1,
  query_param: {
    "ActionConfigurationKey" => "ActionConfigurationQueryableValue",
  },
}

Represents the input of a poll for jobs action.

Instance Attribute Summary collapse

Instance Attribute Details

#action_type_idTypes::ActionTypeId

Represents information about an action type.

Returns:



2065
2066
2067
2068
2069
2070
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2065

class PollForJobsInput < Struct.new(
  :action_type_id,
  :max_batch_size,
  :query_param)
  include Aws::Structure
end

#max_batch_sizeInteger

The maximum number of jobs to return in a poll for jobs call.

Returns:

  • (Integer)


2065
2066
2067
2068
2069
2070
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2065

class PollForJobsInput < Struct.new(
  :action_type_id,
  :max_batch_size,
  :query_param)
  include Aws::Structure
end

#query_paramHash<String,String>

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.

Returns:

  • (Hash<String,String>)


2065
2066
2067
2068
2069
2070
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2065

class PollForJobsInput < Struct.new(
  :action_type_id,
  :max_batch_size,
  :query_param)
  include Aws::Structure
end