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

Class: Aws::DataPipeline::Types::DescribeObjectsInput

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

Overview

Note:

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

{
  pipeline_id: "id", # required
  object_ids: ["id"], # required
  evaluate_expressions: false,
  marker: "string",
}

Contains the parameters for DescribeObjects.

Instance Attribute Summary collapse

Instance Attribute Details

#evaluate_expressionsBoolean

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Returns:

  • (Boolean)


261
262
263
264
265
266
267
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 261

class DescribeObjectsInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :evaluate_expressions,
  :marker)
  include Aws::Structure
end

#markerString

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Returns:

  • (String)


261
262
263
264
265
266
267
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 261

class DescribeObjectsInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :evaluate_expressions,
  :marker)
  include Aws::Structure
end

#object_idsArray<String>

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Returns:

  • (Array<String>)


261
262
263
264
265
266
267
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 261

class DescribeObjectsInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :evaluate_expressions,
  :marker)
  include Aws::Structure
end

#pipeline_idString

The ID of the pipeline that contains the object definitions.

Returns:

  • (String)


261
262
263
264
265
266
267
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 261

class DescribeObjectsInput < Struct.new(
  :pipeline_id,
  :object_ids,
  :evaluate_expressions,
  :marker)
  include Aws::Structure
end