Contents

module Fog
  module AWS
    class DataPipeline

      class Real

        # Queries a pipeline for the names of objects that match a specified set of conditions.
        # http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribeObjects.html
        # ==== Parameters
        # * PipelineId <~String> - The ID of the pipeline
        # * ObjectIds <~Array> - Identifiers 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.
        # * Options <~Hash> - A Hash of additional options desrcibed in the API docs.
        # ==== Returns
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        def describe_objects(id, objectIds, options={})
          params = options.merge({
            'pipelineId' => id,
            'objectIds' => objectIds,
          })

          response = request({
            :body => Fog::JSON.encode(params),
            :headers => { 'X-Amz-Target' => 'DataPipeline.DescribeObjects' },
          })

          Fog::JSON.decode(response.body)
        end

      end

      class Mock
        def describe_objects(id, objects, options={})
          Fog::Mock.not_implemented
        end
      end

    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
fog-1.22.0	lib/fog/aws/requests/data_pipeline/describe_objects.rb