Current section
Files
Jump to
Current section
Files
src/aws_data_pipeline.erl
%% WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
%% See https://github.com/aws-beam/aws-codegen for more details.
%% @doc AWS Data Pipeline configures and manages a data-driven workflow
%% called a pipeline.
%%
%% AWS Data Pipeline
%% handles the details of scheduling and ensuring that data dependencies are
%% met so that your application
%% can focus on processing the data.
%%
%% AWS Data Pipeline provides a JAR implementation of a task runner called
%% AWS Data Pipeline Task Runner.
%% AWS Data Pipeline Task Runner provides logic for common data management
%% scenarios, such as performing
%% database queries and running data analysis using Amazon Elastic MapReduce
%% (Amazon EMR). You can use
%% AWS Data Pipeline Task Runner as your task runner, or you can write your
%% own task runner to provide
%% custom data management.
%%
%% AWS Data Pipeline implements two main sets of functionality. Use the first
%% set to create a pipeline
%% and define data sources, schedules, dependencies, and the transforms to be
%% performed on the data.
%% Use the second set in your task runner application to receive the next
%% task ready for processing.
%% The logic for performing the task, such as querying the data, running data
%% analysis, or converting
%% the data from one format to another, is contained within the task runner.
%% The task runner performs
%% the task assigned to it by the web service, reporting progress to the web
%% service as it does so.
%% When the task is done, the task runner reports the final success or
%% failure of the task to the web service.
-module(aws_data_pipeline).
-export([activate_pipeline/2,
activate_pipeline/3,
add_tags/2,
add_tags/3,
create_pipeline/2,
create_pipeline/3,
deactivate_pipeline/2,
deactivate_pipeline/3,
delete_pipeline/2,
delete_pipeline/3,
describe_objects/2,
describe_objects/3,
describe_pipelines/2,
describe_pipelines/3,
evaluate_expression/2,
evaluate_expression/3,
get_pipeline_definition/2,
get_pipeline_definition/3,
list_pipelines/2,
list_pipelines/3,
poll_for_task/2,
poll_for_task/3,
put_pipeline_definition/2,
put_pipeline_definition/3,
query_objects/2,
query_objects/3,
remove_tags/2,
remove_tags/3,
report_task_progress/2,
report_task_progress/3,
report_task_runner_heartbeat/2,
report_task_runner_heartbeat/3,
set_status/2,
set_status/3,
set_task_status/2,
set_task_status/3,
validate_pipeline_definition/2,
validate_pipeline_definition/3]).
-include_lib("hackney/include/hackney_lib.hrl").
%% Example:
%% set_status_input() :: #{
%% <<"objectIds">> := list(string()()),
%% <<"pipelineId">> := string(),
%% <<"status">> := string()
%% }
-type set_status_input() :: #{binary() => any()}.
%% Example:
%% deactivate_pipeline_input() :: #{
%% <<"cancelActive">> => boolean(),
%% <<"pipelineId">> := string()
%% }
-type deactivate_pipeline_input() :: #{binary() => any()}.
%% Example:
%% query_objects_input() :: #{
%% <<"limit">> => integer(),
%% <<"marker">> => string(),
%% <<"pipelineId">> := string(),
%% <<"query">> => query(),
%% <<"sphere">> := string()
%% }
-type query_objects_input() :: #{binary() => any()}.
%% Example:
%% pipeline_deleted_exception() :: #{
%% <<"message">> => string()
%% }
-type pipeline_deleted_exception() :: #{binary() => any()}.
%% Example:
%% create_pipeline_output() :: #{
%% <<"pipelineId">> => string()
%% }
-type create_pipeline_output() :: #{binary() => any()}.
%% Example:
%% validate_pipeline_definition_output() :: #{
%% <<"errored">> => boolean(),
%% <<"validationErrors">> => list(validation_error()()),
%% <<"validationWarnings">> => list(validation_warning()())
%% }
-type validate_pipeline_definition_output() :: #{binary() => any()}.
%% Example:
%% pipeline_object() :: #{
%% <<"fields">> => list(field()()),
%% <<"id">> => string(),
%% <<"name">> => string()
%% }
-type pipeline_object() :: #{binary() => any()}.
%% Example:
%% evaluate_expression_input() :: #{
%% <<"expression">> := string(),
%% <<"objectId">> := string(),
%% <<"pipelineId">> := string()
%% }
-type evaluate_expression_input() :: #{binary() => any()}.
%% Example:
%% validate_pipeline_definition_input() :: #{
%% <<"parameterObjects">> => list(parameter_object()()),
%% <<"parameterValues">> => list(parameter_value()()),
%% <<"pipelineId">> := string(),
%% <<"pipelineObjects">> := list(pipeline_object()())
%% }
-type validate_pipeline_definition_input() :: #{binary() => any()}.
%% Example:
%% poll_for_task_input() :: #{
%% <<"hostname">> => string(),
%% <<"instanceIdentity">> => instance_identity(),
%% <<"workerGroup">> := string()
%% }
-type poll_for_task_input() :: #{binary() => any()}.
%% Example:
%% add_tags_output() :: #{
%% }
-type add_tags_output() :: #{binary() => any()}.
%% Example:
%% selector() :: #{
%% <<"fieldName">> => string(),
%% <<"operator">> => operator()
%% }
-type selector() :: #{binary() => any()}.
%% Example:
%% report_task_progress_output() :: #{
%% <<"canceled">> => boolean()
%% }
-type report_task_progress_output() :: #{binary() => any()}.
%% Example:
%% set_task_status_input() :: #{
%% <<"errorId">> => string(),
%% <<"errorMessage">> => string(),
%% <<"errorStackTrace">> => string(),
%% <<"taskId">> := string(),
%% <<"taskStatus">> := list(any())
%% }
-type set_task_status_input() :: #{binary() => any()}.
%% Example:
%% add_tags_input() :: #{
%% <<"pipelineId">> := string(),
%% <<"tags">> := list(tag()())
%% }
-type add_tags_input() :: #{binary() => any()}.
%% Example:
%% get_pipeline_definition_output() :: #{
%% <<"parameterObjects">> => list(parameter_object()()),
%% <<"parameterValues">> => list(parameter_value()()),
%% <<"pipelineObjects">> => list(pipeline_object()())
%% }
-type get_pipeline_definition_output() :: #{binary() => any()}.
%% Example:
%% describe_pipelines_input() :: #{
%% <<"pipelineIds">> := list(string()())
%% }
-type describe_pipelines_input() :: #{binary() => any()}.
%% Example:
%% remove_tags_output() :: #{
%% }
-type remove_tags_output() :: #{binary() => any()}.
%% Example:
%% operator() :: #{
%% <<"type">> => list(any()),
%% <<"values">> => list(string()())
%% }
-type operator() :: #{binary() => any()}.
%% Example:
%% delete_pipeline_input() :: #{
%% <<"pipelineId">> := string()
%% }
-type delete_pipeline_input() :: #{binary() => any()}.
%% Example:
%% parameter_value() :: #{
%% <<"id">> => string(),
%% <<"stringValue">> => string()
%% }
-type parameter_value() :: #{binary() => any()}.
%% Example:
%% create_pipeline_input() :: #{
%% <<"description">> => string(),
%% <<"name">> := string(),
%% <<"tags">> => list(tag()()),
%% <<"uniqueId">> := string()
%% }
-type create_pipeline_input() :: #{binary() => any()}.
%% Example:
%% set_task_status_output() :: #{
%% }
-type set_task_status_output() :: #{binary() => any()}.
%% Example:
%% tag() :: #{
%% <<"key">> => string(),
%% <<"value">> => string()
%% }
-type tag() :: #{binary() => any()}.
%% Example:
%% invalid_request_exception() :: #{
%% <<"message">> => string()
%% }
-type invalid_request_exception() :: #{binary() => any()}.
%% Example:
%% list_pipelines_input() :: #{
%% <<"marker">> => string()
%% }
-type list_pipelines_input() :: #{binary() => any()}.
%% Example:
%% report_task_runner_heartbeat_output() :: #{
%% <<"terminate">> => boolean()
%% }
-type report_task_runner_heartbeat_output() :: #{binary() => any()}.
%% Example:
%% describe_pipelines_output() :: #{
%% <<"pipelineDescriptionList">> => list(pipeline_description()())
%% }
-type describe_pipelines_output() :: #{binary() => any()}.
%% Example:
%% field() :: #{
%% <<"key">> => string(),
%% <<"refValue">> => string(),
%% <<"stringValue">> => string()
%% }
-type field() :: #{binary() => any()}.
%% Example:
%% validation_error() :: #{
%% <<"errors">> => list(string()()),
%% <<"id">> => string()
%% }
-type validation_error() :: #{binary() => any()}.
%% Example:
%% report_task_runner_heartbeat_input() :: #{
%% <<"hostname">> => string(),
%% <<"taskrunnerId">> := string(),
%% <<"workerGroup">> => string()
%% }
-type report_task_runner_heartbeat_input() :: #{binary() => any()}.
%% Example:
%% evaluate_expression_output() :: #{
%% <<"evaluatedExpression">> => string()
%% }
-type evaluate_expression_output() :: #{binary() => any()}.
%% Example:
%% task_object() :: #{
%% <<"attemptId">> => string(),
%% <<"objects">> => map(),
%% <<"pipelineId">> => string(),
%% <<"taskId">> => string()
%% }
-type task_object() :: #{binary() => any()}.
%% Example:
%% describe_objects_output() :: #{
%% <<"hasMoreResults">> => boolean(),
%% <<"marker">> => string(),
%% <<"pipelineObjects">> => list(pipeline_object()())
%% }
-type describe_objects_output() :: #{binary() => any()}.
%% Example:
%% get_pipeline_definition_input() :: #{
%% <<"pipelineId">> := string(),
%% <<"version">> => string()
%% }
-type get_pipeline_definition_input() :: #{binary() => any()}.
%% Example:
%% query_objects_output() :: #{
%% <<"hasMoreResults">> => boolean(),
%% <<"ids">> => list(string()()),
%% <<"marker">> => string()
%% }
-type query_objects_output() :: #{binary() => any()}.
%% Example:
%% validation_warning() :: #{
%% <<"id">> => string(),
%% <<"warnings">> => list(string()())
%% }
-type validation_warning() :: #{binary() => any()}.
%% Example:
%% pipeline_description() :: #{
%% <<"description">> => string(),
%% <<"fields">> => list(field()()),
%% <<"name">> => string(),
%% <<"pipelineId">> => string(),
%% <<"tags">> => list(tag()())
%% }
-type pipeline_description() :: #{binary() => any()}.
%% Example:
%% internal_service_error() :: #{
%% <<"message">> => string()
%% }
-type internal_service_error() :: #{binary() => any()}.
%% Example:
%% deactivate_pipeline_output() :: #{
%% }
-type deactivate_pipeline_output() :: #{binary() => any()}.
%% Example:
%% poll_for_task_output() :: #{
%% <<"taskObject">> => task_object()
%% }
-type poll_for_task_output() :: #{binary() => any()}.
%% Example:
%% activate_pipeline_input() :: #{
%% <<"parameterValues">> => list(parameter_value()()),
%% <<"pipelineId">> := string(),
%% <<"startTimestamp">> => non_neg_integer()
%% }
-type activate_pipeline_input() :: #{binary() => any()}.
%% Example:
%% pipeline_not_found_exception() :: #{
%% <<"message">> => string()
%% }
-type pipeline_not_found_exception() :: #{binary() => any()}.
%% Example:
%% list_pipelines_output() :: #{
%% <<"hasMoreResults">> => boolean(),
%% <<"marker">> => string(),
%% <<"pipelineIdList">> => list(pipeline_id_name()())
%% }
-type list_pipelines_output() :: #{binary() => any()}.
%% Example:
%% task_not_found_exception() :: #{
%% <<"message">> => string()
%% }
-type task_not_found_exception() :: #{binary() => any()}.
%% Example:
%% put_pipeline_definition_output() :: #{
%% <<"errored">> => boolean(),
%% <<"validationErrors">> => list(validation_error()()),
%% <<"validationWarnings">> => list(validation_warning()())
%% }
-type put_pipeline_definition_output() :: #{binary() => any()}.
%% Example:
%% put_pipeline_definition_input() :: #{
%% <<"parameterObjects">> => list(parameter_object()()),
%% <<"parameterValues">> => list(parameter_value()()),
%% <<"pipelineId">> := string(),
%% <<"pipelineObjects">> := list(pipeline_object()())
%% }
-type put_pipeline_definition_input() :: #{binary() => any()}.
%% Example:
%% query() :: #{
%% <<"selectors">> => list(selector()())
%% }
-type query() :: #{binary() => any()}.
%% Example:
%% remove_tags_input() :: #{
%% <<"pipelineId">> := string(),
%% <<"tagKeys">> := list(string()())
%% }
-type remove_tags_input() :: #{binary() => any()}.
%% Example:
%% describe_objects_input() :: #{
%% <<"evaluateExpressions">> => boolean(),
%% <<"marker">> => string(),
%% <<"objectIds">> := list(string()()),
%% <<"pipelineId">> := string()
%% }
-type describe_objects_input() :: #{binary() => any()}.
%% Example:
%% report_task_progress_input() :: #{
%% <<"fields">> => list(field()()),
%% <<"taskId">> := string()
%% }
-type report_task_progress_input() :: #{binary() => any()}.
%% Example:
%% instance_identity() :: #{
%% <<"document">> => string(),
%% <<"signature">> => string()
%% }
-type instance_identity() :: #{binary() => any()}.
%% Example:
%% parameter_attribute() :: #{
%% <<"key">> => string(),
%% <<"stringValue">> => string()
%% }
-type parameter_attribute() :: #{binary() => any()}.
%% Example:
%% activate_pipeline_output() :: #{
%% }
-type activate_pipeline_output() :: #{binary() => any()}.
%% Example:
%% parameter_object() :: #{
%% <<"attributes">> => list(parameter_attribute()()),
%% <<"id">> => string()
%% }
-type parameter_object() :: #{binary() => any()}.
%% Example:
%% pipeline_id_name() :: #{
%% <<"id">> => string(),
%% <<"name">> => string()
%% }
-type pipeline_id_name() :: #{binary() => any()}.
-type activate_pipeline_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type add_tags_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type create_pipeline_errors() ::
internal_service_error() |
invalid_request_exception().
-type deactivate_pipeline_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type delete_pipeline_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception().
-type describe_objects_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type describe_pipelines_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type evaluate_expression_errors() ::
task_not_found_exception() |
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type get_pipeline_definition_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type list_pipelines_errors() ::
internal_service_error() |
invalid_request_exception().
-type poll_for_task_errors() ::
task_not_found_exception() |
internal_service_error() |
invalid_request_exception().
-type put_pipeline_definition_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type query_objects_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type remove_tags_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type report_task_progress_errors() ::
task_not_found_exception() |
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type report_task_runner_heartbeat_errors() ::
internal_service_error() |
invalid_request_exception().
-type set_status_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type set_task_status_errors() ::
task_not_found_exception() |
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
-type validate_pipeline_definition_errors() ::
pipeline_not_found_exception() |
internal_service_error() |
invalid_request_exception() |
pipeline_deleted_exception().
%%====================================================================
%% API
%%====================================================================
%% @doc Validates the specified pipeline and starts processing pipeline
%% tasks.
%%
%% If the pipeline does not pass validation,
%% activation fails.
%%
%% If you need to pause the pipeline to investigate an issue with a
%% component, such as a data source or script,
%% call `DeactivatePipeline'.
%%
%% To activate a finished pipeline, modify the end date for the pipeline and
%% then activate it.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.ActivatePipeline
%% Content-Length: 39
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE"}
%%
%% HTTP/1.1 200
%% x-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 2
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {}
-spec activate_pipeline(aws_client:aws_client(), activate_pipeline_input()) ->
{ok, activate_pipeline_output(), tuple()} |
{error, any()} |
{error, activate_pipeline_errors(), tuple()}.
activate_pipeline(Client, Input)
when is_map(Client), is_map(Input) ->
activate_pipeline(Client, Input, []).
-spec activate_pipeline(aws_client:aws_client(), activate_pipeline_input(), proplists:proplist()) ->
{ok, activate_pipeline_output(), tuple()} |
{error, any()} |
{error, activate_pipeline_errors(), tuple()}.
activate_pipeline(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ActivatePipeline">>, Input, Options).
%% @doc Adds or modifies tags for the specified pipeline.
-spec add_tags(aws_client:aws_client(), add_tags_input()) ->
{ok, add_tags_output(), tuple()} |
{error, any()} |
{error, add_tags_errors(), tuple()}.
add_tags(Client, Input)
when is_map(Client), is_map(Input) ->
add_tags(Client, Input, []).
-spec add_tags(aws_client:aws_client(), add_tags_input(), proplists:proplist()) ->
{ok, add_tags_output(), tuple()} |
{error, any()} |
{error, add_tags_errors(), tuple()}.
add_tags(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"AddTags">>, Input, Options).
%% @doc Creates a new, empty pipeline.
%%
%% Use `PutPipelineDefinition' to populate the pipeline.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.CreatePipeline
%% Content-Length: 91
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"name": "myPipeline",
%% "uniqueId": "123456789",
%% "description": "This is my first pipeline"}
%%
%% HTTP/1.1 200
%% x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 40
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE"}
-spec create_pipeline(aws_client:aws_client(), create_pipeline_input()) ->
{ok, create_pipeline_output(), tuple()} |
{error, any()} |
{error, create_pipeline_errors(), tuple()}.
create_pipeline(Client, Input)
when is_map(Client), is_map(Input) ->
create_pipeline(Client, Input, []).
-spec create_pipeline(aws_client:aws_client(), create_pipeline_input(), proplists:proplist()) ->
{ok, create_pipeline_output(), tuple()} |
{error, any()} |
{error, create_pipeline_errors(), tuple()}.
create_pipeline(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"CreatePipeline">>, Input, Options).
%% @doc Deactivates the specified running pipeline.
%%
%% The pipeline is set to the `DEACTIVATING'
%% state until the deactivation process completes.
%%
%% To resume a deactivated pipeline, use `ActivatePipeline'. By default,
%% the pipeline resumes from the last completed execution.
%% Optionally, you can specify the date and time to resume the pipeline.
-spec deactivate_pipeline(aws_client:aws_client(), deactivate_pipeline_input()) ->
{ok, deactivate_pipeline_output(), tuple()} |
{error, any()} |
{error, deactivate_pipeline_errors(), tuple()}.
deactivate_pipeline(Client, Input)
when is_map(Client), is_map(Input) ->
deactivate_pipeline(Client, Input, []).
-spec deactivate_pipeline(aws_client:aws_client(), deactivate_pipeline_input(), proplists:proplist()) ->
{ok, deactivate_pipeline_output(), tuple()} |
{error, any()} |
{error, deactivate_pipeline_errors(), tuple()}.
deactivate_pipeline(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeactivatePipeline">>, Input, Options).
%% @doc Deletes a pipeline, its pipeline definition, and its run history.
%%
%% AWS Data Pipeline attempts to cancel instances associated with the
%% pipeline that are currently being processed by task runners.
%%
%% Deleting a pipeline cannot be undone. You cannot query or restore a
%% deleted pipeline.
%% To temporarily pause a pipeline instead of deleting it, call
%% `SetStatus' with the status set to `PAUSE' on individual
%% components.
%% Components that are paused by `SetStatus' can be resumed.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.DeletePipeline
%% Content-Length: 50
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE"}
%%
%% x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 0
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% Unexpected response: 200, OK, undefined
-spec delete_pipeline(aws_client:aws_client(), delete_pipeline_input()) ->
{ok, undefined, tuple()} |
{error, any()} |
{error, delete_pipeline_errors(), tuple()}.
delete_pipeline(Client, Input)
when is_map(Client), is_map(Input) ->
delete_pipeline(Client, Input, []).
-spec delete_pipeline(aws_client:aws_client(), delete_pipeline_input(), proplists:proplist()) ->
{ok, undefined, tuple()} |
{error, any()} |
{error, delete_pipeline_errors(), tuple()}.
delete_pipeline(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DeletePipeline">>, Input, Options).
%% @doc Gets the object definitions for a set of objects associated with the
%% pipeline.
%%
%% Object definitions are composed of
%% a set of fields that define the properties of the object.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.DescribeObjects
%% Content-Length: 98
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE",
%% "objectIds":
%% ["Schedule"],
%% "evaluateExpressions": true}
%%
%% x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 1488
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"hasMoreResults": false,
%% "pipelineObjects":
%% [
%% {"fields":
%% [
%% {"key": "startDateTime",
%% "stringValue": "2012-12-12T00:00:00"},
%% {"key": "parent",
%% "refValue": "Default"},
%% {"key": "@sphere",
%% "stringValue": "COMPONENT"},
%% {"key": "type",
%% "stringValue": "Schedule"},
%% {"key": "period",
%% "stringValue": "1 hour"},
%% {"key": "endDateTime",
%% "stringValue": "2012-12-21T18:00:00"},
%% {"key": "@version",
%% "stringValue": "1"},
%% {"key": "@status",
%% "stringValue": "PENDING"},
%% {"key": "@pipelineId",
%% "stringValue": "df-06372391ZG65EXAMPLE"}
%% ],
%% "id": "Schedule",
%% "name": "Schedule"}
%% ]
%% }
-spec describe_objects(aws_client:aws_client(), describe_objects_input()) ->
{ok, describe_objects_output(), tuple()} |
{error, any()} |
{error, describe_objects_errors(), tuple()}.
describe_objects(Client, Input)
when is_map(Client), is_map(Input) ->
describe_objects(Client, Input, []).
-spec describe_objects(aws_client:aws_client(), describe_objects_input(), proplists:proplist()) ->
{ok, describe_objects_output(), tuple()} |
{error, any()} |
{error, describe_objects_errors(), tuple()}.
describe_objects(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribeObjects">>, Input, Options).
%% @doc Retrieves metadata about one or more pipelines.
%%
%% The information retrieved includes the name of the pipeline, the pipeline
%% identifier,
%% its current state, and the user account that owns the pipeline. Using
%% account credentials, you can retrieve metadata about pipelines
%% that you or your IAM users have created. If you are using an IAM user
%% account, you can retrieve metadata about only those pipelines
%% for which you have read permissions.
%%
%% To retrieve the full pipeline definition instead of metadata about the
%% pipeline, call `GetPipelineDefinition'.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.DescribePipelines
%% Content-Length: 70
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineIds":
%% ["df-08785951KAKJEXAMPLE"]
%% }
%%
%% x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 767
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"pipelineDescriptionList":
%% [
%% {"description": "This is my first pipeline",
%% "fields":
%% [
%% {"key": "@pipelineState",
%% "stringValue": "SCHEDULED"},
%% {"key": "description",
%% "stringValue": "This is my first pipeline"},
%% {"key": "name",
%% "stringValue": "myPipeline"},
%% {"key": "@creationTime",
%% "stringValue": "2012-12-13T01:24:06"},
%% {"key": "@id",
%% "stringValue": "df-0937003356ZJEXAMPLE"},
%% {"key": "@sphere",
%% "stringValue": "PIPELINE"},
%% {"key": "@version",
%% "stringValue": "1"},
%% {"key": "@userId",
%% "stringValue": "924374875933"},
%% {"key": "@accountId",
%% "stringValue": "924374875933"},
%% {"key": "uniqueId",
%% "stringValue": "1234567890"}
%% ],
%% "name": "myPipeline",
%% "pipelineId": "df-0937003356ZJEXAMPLE"}
%% ]
%% }
-spec describe_pipelines(aws_client:aws_client(), describe_pipelines_input()) ->
{ok, describe_pipelines_output(), tuple()} |
{error, any()} |
{error, describe_pipelines_errors(), tuple()}.
describe_pipelines(Client, Input)
when is_map(Client), is_map(Input) ->
describe_pipelines(Client, Input, []).
-spec describe_pipelines(aws_client:aws_client(), describe_pipelines_input(), proplists:proplist()) ->
{ok, describe_pipelines_output(), tuple()} |
{error, any()} |
{error, describe_pipelines_errors(), tuple()}.
describe_pipelines(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"DescribePipelines">>, Input, Options).
%% @doc Task runners call `EvaluateExpression' to evaluate a string in
%% the context of the specified object.
%%
%% For example, a task runner can evaluate SQL queries stored in Amazon S3.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.DescribePipelines
%% Content-Length: 164
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-08785951KAKJEXAMPLE",
%% "objectId": "Schedule",
%% "expression": "Transform started at #{startDateTime} and
%% finished at #{endDateTime}"}
%%
%% x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 103
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"evaluatedExpression": "Transform started at
%% 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"}
-spec evaluate_expression(aws_client:aws_client(), evaluate_expression_input()) ->
{ok, evaluate_expression_output(), tuple()} |
{error, any()} |
{error, evaluate_expression_errors(), tuple()}.
evaluate_expression(Client, Input)
when is_map(Client), is_map(Input) ->
evaluate_expression(Client, Input, []).
-spec evaluate_expression(aws_client:aws_client(), evaluate_expression_input(), proplists:proplist()) ->
{ok, evaluate_expression_output(), tuple()} |
{error, any()} |
{error, evaluate_expression_errors(), tuple()}.
evaluate_expression(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"EvaluateExpression">>, Input, Options).
%% @doc Gets the definition of the specified pipeline.
%%
%% You can call `GetPipelineDefinition' to retrieve
%% the pipeline definition that you provided using
%% `PutPipelineDefinition'.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.GetPipelineDefinition
%% Content-Length: 40
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE"}
%%
%% x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 890
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"pipelineObjects":
%% [
%% {"fields":
%% [
%% {"key": "workerGroup",
%% "stringValue": "workerGroup"}
%% ],
%% "id": "Default",
%% "name": "Default"},
%% {"fields":
%% [
%% {"key": "startDateTime",
%% "stringValue": "2012-09-25T17:00:00"},
%% {"key": "type",
%% "stringValue": "Schedule"},
%% {"key": "period",
%% "stringValue": "1 hour"},
%% {"key": "endDateTime",
%% "stringValue": "2012-09-25T18:00:00"}
%% ],
%% "id": "Schedule",
%% "name": "Schedule"},
%% {"fields":
%% [
%% {"key": "schedule",
%% "refValue": "Schedule"},
%% {"key": "command",
%% "stringValue": "echo hello"},
%% {"key": "parent",
%% "refValue": "Default"},
%% {"key": "type",
%% "stringValue": "ShellCommandActivity"}
%% ],
%% "id": "SayHello",
%% "name": "SayHello"}
%% ]
%% }
-spec get_pipeline_definition(aws_client:aws_client(), get_pipeline_definition_input()) ->
{ok, get_pipeline_definition_output(), tuple()} |
{error, any()} |
{error, get_pipeline_definition_errors(), tuple()}.
get_pipeline_definition(Client, Input)
when is_map(Client), is_map(Input) ->
get_pipeline_definition(Client, Input, []).
-spec get_pipeline_definition(aws_client:aws_client(), get_pipeline_definition_input(), proplists:proplist()) ->
{ok, get_pipeline_definition_output(), tuple()} |
{error, any()} |
{error, get_pipeline_definition_errors(), tuple()}.
get_pipeline_definition(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"GetPipelineDefinition">>, Input, Options).
%% @doc Lists the pipeline identifiers for all active pipelines that you have
%% permission to access.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.ListPipelines
%% Content-Length: 14
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {}
%%
%% Status:
%% x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 39
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"PipelineIdList":
%% [
%% {"id": "df-08785951KAKJEXAMPLE",
%% "name": "MyPipeline"},
%% {"id": "df-08662578ISYEXAMPLE",
%% "name": "MySecondPipeline"}
%% ]
%% }
-spec list_pipelines(aws_client:aws_client(), list_pipelines_input()) ->
{ok, list_pipelines_output(), tuple()} |
{error, any()} |
{error, list_pipelines_errors(), tuple()}.
list_pipelines(Client, Input)
when is_map(Client), is_map(Input) ->
list_pipelines(Client, Input, []).
-spec list_pipelines(aws_client:aws_client(), list_pipelines_input(), proplists:proplist()) ->
{ok, list_pipelines_output(), tuple()} |
{error, any()} |
{error, list_pipelines_errors(), tuple()}.
list_pipelines(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ListPipelines">>, Input, Options).
%% @doc Task runners call `PollForTask' to receive a task to perform from
%% AWS Data Pipeline.
%%
%% The task runner specifies which tasks it can perform
%% by setting a value for the `workerGroup' parameter. The task returned
%% can come from any of the pipelines that
%% match the `workerGroup' value passed in by the task runner and that
%% was launched using the IAM user credentials
%% specified by the task runner.
%%
%% If tasks are ready in the work queue, `PollForTask' returns a response
%% immediately. If no tasks are available in the queue,
%% `PollForTask' uses long-polling and holds on to a poll connection for
%% up to a 90 seconds, during which time the first newly
%% scheduled task is handed to the task runner. To accomodate this, set the
%% socket timeout in your task runner to 90 seconds. The task
%% runner should not call `PollForTask' again on the same
%% `workerGroup' until it receives a response, and this can take up to 90
%% seconds.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.PollForTask
%% Content-Length: 59
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"workerGroup": "MyworkerGroup",
%% "hostname": "example.com"}
%%
%% x-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 39
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"taskObject":
%% {"attemptId":
%% "@SayHello_2012-12-12T00:00:00_Attempt=1",
%% "objects":
%% {"@SayHello_2012-12-12T00:00:00_Attempt=1":
%% {"fields":
%% [
%% {"key": "@componentParent",
%% "refValue": "SayHello"},
%% {"key": "@scheduledStartTime",
%% "stringValue": "2012-12-12T00:00:00"},
%% {"key": "parent",
%% "refValue": "SayHello"},
%% {"key": "@sphere",
%% "stringValue": "ATTEMPT"},
%% {"key": "workerGroup",
%% "stringValue": "workerGroup"},
%% {"key": "@instanceParent",
%% "refValue": "@SayHello_2012-12-12T00:00:00"},
%% {"key": "type",
%% "stringValue": "ShellCommandActivity"},
%% {"key": "@status",
%% "stringValue": "WAITING_FOR_RUNNER"},
%% {"key": "@version",
%% "stringValue": "1"},
%% {"key": "schedule",
%% "refValue": "Schedule"},
%% {"key": "@actualStartTime",
%% "stringValue": "2012-12-13T01:40:50"},
%% {"key": "command",
%% "stringValue": "echo hello"},
%% {"key": "@scheduledEndTime",
%% "stringValue": "2012-12-12T01:00:00"},
%% {"key": "@activeInstances",
%% "refValue": "@SayHello_2012-12-12T00:00:00"},
%% {"key": "@pipelineId",
%% "stringValue": "df-0937003356ZJEXAMPLE"}
%% ],
%% "id": "@SayHello_2012-12-12T00:00:00_Attempt=1",
%% "name": "@SayHello_2012-12-12T00:00:00_Attempt=1"}
%% },
%% "pipelineId": "df-0937003356ZJEXAMPLE",
%% "taskId":
%% "2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1"}
%% }
-spec poll_for_task(aws_client:aws_client(), poll_for_task_input()) ->
{ok, poll_for_task_output(), tuple()} |
{error, any()} |
{error, poll_for_task_errors(), tuple()}.
poll_for_task(Client, Input)
when is_map(Client), is_map(Input) ->
poll_for_task(Client, Input, []).
-spec poll_for_task(aws_client:aws_client(), poll_for_task_input(), proplists:proplist()) ->
{ok, poll_for_task_output(), tuple()} |
{error, any()} |
{error, poll_for_task_errors(), tuple()}.
poll_for_task(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"PollForTask">>, Input, Options).
%% @doc Adds tasks, schedules, and preconditions to the specified pipeline.
%%
%% You can use `PutPipelineDefinition' to populate a new pipeline.
%%
%% `PutPipelineDefinition' also validates the configuration as it adds it
%% to the pipeline. Changes to the pipeline are saved unless one
%% of the following three validation errors exists in the pipeline.
%%
%% An object is missing a name or identifier field.
%% A string or reference field is empty.
%% The number of objects in the pipeline exceeds the maximum allowed objects.
%% The pipeline is in a FINISHED state.
%%
%% Pipeline object definitions are passed to the `PutPipelineDefinition'
%% action and returned by the `GetPipelineDefinition' action.
%%
%% Example 1
%%
%% This example sets an valid pipeline configuration and returns success.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.PutPipelineDefinition
%% Content-Length: 914
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-0937003356ZJEXAMPLE",
%% "pipelineObjects":
%% [
%% {"id": "Default",
%% "name": "Default",
%% "fields":
%% [
%% {"key": "workerGroup",
%% "stringValue": "workerGroup"}
%% ]
%% },
%% {"id": "Schedule",
%% "name": "Schedule",
%% "fields":
%% [
%% {"key": "startDateTime",
%% "stringValue": "2012-12-12T00:00:00"},
%% {"key": "type",
%% "stringValue": "Schedule"},
%% {"key": "period",
%% "stringValue": "1 hour"},
%% {"key": "endDateTime",
%% "stringValue": "2012-12-21T18:00:00"}
%% ]
%% },
%% {"id": "SayHello",
%% "name": "SayHello",
%% "fields":
%% [
%% {"key": "type",
%% "stringValue": "ShellCommandActivity"},
%% {"key": "command",
%% "stringValue": "echo hello"},
%% {"key": "parent",
%% "refValue": "Default"},
%% {"key": "schedule",
%% "refValue": "Schedule"}
%% ]
%% }
%% ]
%% }
%%
%% HTTP/1.1 200
%% x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 18
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"errored": false}
%%
%% Example 2
%%
%% This example sets an invalid pipeline configuration (the value for
%% `workerGroup' is an empty string) and returns an error message.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.PutPipelineDefinition
%% Content-Length: 903
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE",
%% "pipelineObjects":
%% [
%% {"id": "Default",
%% "name": "Default",
%% "fields":
%% [
%% {"key": "workerGroup",
%% "stringValue": ""}
%% ]
%% },
%% {"id": "Schedule",
%% "name": "Schedule",
%% "fields":
%% [
%% {"key": "startDateTime",
%% "stringValue": "2012-09-25T17:00:00"},
%% {"key": "type",
%% "stringValue": "Schedule"},
%% {"key": "period",
%% "stringValue": "1 hour"},
%% {"key": "endDateTime",
%% "stringValue": "2012-09-25T18:00:00"}
%% ]
%% },
%% {"id": "SayHello",
%% "name": "SayHello",
%% "fields":
%% [
%% {"key": "type",
%% "stringValue": "ShellCommandActivity"},
%% {"key": "command",
%% "stringValue": "echo hello"},
%% {"key": "parent",
%% "refValue": "Default"},
%% {"key": "schedule",
%% "refValue": "Schedule"}
%%
%% ]
%% }
%% ]
%% }
%%
%% HTTP/1.1 200
%% x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 18
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"__type":
%% "com.amazon.setl.webservice#InvalidRequestException",
%% "message": "Pipeline definition has errors: Could not save
%% the pipeline definition due to FATAL errors:
%% [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate
%% to validate your pipeline"}
-spec put_pipeline_definition(aws_client:aws_client(), put_pipeline_definition_input()) ->
{ok, put_pipeline_definition_output(), tuple()} |
{error, any()} |
{error, put_pipeline_definition_errors(), tuple()}.
put_pipeline_definition(Client, Input)
when is_map(Client), is_map(Input) ->
put_pipeline_definition(Client, Input, []).
-spec put_pipeline_definition(aws_client:aws_client(), put_pipeline_definition_input(), proplists:proplist()) ->
{ok, put_pipeline_definition_output(), tuple()} |
{error, any()} |
{error, put_pipeline_definition_errors(), tuple()}.
put_pipeline_definition(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"PutPipelineDefinition">>, Input, Options).
%% @doc Queries the specified pipeline for the names of objects that match
%% the specified set of conditions.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.QueryObjects
%% Content-Length: 123
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE",
%% "query":
%% {"selectors":
%% [
%% ]
%% },
%% "sphere": "INSTANCE",
%% "marker": "",
%% "limit": 10}
%%
%% x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 72
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"hasMoreResults": false,
%% "ids":
%% ["@SayHello_1_2012-09-25T17:00:00"]
%% }
-spec query_objects(aws_client:aws_client(), query_objects_input()) ->
{ok, query_objects_output(), tuple()} |
{error, any()} |
{error, query_objects_errors(), tuple()}.
query_objects(Client, Input)
when is_map(Client), is_map(Input) ->
query_objects(Client, Input, []).
-spec query_objects(aws_client:aws_client(), query_objects_input(), proplists:proplist()) ->
{ok, query_objects_output(), tuple()} |
{error, any()} |
{error, query_objects_errors(), tuple()}.
query_objects(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"QueryObjects">>, Input, Options).
%% @doc Removes existing tags from the specified pipeline.
-spec remove_tags(aws_client:aws_client(), remove_tags_input()) ->
{ok, remove_tags_output(), tuple()} |
{error, any()} |
{error, remove_tags_errors(), tuple()}.
remove_tags(Client, Input)
when is_map(Client), is_map(Input) ->
remove_tags(Client, Input, []).
-spec remove_tags(aws_client:aws_client(), remove_tags_input(), proplists:proplist()) ->
{ok, remove_tags_output(), tuple()} |
{error, any()} |
{error, remove_tags_errors(), tuple()}.
remove_tags(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"RemoveTags">>, Input, Options).
%% @doc Task runners call `ReportTaskProgress' when assigned a task to
%% acknowledge that it has the task.
%%
%% If the web service does not
%% receive this acknowledgement within 2 minutes, it assigns the task in a
%% subsequent `PollForTask' call. After this initial acknowledgement,
%% the task runner only needs to report progress every 15 minutes to maintain
%% its ownership of the task. You can change this reporting time
%% from 15 minutes by specifying a `reportProgressTimeout' field in your
%% pipeline.
%%
%% If a task runner does not report its status after 5 minutes, AWS Data
%% Pipeline assumes that the task runner is unable to process the task
%% and reassigns the task in a subsequent response to `PollForTask'. Task
%% runners should call `ReportTaskProgress' every 60 seconds.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.ReportTaskProgress
%% Content-Length: 832
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"taskId":
%% "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE",
%% "fields":
%% [
%% {"key": "percentComplete",
%% "stringValue": "50"}
%% ]
%% }
%%
%% x-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 18
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"canceled": false}
-spec report_task_progress(aws_client:aws_client(), report_task_progress_input()) ->
{ok, report_task_progress_output(), tuple()} |
{error, any()} |
{error, report_task_progress_errors(), tuple()}.
report_task_progress(Client, Input)
when is_map(Client), is_map(Input) ->
report_task_progress(Client, Input, []).
-spec report_task_progress(aws_client:aws_client(), report_task_progress_input(), proplists:proplist()) ->
{ok, report_task_progress_output(), tuple()} |
{error, any()} |
{error, report_task_progress_errors(), tuple()}.
report_task_progress(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ReportTaskProgress">>, Input, Options).
%% @doc Task runners call `ReportTaskRunnerHeartbeat' every 15 minutes to
%% indicate that they are operational.
%%
%% If the AWS Data Pipeline Task Runner is launched on a resource managed by
%% AWS Data Pipeline, the web service can use
%% this call to detect when the task runner application has failed and
%% restart a new instance.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat
%% Content-Length: 84
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"taskrunnerId": "1234567890",
%% "workerGroup": "wg-12345",
%% "hostname": "example.com"}
%%
%% Status:
%% x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 20
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"terminate": false}
-spec report_task_runner_heartbeat(aws_client:aws_client(), report_task_runner_heartbeat_input()) ->
{ok, report_task_runner_heartbeat_output(), tuple()} |
{error, any()} |
{error, report_task_runner_heartbeat_errors(), tuple()}.
report_task_runner_heartbeat(Client, Input)
when is_map(Client), is_map(Input) ->
report_task_runner_heartbeat(Client, Input, []).
-spec report_task_runner_heartbeat(aws_client:aws_client(), report_task_runner_heartbeat_input(), proplists:proplist()) ->
{ok, report_task_runner_heartbeat_output(), tuple()} |
{error, any()} |
{error, report_task_runner_heartbeat_errors(), tuple()}.
report_task_runner_heartbeat(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ReportTaskRunnerHeartbeat">>, Input, Options).
%% @doc Requests that the status of the specified physical or logical
%% pipeline objects be updated in the specified pipeline.
%%
%% This update might not occur immediately, but is eventually consistent. The
%% status that can be set depends on the type of object (for example,
%% DataNode or Activity).
%% You cannot perform this operation on `FINISHED' pipelines and
%% attempting to do so returns `InvalidRequestException'.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.SetStatus
%% Content-Length: 100
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-0634701J7KEXAMPLE",
%% "objectIds":
%% ["o-08600941GHJWMBR9E2"],
%% "status": "pause"}
%%
%% x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 0
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% Unexpected response: 200, OK, undefined
-spec set_status(aws_client:aws_client(), set_status_input()) ->
{ok, undefined, tuple()} |
{error, any()} |
{error, set_status_errors(), tuple()}.
set_status(Client, Input)
when is_map(Client), is_map(Input) ->
set_status(Client, Input, []).
-spec set_status(aws_client:aws_client(), set_status_input(), proplists:proplist()) ->
{ok, undefined, tuple()} |
{error, any()} |
{error, set_status_errors(), tuple()}.
set_status(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SetStatus">>, Input, Options).
%% @doc Task runners call `SetTaskStatus' to notify AWS Data Pipeline
%% that a task is completed and provide information about the final status.
%%
%% A task runner makes this call regardless of whether the task was
%% sucessful. A task runner does not need to call `SetTaskStatus' for
%% tasks that are canceled by the web service during a call to
%% `ReportTaskProgress'.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.SetTaskStatus
%% Content-Length: 847
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"taskId":
%% "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE",
%% "taskStatus": "FINISHED"}
%%
%% x-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 0
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {}
-spec set_task_status(aws_client:aws_client(), set_task_status_input()) ->
{ok, set_task_status_output(), tuple()} |
{error, any()} |
{error, set_task_status_errors(), tuple()}.
set_task_status(Client, Input)
when is_map(Client), is_map(Input) ->
set_task_status(Client, Input, []).
-spec set_task_status(aws_client:aws_client(), set_task_status_input(), proplists:proplist()) ->
{ok, set_task_status_output(), tuple()} |
{error, any()} |
{error, set_task_status_errors(), tuple()}.
set_task_status(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"SetTaskStatus">>, Input, Options).
%% @doc Validates the specified pipeline definition to ensure that it is well
%% formed and can be run without error.
%%
%% Example 1
%%
%% This example sets an valid pipeline configuration and returns success.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.ValidatePipelineDefinition
%% Content-Length: 936
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE",
%% "pipelineObjects":
%% [
%% {"id": "Default",
%% "name": "Default",
%% "fields":
%% [
%% {"key": "workerGroup",
%% "stringValue": "MyworkerGroup"}
%% ]
%% },
%% {"id": "Schedule",
%% "name": "Schedule",
%% "fields":
%% [
%% {"key": "startDateTime",
%% "stringValue": "2012-09-25T17:00:00"},
%% {"key": "type",
%% "stringValue": "Schedule"},
%% {"key": "period",
%% "stringValue": "1 hour"},
%% {"key": "endDateTime",
%% "stringValue": "2012-09-25T18:00:00"}
%% ]
%% },
%% {"id": "SayHello",
%% "name": "SayHello",
%% "fields":
%% [
%% {"key": "type",
%% "stringValue": "ShellCommandActivity"},
%% {"key": "command",
%% "stringValue": "echo hello"},
%% {"key": "parent",
%% "refValue": "Default"},
%% {"key": "schedule",
%% "refValue": "Schedule"}
%%
%% ]
%% }
%% ]
%% }
%%
%% x-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 18
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"errored": false}
%%
%% Example 2
%%
%% This example sets an invalid pipeline configuration and returns the
%% associated set of validation errors.
%%
%% POST / HTTP/1.1
%% Content-Type: application/x-amz-json-1.1
%% X-Amz-Target: DataPipeline.ValidatePipelineDefinition
%% Content-Length: 903
%% Host: datapipeline.us-east-1.amazonaws.com
%% X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
%% Authorization: AuthParams
%%
%% {"pipelineId": "df-06372391ZG65EXAMPLE",
%% "pipelineObjects":
%% [
%% {"id": "Default",
%% "name": "Default",
%% "fields":
%% [
%% {"key": "workerGroup",
%% "stringValue": "MyworkerGroup"}
%% ]
%% },
%% {"id": "Schedule",
%% "name": "Schedule",
%% "fields":
%% [
%% {"key": "startDateTime",
%% "stringValue": "bad-time"},
%% {"key": "type",
%% "stringValue": "Schedule"},
%% {"key": "period",
%% "stringValue": "1 hour"},
%% {"key": "endDateTime",
%% "stringValue": "2012-09-25T18:00:00"}
%% ]
%% },
%% {"id": "SayHello",
%% "name": "SayHello",
%% "fields":
%% [
%% {"key": "type",
%% "stringValue": "ShellCommandActivity"},
%% {"key": "command",
%% "stringValue": "echo hello"},
%% {"key": "parent",
%% "refValue": "Default"},
%% {"key": "schedule",
%% "refValue": "Schedule"}
%%
%% ]
%% }
%% ]
%% }
%%
%% x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd
%% Content-Type: application/x-amz-json-1.1
%% Content-Length: 278
%% Date: Mon, 12 Nov 2012 17:50:53 GMT
%%
%% {"errored": true,
%% "validationErrors":
%% [
%% {"errors":
%% ["INVALID_FIELD_VALUE: 'startDateTime' value must be a
%% literal datetime value."],
%% "id": "Schedule"}
%% ]
%% }
-spec validate_pipeline_definition(aws_client:aws_client(), validate_pipeline_definition_input()) ->
{ok, validate_pipeline_definition_output(), tuple()} |
{error, any()} |
{error, validate_pipeline_definition_errors(), tuple()}.
validate_pipeline_definition(Client, Input)
when is_map(Client), is_map(Input) ->
validate_pipeline_definition(Client, Input, []).
-spec validate_pipeline_definition(aws_client:aws_client(), validate_pipeline_definition_input(), proplists:proplist()) ->
{ok, validate_pipeline_definition_output(), tuple()} |
{error, any()} |
{error, validate_pipeline_definition_errors(), tuple()}.
validate_pipeline_definition(Client, Input, Options)
when is_map(Client), is_map(Input), is_list(Options) ->
request(Client, <<"ValidatePipelineDefinition">>, Input, Options).
%%====================================================================
%% Internal functions
%%====================================================================
-spec request(aws_client:aws_client(), binary(), map(), list()) ->
{ok, Result, {integer(), list(), hackney:client()}} |
{error, Error, {integer(), list(), hackney:client()}} |
{error, term()} when
Result :: map() | undefined,
Error :: map().
request(Client, Action, Input, Options) ->
RequestFun = fun() -> do_request(Client, Action, Input, Options) end,
aws_request:request(RequestFun, Options).
do_request(Client, Action, Input0, Options) ->
Client1 = Client#{service => <<"datapipeline">>},
Host = build_host(<<"datapipeline">>, Client1),
URL = build_url(Host, Client1),
Headers = [
{<<"Host">>, Host},
{<<"Content-Type">>, <<"application/x-amz-json-1.1">>},
{<<"X-Amz-Target">>, <<"DataPipeline.", Action/binary>>}
],
Input = Input0,
Payload = jsx:encode(Input),
SignedHeaders = aws_request:sign_request(Client1, <<"POST">>, URL, Headers, Payload),
Response = hackney:request(post, URL, SignedHeaders, Payload, Options),
handle_response(Response).
handle_response({ok, 200, ResponseHeaders, Client}) ->
case hackney:body(Client) of
{ok, <<>>} ->
{ok, undefined, {200, ResponseHeaders, Client}};
{ok, Body} ->
Result = jsx:decode(Body),
{ok, Result, {200, ResponseHeaders, Client}}
end;
handle_response({ok, StatusCode, ResponseHeaders, Client}) ->
{ok, Body} = hackney:body(Client),
Error = jsx:decode(Body),
{error, Error, {StatusCode, ResponseHeaders, Client}};
handle_response({error, Reason}) ->
{error, Reason}.
build_host(_EndpointPrefix, #{region := <<"local">>, endpoint := Endpoint}) ->
Endpoint;
build_host(_EndpointPrefix, #{region := <<"local">>}) ->
<<"localhost">>;
build_host(EndpointPrefix, #{region := Region, endpoint := Endpoint}) ->
aws_util:binary_join([EndpointPrefix, Region, Endpoint], <<".">>).
build_url(Host, Client) ->
Proto = aws_client:proto(Client),
Port = aws_client:port(Client),
aws_util:binary_join([Proto, <<"://">>, Host, <<":">>, Port, <<"/">>], <<"">>).