<?php
// This file was auto-generated from sdk-root/src/data/datapipeline/2012-10-29/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>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.</p> <p>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.</p> <p>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.</p>', 'operations' => [ 'ActivatePipeline' => '<p>Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.</p> <p>If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>.</p> <p>To activate a finished pipeline, modify the end date for the pipeline and then activate it.</p>', 'AddTags' => '<p>Adds or modifies tags for the specified pipeline.</p>', 'CreatePipeline' => '<p>Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline.</p>', 'DeactivatePipeline' => '<p>Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes.</p> <p>To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.</p>', 'DeletePipeline' => '<p>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.</p> <p>Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed.</p>', 'DescribeObjects' => '<p>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.</p>', 'DescribePipelines' => '<p>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.</p> <p>To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>.</p>', 'EvaluateExpression' => '<p>Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.</p>', 'GetPipelineDefinition' => '<p>Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>.</p>', 'ListPipelines' => '<p>Lists the pipeline identifiers for all active pipelines that you have permission to access.</p>', 'PollForTask' => '<p>Task runners call <code>PollForTask</code> 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 <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.</p> <p>If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> 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 <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </p>', 'PutPipelineDefinition' => '<p>Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline.</p> <p> <code>PutPipelineDefinition</code> 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. </p> <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol> <p> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </p>', 'QueryObjects' => '<p>Queries the specified pipeline for the names of objects that match the specified set of conditions.</p>', 'RemoveTags' => '<p>Removes existing tags from the specified pipeline.</p>', 'ReportTaskProgress' => '<p>Task runners call <code>ReportTaskProgress</code> 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 <a>PollForTask</a> 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 <code>reportProgressTimeout</code> field in your pipeline.</p> <p>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 <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds.</p>', 'ReportTaskRunnerHeartbeat' => '<p>Task runners call <code>ReportTaskRunnerHeartbeat</code> 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.</p>', 'SetStatus' => '<p>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 <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>.</p>', 'SetTaskStatus' => '<p>Task runners call <code>SetTaskStatus</code> 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 <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>.</p>', 'ValidatePipelineDefinition' => '<p>Validates the specified pipeline definition to ensure that it is well formed and can be run without error.</p>', ], 'shapes' => [ 'ActivatePipelineInput' => [ 'base' => '<p>Contains the parameters for ActivatePipeline.</p>', 'refs' => [], ], 'ActivatePipelineOutput' => [ 'base' => '<p>Contains the output of ActivatePipeline.</p>', 'refs' => [], ], 'AddTagsInput' => [ 'base' => '<p>Contains the parameters for AddTags.</p>', 'refs' => [], ], 'AddTagsOutput' => [ 'base' => '<p>Contains the output of AddTags.</p>', 'refs' => [], ], 'CreatePipelineInput' => [ 'base' => '<p>Contains the parameters for CreatePipeline.</p>', 'refs' => [], ], 'CreatePipelineOutput' => [ 'base' => '<p>Contains the output of CreatePipeline.</p>', 'refs' => [], ], 'DeactivatePipelineInput' => [ 'base' => '<p>Contains the parameters for DeactivatePipeline.</p>', 'refs' => [], ], 'DeactivatePipelineOutput' => [ 'base' => '<p>Contains the output of DeactivatePipeline.</p>', 'refs' => [], ], 'DeletePipelineInput' => [ 'base' => '<p>Contains the parameters for DeletePipeline.</p>', 'refs' => [], ], 'DescribeObjectsInput' => [ 'base' => '<p>Contains the parameters for DescribeObjects.</p>', 'refs' => [], ], 'DescribeObjectsOutput' => [ 'base' => '<p>Contains the output of DescribeObjects.</p>', 'refs' => [], ], 'DescribePipelinesInput' => [ 'base' => '<p>Contains the parameters for DescribePipelines.</p>', 'refs' => [], ], 'DescribePipelinesOutput' => [ 'base' => '<p>Contains the output of DescribePipelines.</p>', 'refs' => [], ], 'EvaluateExpressionInput' => [ 'base' => '<p>Contains the parameters for EvaluateExpression.</p>', 'refs' => [], ], 'EvaluateExpressionOutput' => [ 'base' => '<p>Contains the output of EvaluateExpression.</p>', 'refs' => [], ], 'Field' => [ 'base' => '<p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>', 'refs' => [ 'fieldList$member' => NULL, ], ], 'GetPipelineDefinitionInput' => [ 'base' => '<p>Contains the parameters for GetPipelineDefinition.</p>', 'refs' => [], ], 'GetPipelineDefinitionOutput' => [ 'base' => '<p>Contains the output of GetPipelineDefinition.</p>', 'refs' => [], ], 'InstanceIdentity' => [ 'base' => '<p><p>Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> 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.</p></p>', 'refs' => [ 'PollForTaskInput$instanceIdentity' => '<p>Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using <code>http://169.254.169.254/latest/meta-data/instance-id</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> 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.</p>', ], ], 'InternalServiceError' => [ 'base' => '<p>An internal service error occurred.</p>', 'refs' => [], ], 'InvalidRequestException' => [ 'base' => '<p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven\'t exceeded any of the service limits for your account.</p>', 'refs' => [], ], 'ListPipelinesInput' => [ 'base' => '<p>Contains the parameters for ListPipelines.</p>', 'refs' => [], ], 'ListPipelinesOutput' => [ 'base' => '<p>Contains the output of ListPipelines.</p>', 'refs' => [], ], 'Operator' => [ 'base' => '<p>Contains a logical operation for comparing the value of a field with a specified value.</p>', 'refs' => [ 'Selector$operator' => NULL, ], ], 'OperatorType' => [ 'base' => NULL, 'refs' => [ 'Operator$type' => '<p> The logical operation to be performed: equal (<code>EQ</code>), equal reference (<code>REF_EQ</code>), less than or equal (<code>LE</code>), greater than or equal (<code>GE</code>), or between (<code>BETWEEN</code>). Equal reference (<code>REF_EQ</code>) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. </p> <p> The comparison operators EQ and REF_EQ act on the following fields: </p> <ul> <li>name</li> <li>@sphere</li> <li>parent</li> <li>@componentParent</li> <li>@instanceParent</li> <li>@status</li> <li>@scheduledStartTime</li> <li>@scheduledEndTime</li> <li>@actualStartTime</li> <li>@actualEndTime</li> </ul> <p> The comparison operators <code>GE</code>, <code>LE</code>, and <code>BETWEEN</code> act on the following fields: </p> <ul> <li>@scheduledStartTime</li> <li>@scheduledEndTime</li> <li>@actualStartTime</li> <li>@actualEndTime</li> </ul> <p>Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".</p>', ], ], 'ParameterAttribute' => [ 'base' => '<p>The attributes allowed or specified with a parameter object.</p>', 'refs' => [ 'ParameterAttributeList$member' => NULL, ], ], 'ParameterAttributeList' => [ 'base' => NULL, 'refs' => [ 'ParameterObject$attributes' => '<p>The attributes of the parameter object.</p>', ], ], 'ParameterObject' => [ 'base' => '<p>Contains information about a parameter object.</p>', 'refs' => [ 'ParameterObjectList$member' => NULL, ], ], 'ParameterObjectList' => [ 'base' => NULL, 'refs' => [ 'GetPipelineDefinitionOutput$parameterObjects' => '<p>The parameter objects used in the pipeline definition.</p>', 'PutPipelineDefinitionInput$parameterObjects' => '<p>The parameter objects used with the pipeline.</p>', 'ValidatePipelineDefinitionInput$parameterObjects' => '<p>The parameter objects used with the pipeline.</p>', ], ], 'ParameterValue' => [ 'base' => '<p>A value or list of parameter values. </p>', 'refs' => [ 'ParameterValueList$member' => NULL, ], ], 'ParameterValueList' => [ 'base' => NULL, 'refs' => [ 'ActivatePipelineInput$parameterValues' => '<p>A list of parameter values to pass to the pipeline at activation.</p>', 'GetPipelineDefinitionOutput$parameterValues' => '<p>The parameter values used in the pipeline definition.</p>', 'PutPipelineDefinitionInput$parameterValues' => '<p>The parameter values used with the pipeline.</p>', 'ValidatePipelineDefinitionInput$parameterValues' => '<p>The parameter values used with the pipeline.</p>', ], ], 'PipelineDeletedException' => [ 'base' => '<p>The specified pipeline has been deleted.</p>', 'refs' => [], ], 'PipelineDescription' => [ 'base' => '<p>Contains pipeline metadata.</p>', 'refs' => [ 'PipelineDescriptionList$member' => NULL, ], ], 'PipelineDescriptionList' => [ 'base' => NULL, 'refs' => [ 'DescribePipelinesOutput$pipelineDescriptionList' => '<p>An array of descriptions for the specified pipelines.</p>', ], ], 'PipelineIdName' => [ 'base' => '<p>Contains the name and identifier of a pipeline.</p>', 'refs' => [ 'pipelineList$member' => NULL, ], ], 'PipelineNotFoundException' => [ 'base' => '<p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>', 'refs' => [], ], 'PipelineObject' => [ 'base' => '<p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>', 'refs' => [ 'PipelineObjectList$member' => NULL, 'PipelineObjectMap$value' => NULL, ], ], 'PipelineObjectList' => [ 'base' => NULL, 'refs' => [ 'DescribeObjectsOutput$pipelineObjects' => '<p>An array of object definitions.</p>', 'GetPipelineDefinitionOutput$pipelineObjects' => '<p>The objects defined in the pipeline.</p>', 'PutPipelineDefinitionInput$pipelineObjects' => '<p>The objects that define the pipeline. These objects overwrite the existing pipeline definition.</p>', 'ValidatePipelineDefinitionInput$pipelineObjects' => '<p>The objects that define the pipeline changes to validate against the pipeline.</p>', ], ], 'PipelineObjectMap' => [ 'base' => NULL, 'refs' => [ 'TaskObject$objects' => '<p>Connection information for the location where the task runner will publish the output of the task.</p>', ], ], 'PollForTaskInput' => [ 'base' => '<p>Contains the parameters for PollForTask.</p>', 'refs' => [], ], 'PollForTaskOutput' => [ 'base' => '<p>Contains the output of PollForTask.</p>', 'refs' => [], ], 'PutPipelineDefinitionInput' => [ 'base' => '<p>Contains the parameters for PutPipelineDefinition.</p>', 'refs' => [], ], 'PutPipelineDefinitionOutput' => [ 'base' => '<p>Contains the output of PutPipelineDefinition.</p>', 'refs' => [], ], 'Query' => [ 'base' => '<p>Defines the query to run against an object.</p>', 'refs' => [ 'QueryObjectsInput$query' => '<p>The query that defines the objects to be returned. The <code>Query</code> 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.</p>', ], ], 'QueryObjectsInput' => [ 'base' => '<p>Contains the parameters for QueryObjects.</p>', 'refs' => [], ], 'QueryObjectsOutput' => [ 'base' => '<p>Contains the output of QueryObjects.</p>', 'refs' => [], ], 'RemoveTagsInput' => [ 'base' => '<p>Contains the parameters for RemoveTags.</p>', 'refs' => [], ], 'RemoveTagsOutput' => [ 'base' => '<p>Contains the output of RemoveTags.</p>', 'refs' => [], ], 'ReportTaskProgressInput' => [ 'base' => '<p>Contains the parameters for ReportTaskProgress.</p>', 'refs' => [], ], 'ReportTaskProgressOutput' => [ 'base' => '<p>Contains the output of ReportTaskProgress.</p>', 'refs' => [], ], 'ReportTaskRunnerHeartbeatInput' => [ 'base' => '<p>Contains the parameters for ReportTaskRunnerHeartbeat.</p>', 'refs' => [], ], 'ReportTaskRunnerHeartbeatOutput' => [ 'base' => '<p>Contains the output of ReportTaskRunnerHeartbeat.</p>', 'refs' => [], ], 'Selector' => [ 'base' => '<p>A comparision that is used to determine whether a query should return this object.</p>', 'refs' => [ 'SelectorList$member' => NULL, ], ], 'SelectorList' => [ 'base' => '<p>The list of Selectors that define queries on individual fields.</p>', 'refs' => [ 'Query$selectors' => '<p>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</p>', ], ], 'SetStatusInput' => [ 'base' => '<p>Contains the parameters for SetStatus.</p>', 'refs' => [], ], 'SetTaskStatusInput' => [ 'base' => '<p>Contains the parameters for SetTaskStatus.</p>', 'refs' => [], ], 'SetTaskStatusOutput' => [ 'base' => '<p>Contains the output of SetTaskStatus.</p>', 'refs' => [], ], 'Tag' => [ 'base' => '<p>Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>', 'refs' => [ 'tagList$member' => NULL, ], ], 'TaskNotFoundException' => [ 'base' => '<p>The specified task was not found. </p>', 'refs' => [], ], 'TaskObject' => [ 'base' => '<p>Contains information about a pipeline task that is assigned to a task runner.</p>', 'refs' => [ 'PollForTaskOutput$taskObject' => '<p>The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is <code>taskId</code>, which contains an identifier for the task being assigned. The calling task runner uses <code>taskId</code> in subsequent calls to <a>ReportTaskProgress</a> and <a>SetTaskStatus</a>.</p>', ], ], 'TaskStatus' => [ 'base' => NULL, 'refs' => [ 'SetTaskStatusInput$taskStatus' => '<p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false.</p>', ], ], 'ValidatePipelineDefinitionInput' => [ 'base' => '<p>Contains the parameters for ValidatePipelineDefinition.</p>', 'refs' => [], ], 'ValidatePipelineDefinitionOutput' => [ 'base' => '<p>Contains the output of ValidatePipelineDefinition.</p>', 'refs' => [], ], 'ValidationError' => [ 'base' => '<p>Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>', 'refs' => [ 'ValidationErrors$member' => NULL, ], ], 'ValidationErrors' => [ 'base' => NULL, 'refs' => [ 'PutPipelineDefinitionOutput$validationErrors' => '<p>The validation errors that are associated with the objects defined in <code>pipelineObjects</code>.</p>', 'ValidatePipelineDefinitionOutput$validationErrors' => '<p>Any validation errors that were found.</p>', ], ], 'ValidationWarning' => [ 'base' => '<p>Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>', 'refs' => [ 'ValidationWarnings$member' => NULL, ], ], 'ValidationWarnings' => [ 'base' => NULL, 'refs' => [ 'PutPipelineDefinitionOutput$validationWarnings' => '<p>The validation warnings that are associated with the objects defined in <code>pipelineObjects</code>.</p>', 'ValidatePipelineDefinitionOutput$validationWarnings' => '<p>Any validation warnings that were found.</p>', ], ], 'attributeNameString' => [ 'base' => NULL, 'refs' => [ 'ParameterAttribute$key' => '<p>The field identifier.</p>', ], ], 'attributeValueString' => [ 'base' => NULL, 'refs' => [ 'ParameterAttribute$stringValue' => '<p>The field value, expressed as a String.</p>', ], ], 'boolean' => [ 'base' => NULL, 'refs' => [ 'DescribeObjectsInput$evaluateExpressions' => '<p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>', 'DescribeObjectsOutput$hasMoreResults' => '<p>Indicates whether there are more results to return.</p>', 'ListPipelinesOutput$hasMoreResults' => '<p>Indicates whether there are more results that can be obtained by a subsequent call.</p>', 'PutPipelineDefinitionOutput$errored' => '<p>Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call <code>PutPipelineDefinition</code> to commit the corrected pipeline.</p>', 'QueryObjectsOutput$hasMoreResults' => '<p>Indicates whether there are more results that can be obtained by a subsequent call.</p>', 'ReportTaskProgressOutput$canceled' => '<p>If true, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks.</p>', 'ReportTaskRunnerHeartbeatOutput$terminate' => '<p>Indicates whether the calling task runner should terminate.</p>', 'ValidatePipelineDefinitionOutput$errored' => '<p>Indicates whether there were validation errors.</p>', ], ], 'cancelActive' => [ 'base' => NULL, 'refs' => [ 'DeactivatePipelineInput$cancelActive' => '<p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>', ], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'InternalServiceError$message' => '<p>Description of the error message.</p>', 'InvalidRequestException$message' => '<p>Description of the error message.</p>', 'PipelineDeletedException$message' => '<p>Description of the error message.</p>', 'PipelineNotFoundException$message' => '<p>Description of the error message.</p>', 'SetTaskStatusInput$errorMessage' => '<p>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.</p>', 'TaskNotFoundException$message' => '<p>Description of the error message.</p>', ], ], 'fieldList' => [ 'base' => NULL, 'refs' => [ 'PipelineDescription$fields' => '<p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>', 'PipelineObject$fields' => '<p>Key-value pairs that define the properties of the object.</p>', 'ReportTaskProgressInput$fields' => '<p>Key-value pairs that define the properties of the ReportTaskProgressInput object.</p>', ], ], 'fieldNameString' => [ 'base' => NULL, 'refs' => [ 'Field$key' => '<p>The field identifier.</p>', 'Field$refValue' => '<p>The field value, expressed as the identifier of another object.</p>', 'ParameterObject$id' => '<p>The ID of the parameter object. </p>', 'ParameterValue$id' => '<p>The ID of the parameter value.</p>', ], ], 'fieldStringValue' => [ 'base' => NULL, 'refs' => [ 'Field$stringValue' => '<p>The field value, expressed as a String.</p>', 'ParameterValue$stringValue' => '<p>The field value, expressed as a String.</p>', ], ], 'id' => [ 'base' => NULL, 'refs' => [ 'ActivatePipelineInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'AddTagsInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'CreatePipelineInput$name' => '<p>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.</p>', 'CreatePipelineInput$uniqueId' => '<p>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 <code>CreatePipeline</code>. For example, if the first call to <code>CreatePipeline</code> does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to <code>CreatePipeline</code>. <code>CreatePipeline</code> 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.</p>', 'CreatePipelineOutput$pipelineId' => '<p>The ID that AWS Data Pipeline assigns the newly created pipeline. For example, <code>df-06372391ZG65EXAMPLE</code>.</p>', 'DeactivatePipelineInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'DeletePipelineInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'DescribeObjectsInput$pipelineId' => '<p>The ID of the pipeline that contains the object definitions.</p>', 'EvaluateExpressionInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'EvaluateExpressionInput$objectId' => '<p>The ID of the object.</p>', 'GetPipelineDefinitionInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'PipelineDescription$pipelineId' => '<p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>', 'PipelineDescription$name' => '<p>The name of the pipeline.</p>', 'PipelineIdName$id' => '<p>The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>', 'PipelineIdName$name' => '<p>The name of the pipeline.</p>', 'PipelineObject$id' => '<p>The ID of the object.</p>', 'PipelineObject$name' => '<p>The name of the object.</p>', 'PipelineObjectMap$key' => NULL, 'PollForTaskInput$hostname' => '<p>The public DNS name of the calling task runner.</p>', 'PutPipelineDefinitionInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'QueryObjectsInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'RemoveTagsInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'ReportTaskRunnerHeartbeatInput$taskrunnerId' => '<p>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.</p>', 'ReportTaskRunnerHeartbeatInput$hostname' => '<p>The public DNS name of the task runner.</p>', 'SetStatusInput$pipelineId' => '<p>The ID of the pipeline that contains the objects.</p>', 'TaskObject$pipelineId' => '<p>The ID of the pipeline that provided the task.</p>', 'TaskObject$attemptId' => '<p>The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.</p>', 'ValidatePipelineDefinitionInput$pipelineId' => '<p>The ID of the pipeline.</p>', 'ValidationError$id' => '<p>The identifier of the object that contains the validation error.</p>', 'ValidationWarning$id' => '<p>The identifier of the object that contains the validation warning.</p>', 'idList$member' => NULL, ], ], 'idList' => [ 'base' => NULL, 'refs' => [ 'DescribeObjectsInput$objectIds' => '<p>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 <code>DescribeObjects</code>.</p>', 'DescribePipelinesInput$pipelineIds' => '<p>The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</p>', 'QueryObjectsOutput$ids' => '<p>The identifiers that match the query selectors.</p>', 'SetStatusInput$objectIds' => '<p>The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>', ], ], 'int' => [ 'base' => NULL, 'refs' => [ 'QueryObjectsInput$limit' => '<p>The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </p>', ], ], 'longString' => [ 'base' => NULL, 'refs' => [ 'EvaluateExpressionInput$expression' => '<p>The expression to evaluate.</p>', 'EvaluateExpressionOutput$evaluatedExpression' => '<p>The evaluated expression.</p>', ], ], 'pipelineList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesOutput$pipelineIdList' => '<p>The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>.</p>', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineInput$description' => '<p>The description for the pipeline.</p>', 'DescribeObjectsInput$marker' => '<p>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 <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>', 'DescribeObjectsOutput$marker' => '<p>The starting point for the next page of results. To view the next page of results, call <code>DescribeObjects</code> again with this marker value. If the value is null, there are no more results.</p>', 'GetPipelineDefinitionInput$version' => '<p>The version of the pipeline definition to retrieve. Set this parameter to <code>latest</code> (default) to use the last definition saved to the pipeline or <code>active</code> to use the last definition that was activated.</p>', 'InstanceIdentity$document' => '<p>A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.</p>', 'InstanceIdentity$signature' => '<p>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</p>', 'ListPipelinesInput$marker' => '<p>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 <code>ListPipelines</code> with the marker value from the previous call to retrieve the next set of results.</p>', 'ListPipelinesOutput$marker' => '<p>The starting point for the next page of results. To view the next page of results, call <code>ListPipelinesOutput</code> again with this marker value. If the value is null, there are no more results.</p>', 'PipelineDescription$description' => '<p>Description of the pipeline.</p>', 'PollForTaskInput$workerGroup' => '<p>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 <code>workerGroup</code> in the call to <code>PollForTask</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</p>', 'QueryObjectsInput$sphere' => '<p>Indicates whether the query applies to components or instances. The possible values are: <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>.</p>', 'QueryObjectsInput$marker' => '<p>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 <code>QueryObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>', 'QueryObjectsOutput$marker' => '<p>The starting point for the next page of results. To view the next page of results, call <code>QueryObjects</code> again with this marker value. If the value is null, there are no more results.</p>', 'ReportTaskRunnerHeartbeatInput$workerGroup' => '<p>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 <code>workerGroup</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</p>', 'Selector$fieldName' => '<p>The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.</p>', 'SetStatusInput$status' => '<p>The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>. For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>', 'SetTaskStatusInput$errorId' => '<p>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.</p>', 'SetTaskStatusInput$errorStackTrace' => '<p>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.</p>', 'stringList$member' => NULL, ], ], 'stringList' => [ 'base' => NULL, 'refs' => [ 'Operator$values' => '<p>The value that the actual field value will be compared with.</p>', 'RemoveTagsInput$tagKeys' => '<p>The keys of the tags to remove.</p>', ], ], 'tagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '<p>The key name of a tag defined by a user. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>', ], ], 'tagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsInput$tags' => '<p>The tags to add, as key/value pairs.</p>', 'CreatePipelineInput$tags' => '<p>A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>', 'PipelineDescription$tags' => '<p>A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>', ], ], 'tagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '<p>The optional value portion of a tag defined by a user. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>', ], ], 'taskId' => [ 'base' => NULL, 'refs' => [ 'ReportTaskProgressInput$taskId' => '<p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>', 'SetTaskStatusInput$taskId' => '<p>The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>.</p>', 'TaskObject$taskId' => '<p>An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions.</p>', ], ], 'timestamp' => [ 'base' => NULL, 'refs' => [ 'ActivatePipelineInput$startTimestamp' => '<p>The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.</p>', ], ], 'validationMessage' => [ 'base' => NULL, 'refs' => [ 'validationMessages$member' => NULL, ], ], 'validationMessages' => [ 'base' => NULL, 'refs' => [ 'ValidationError$errors' => '<p>A description of the validation error.</p>', 'ValidationWarning$warnings' => '<p>A description of the validation warning.</p>', ], ], ],];
