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

Class: Aws::DataPipeline::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Data Pipeline. To construct a client, you need to configure a :region and :credentials.

datapipeline = Aws::DataPipeline::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::DataPipeline::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::DataPipeline::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#activate_pipeline(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.activate_pipeline({
  pipeline_id: "id", # required
  parameter_values: [
    {
      id: "fieldNameString", # required
      string_value: "fieldStringValue", # required
    },
  ],
  start_timestamp: Time.now,
})

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :parameter_values (Array<Types::ParameterValue>)

    A list of parameter values to pass to the pipeline at activation.

  • :start_timestamp (Time)

    The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#add_tags(options = {}) ⇒ Struct

Adds or modifies tags for the specified pipeline.

Examples:

Request syntax with placeholder values


resp = client.add_tags({
  pipeline_id: "id", # required
  tags: [ # required
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :tags (required, Array<Types::Tag>)

    The tags to add, as key/value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#create_pipeline(options = {}) ⇒ Types::CreatePipelineOutput

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

Examples:

Request syntax with placeholder values


resp = client.create_pipeline({
  name: "id", # required
  unique_id: "id", # required
  description: "string",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Response structure


resp.pipeline_id #=> String

Options Hash (options):

  • :name (required, String)

    The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

  • :unique_id (required, String)

    A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you\'ll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.

  • :description (String)

    The description for the pipeline.

  • :tags (Array<Types::Tag>)

    A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

Returns:

See Also:

#deactivate_pipeline(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.deactivate_pipeline({
  pipeline_id: "id", # required
  cancel_active: false,
})

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :cancel_active (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:

  • (Struct)

    Returns an empty response.

See Also:

#delete_pipeline(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_pipeline({
  pipeline_id: "id", # required
})

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_objects(options = {}) ⇒ Types::DescribeObjectsOutput

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.

Examples:

Request syntax with placeholder values


resp = client.describe_objects({
  pipeline_id: "id", # required
  object_ids: ["id"], # required
  evaluate_expressions: false,
  marker: "string",
})

Response structure


resp.pipeline_objects #=> Array
resp.pipeline_objects[0].id #=> String
resp.pipeline_objects[0].name #=> String
resp.pipeline_objects[0].fields #=> Array
resp.pipeline_objects[0].fields[0].key #=> String
resp.pipeline_objects[0].fields[0].string_value #=> String
resp.pipeline_objects[0].fields[0].ref_value #=> String
resp.marker #=> String
resp.has_more_results #=> true/false

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline that contains the object definitions.

  • :object_ids (required, Array<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.

  • :evaluate_expressions (Boolean)

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

  • :marker (String)

    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:

See Also:

#describe_pipelines(options = {}) ⇒ Types::DescribePipelinesOutput

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.

Examples:

Request syntax with placeholder values


resp = client.describe_pipelines({
  pipeline_ids: ["id"], # required
})

Response structure


resp.pipeline_description_list #=> Array
resp.pipeline_description_list[0].pipeline_id #=> String
resp.pipeline_description_list[0].name #=> String
resp.pipeline_description_list[0].fields #=> Array
resp.pipeline_description_list[0].fields[0].key #=> String
resp.pipeline_description_list[0].fields[0].string_value #=> String
resp.pipeline_description_list[0].fields[0].ref_value #=> String
resp.pipeline_description_list[0].description #=> String
resp.pipeline_description_list[0].tags #=> Array
resp.pipeline_description_list[0].tags[0].key #=> String
resp.pipeline_description_list[0].tags[0].value #=> String

Options Hash (options):

  • :pipeline_ids (required, Array<String>)

    The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

Returns:

See Also:

#evaluate_expression(options = {}) ⇒ Types::EvaluateExpressionOutput

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.

Examples:

Request syntax with placeholder values


resp = client.evaluate_expression({
  pipeline_id: "id", # required
  object_id: "id", # required
  expression: "longString", # required
})

Response structure


resp.evaluated_expression #=> String

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :object_id (required, String)

    The ID of the object.

  • :expression (required, String)

    The expression to evaluate.

Returns:

See Also:

#get_pipeline_definition(options = {}) ⇒ Types::GetPipelineDefinitionOutput

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

Examples:

Request syntax with placeholder values


resp = client.get_pipeline_definition({
  pipeline_id: "id", # required
  version: "string",
})

Response structure


resp.pipeline_objects #=> Array
resp.pipeline_objects[0].id #=> String
resp.pipeline_objects[0].name #=> String
resp.pipeline_objects[0].fields #=> Array
resp.pipeline_objects[0].fields[0].key #=> String
resp.pipeline_objects[0].fields[0].string_value #=> String
resp.pipeline_objects[0].fields[0].ref_value #=> String
resp.parameter_objects #=> Array
resp.parameter_objects[0].id #=> String
resp.parameter_objects[0].attributes #=> Array
resp.parameter_objects[0].attributes[0].key #=> String
resp.parameter_objects[0].attributes[0].string_value #=> String
resp.parameter_values #=> Array
resp.parameter_values[0].id #=> String
resp.parameter_values[0].string_value #=> String

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :version (String)

    The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

Returns:

See Also:

#list_pipelines(options = {}) ⇒ Types::ListPipelinesOutput

Lists the pipeline identifiers for all active pipelines that you have permission to access.

Examples:

Request syntax with placeholder values


resp = client.list_pipelines({
  marker: "string",
})

Response structure


resp.pipeline_id_list #=> Array
resp.pipeline_id_list[0].id #=> String
resp.pipeline_id_list[0].name #=> String
resp.marker #=> String
resp.has_more_results #=> true/false

Options Hash (options):

  • :marker (String)

    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 ListPipelines with the marker value from the previous call to retrieve the next set of results.

Returns:

See Also:

#poll_for_task(options = {}) ⇒ Types::PollForTaskOutput

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.

Examples:

Request syntax with placeholder values


resp = client.poll_for_task({
  worker_group: "string", # required
  hostname: "id",
  instance_identity: {
    document: "string",
    signature: "string",
  },
})

Response structure


resp.task_object.task_id #=> String
resp.task_object.pipeline_id #=> String
resp.task_object.attempt_id #=> String
resp.task_object.objects #=> Hash
resp.task_object.objects["id"].id #=> String
resp.task_object.objects["id"].name #=> String
resp.task_object.objects["id"].fields #=> Array
resp.task_object.objects["id"].fields[0].key #=> String
resp.task_object.objects["id"].fields[0].string_value #=> String
resp.task_object.objects["id"].fields[0].ref_value #=> String

Options Hash (options):

  • :worker_group (required, String)

    The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

  • :hostname (String)

    The public DNS name of the calling task runner.

  • :instance_identity (Types::InstanceIdentity)

    Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

Returns:

See Also:

#put_pipeline_definition(options = {}) ⇒ Types::PutPipelineDefinitionOutput

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.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

Examples:

Request syntax with placeholder values


resp = client.put_pipeline_definition({
  pipeline_id: "id", # required
  pipeline_objects: [ # required
    {
      id: "id", # required
      name: "id", # required
      fields: [ # required
        {
          key: "fieldNameString", # required
          string_value: "fieldStringValue",
          ref_value: "fieldNameString",
        },
      ],
    },
  ],
  parameter_objects: [
    {
      id: "fieldNameString", # required
      attributes: [ # required
        {
          key: "attributeNameString", # required
          string_value: "attributeValueString", # required
        },
      ],
    },
  ],
  parameter_values: [
    {
      id: "fieldNameString", # required
      string_value: "fieldStringValue", # required
    },
  ],
})

Response structure


resp.validation_errors #=> Array
resp.validation_errors[0].id #=> String
resp.validation_errors[0].errors #=> Array
resp.validation_errors[0].errors[0] #=> String
resp.validation_warnings #=> Array
resp.validation_warnings[0].id #=> String
resp.validation_warnings[0].warnings #=> Array
resp.validation_warnings[0].warnings[0] #=> String
resp.errored #=> true/false

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :pipeline_objects (required, Array<Types::PipelineObject>)

    The objects that define the pipeline. These objects overwrite the existing pipeline definition.

  • :parameter_objects (Array<Types::ParameterObject>)

    The parameter objects used with the pipeline.

  • :parameter_values (Array<Types::ParameterValue>)

    The parameter values used with the pipeline.

Returns:

See Also:

#query_objects(options = {}) ⇒ Types::QueryObjectsOutput

Queries the specified pipeline for the names of objects that match the specified set of conditions.

Examples:

Request syntax with placeholder values


resp = client.query_objects({
  pipeline_id: "id", # required
  query: {
    selectors: [
      {
        field_name: "string",
        operator: {
          type: "EQ", # accepts EQ, REF_EQ, LE, GE, BETWEEN
          values: ["string"],
        },
      },
    ],
  },
  sphere: "string", # required
  marker: "string",
  limit: 1,
})

Response structure


resp.ids #=> Array
resp.ids[0] #=> String
resp.marker #=> String
resp.has_more_results #=> true/false

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :query (Types::Query)

    The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

  • :sphere (required, String)

    Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

  • :marker (String)

    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 QueryObjects with the marker value from the previous call to retrieve the next set of results.

  • :limit (Integer)

    The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Returns:

See Also:

#remove_tags(options = {}) ⇒ Struct

Removes existing tags from the specified pipeline.

Examples:

Request syntax with placeholder values


resp = client.remove_tags({
  pipeline_id: "id", # required
  tag_keys: ["string"], # required
})

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :tag_keys (required, Array<String>)

    The keys of the tags to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#report_task_progress(options = {}) ⇒ Types::ReportTaskProgressOutput

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.

Examples:

Request syntax with placeholder values


resp = client.report_task_progress({
  task_id: "taskId", # required
  fields: [
    {
      key: "fieldNameString", # required
      string_value: "fieldStringValue",
      ref_value: "fieldNameString",
    },
  ],
})

Response structure


resp.canceled #=> true/false

Options Hash (options):

  • :task_id (required, String)

    The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

  • :fields (Array<Types::Field>)

    Key-value pairs that define the properties of the ReportTaskProgressInput object.

Returns:

See Also:

#report_task_runner_heartbeat(options = {}) ⇒ Types::ReportTaskRunnerHeartbeatOutput

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.

Examples:

Request syntax with placeholder values


resp = client.report_task_runner_heartbeat({
  taskrunner_id: "id", # required
  worker_group: "string",
  hostname: "id",
})

Response structure


resp.terminate #=> true/false

Options Hash (options):

  • :taskrunner_id (required, String)

    The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

  • :worker_group (String)

    The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

  • :hostname (String)

    The public DNS name of the task runner.

Returns:

See Also:

#set_status(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.set_status({
  pipeline_id: "id", # required
  object_ids: ["id"], # required
  status: "string", # required
})

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline that contains the objects.

  • :object_ids (required, Array<String>)

    The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

  • :status (required, String)

    The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#set_task_status(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.set_task_status({
  task_id: "taskId", # required
  task_status: "FINISHED", # required, accepts FINISHED, FAILED, FALSE
  error_id: "string",
  error_message: "errorMessage",
  error_stack_trace: "string",
})

