Initialize connection to DataPipeline

Notes

options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection

Examples

  datapipeline = DataPipeline.new(
   :aws_access_key_id => your_aws_access_key_id,
   :aws_secret_access_key => your_aws_secret_access_key
  )

Parameters

• options<~Hash> - config arguments for connection. Defaults to {}.
  • region<~String> - optional region to use. For instance, ‘eu-west-1’, ‘us-east-1’ and etc.

Returns

• DataPipeline object with connection to AWS.

Activate a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_ActivatePipeline.html

Parameters

• PipelineId <~String> - The ID of the pipeline to activate

Returns

• response<~Excon::Response>:
  • body<~Hash>:

Create a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_CreatePipeline.html

Parameters

• UniqueId <~String> - A unique ID for of the pipeline
• Name <~String> - The name of the pipeline
• Tags <~Hash> - Key/value string pairs to categorize the pipeline
• Description <~String> - Description of the pipeline

Returns

• response<~Excon::Response>:
  • body<~Hash>:

Activate a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_DectivatePipeline.html

Parameters

• PipelineId <~String> - The ID of the pipeline to activate

’ cancelActive <~Boolean> - Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Returns

• response<~Excon::Response>:
  • body<~Hash>:

Delete a pipeline docs.aws.amazon.com/datapipeline/latest/APIReference/API_DeletePipeline.html

Parameters

• PipelineId <~String> - The id of the pipeline to delete

Returns

• success<~Boolean> - Whether the delete was successful

Queries a pipeline for the names of objects that match a specified set of conditions. 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>:

Describe pipelines docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribePipelines.html

Parameters

• PipelineIds <~String> - ID of pipeline to retrieve information for

Returns

• response<~Excon::Response>:
  • body<~Hash>:

Get pipeline definition JSON docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html

Parameters

• PipelineId <~String> - The ID of the pipeline

Returns

• response<~Excon::Response>:
  • body<~Hash>:

List all pipelines docs.aws.amazon.com/datapipeline/latest/APIReference/API_ListPipelines.html

Parameters

• Marker <~String> - The starting point for the results to be returned.

Returns

• response<~Excon::Response>:
  • body<~Hash>:

Put raw pipeline definition JSON docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html

Parameters

• PipelineId <~String> - The ID of the pipeline
• PipelineObjects <~String> - Objects in the pipeline

Returns

• response<~Excon::Response>:
  • body<~Hash>:

Queries a pipeline for the names of objects that match a specified set of conditions. docs.aws.amazon.com/datapipeline/latest/APIReference/API_QueryObjects.html

Parameters

• PipelineId <~String> - The ID of the pipeline
• Sphere <~String> - Specifies whether the query applies to components or instances.

                     Allowable values: COMPONENT, INSTANCE, ATTEMPT.
  

• Marker <~String> - The starting point for the results to be returned.

Returns

• response<~Excon::Response>:
  • body<~Hash>: