Initialize connection to DataPipeline
options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection
datapipeline = DataPipeline.new( :aws_access_key_id => your_aws_access_key_id, :aws_secret_access_key => your_aws_secret_access_key )
options<~Hash> - config arguments for connection. Defaults to {}.
region<~String> - optional region to use. For instance, 'eu-west-1', 'us-east-1' and etc.
DataPipeline object with connection to AWS.
# File lib/fog/aws/data_pipeline.rb, line 51 def initialize(options={}) @use_iam_profile = options[:use_iam_profile] @connection_options = options[:connection_options] || {} @version = '2012-10-29' @region = options[:region] || 'us-east-1' @host = options[:host] || "datapipeline.#{@region}.amazonaws.com" @path = options[:path] || '/' @persistent = options[:persistent] || false @port = options[:port] || 443 @scheme = options[:scheme] || 'https' @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", @persistent, @connection_options) setup_credentials(options) end
Activate a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_ActivatePipeline.html
PipelineId <~String> - The ID of the pipeline to activate
response<~Excon::Response>:
body<~Hash>:
# File lib/fog/aws/requests/data_pipeline/activate_pipeline.rb, line 14 def activate_pipeline(id) params = { 'pipelineId' => id } response = request({ :body => Fog::JSON.encode(params), :headers => { 'X-Amz-Target' => 'DataPipeline.ActivatePipeline' }, }) Fog::JSON.decode(response.body) end
Create a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_CreatePipeline.html
UniqueId <~String> - A unique ID for of the pipeline
Name <~String> - The name of the pipeline
Description <~String> - Description of the pipeline
response<~Excon::Response>:
body<~Hash>:
# File lib/fog/aws/requests/data_pipeline/create_pipeline.rb, line 16 def create_pipeline(unique_id, name, description=nil) params = { 'uniqueId' => unique_id, 'name' => name, } params['Description'] = description if description response = request({ :body => Fog::JSON.encode(params), :headers => { 'X-Amz-Target' => 'DataPipeline.CreatePipeline' }, }) Fog::JSON.decode(response.body) end
Delete a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_DeletePipeline.html
PipelineId <~String> - The id of the pipeline to delete
response<~Excon::Response>:
body<~Hash>:
# File lib/fog/aws/requests/data_pipeline/delete_pipeline.rb, line 14 def delete_pipeline(id) params = { 'pipelineId' => id } response = request({ :body => Fog::JSON.encode(params), :headers => { 'X-Amz-Target' => 'DataPipeline.DeletePipeline' }, }) Fog::JSON.decode(response.body) end
Describe pipelines docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribePipelines.html
PipelineIds <~String> - ID of pipeline to retrieve information for
response<~Excon::Response>:
body<~Hash>:
# File lib/fog/aws/requests/data_pipeline/describe_pipelines.rb, line 14 def describe_pipelines(ids) params = {} params['pipelineIds'] = ids response = request({ :body => Fog::JSON.encode(params), :headers => { 'X-Amz-Target' => 'DataPipeline.DescribePipelines' }, }) Fog::JSON.decode(response.body) end
List all pipelines docs.aws.amazon.com/datapipeline/latest/APIReference/API_ListPipelines.html
Marker <~String> - The starting point for the results to be returned.
response<~Excon::Response>:
body<~Hash>:
# File lib/fog/aws/requests/data_pipeline/list_pipelines.rb, line 14 def list_pipelines(options={}) params = {} params['Marker'] = options[:marker] if options[:marker] response = request({ :body => Fog::JSON.encode(params), :headers => { 'X-Amz-Target' => 'DataPipeline.ListPipelines' }, }) Fog::JSON.decode(response.body) end
# File lib/fog/aws/data_pipeline.rb, line 67 def owner_id @owner_id ||= security_groups.get('default').owner_id end
Put raw pipeline definition JSON docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html
PipelineId <~String> - The ID of the pipeline
PipelineObjects <~String> - Objects in the pipeline
response<~Excon::Response>:
body<~Hash>:
# File lib/fog/aws/requests/data_pipeline/put_pipeline_definition.rb, line 15 def put_pipeline_definition(id, objects) params = { 'pipelineId' => id, 'pipelineObjects' => transform_objects(objects), } response = request({ :body => Fog::JSON.encode(params), :headers => { 'X-Amz-Target' => 'DataPipeline.PutPipelineDefinition' }, }) Fog::JSON.decode(response.body) end
Generated with the Darkfish Rdoc Generator 2.