Options Hash (options):

  • :task_id (required, String)

    The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

  • :task_status (required, String)

    If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

  • :error_id (String)

    If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.

  • :error_message (String)

    If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

  • :error_stack_trace (String)

    If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#validate_pipeline_definition(options = {}) ⇒ Types::ValidatePipelineDefinitionOutput

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Examples:

Request syntax with placeholder values


resp = client.validate_pipeline_definition({
  pipeline_id: "id", # required
  pipeline_objects: [ # required
    {
      id: "id", # required
      name: "id", # required
      fields: [ # required
        {
          key: "fieldNameString", # required
          string_value: "fieldStringValue",
          ref_value: "fieldNameString",
        },
      ],
    },
  ],
  parameter_objects: [
    {
      id: "fieldNameString", # required
      attributes: [ # required
        {
          key: "attributeNameString", # required
          string_value: "attributeValueString", # required
        },
      ],
    },
  ],
  parameter_values: [
    {
      id: "fieldNameString", # required
      string_value: "fieldStringValue", # required
    },
  ],
})

Response structure


resp.validation_errors #=> Array
resp.validation_errors[0].id #=> String
resp.validation_errors[0].errors #=> Array
resp.validation_errors[0].errors[0] #=> String
resp.validation_warnings #=> Array
resp.validation_warnings[0].id #=> String
resp.validation_warnings[0].warnings #=> Array
resp.validation_warnings[0].warnings[0] #=> String
resp.errored #=> true/false

Options Hash (options):

  • :pipeline_id (required, String)

    The ID of the pipeline.

  • :pipeline_objects (required, Array<Types::PipelineObject>)

    The objects that define the pipeline changes to validate against the pipeline.

  • :parameter_objects (Array<Types::ParameterObject>)

    The parameter objects used with the pipeline.

  • :parameter_values (Array<Types::ParameterValue>)

    The parameter values used with the pipeline.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.