Table of Contents
DataPipeline.Client¶A low-level client representing AWS Data Pipeline
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.
import boto3
client = boto3.client('datapipeline')
These are the available methods:
activate_pipeline()add_tags()can_paginate()close()create_pipeline()deactivate_pipeline()delete_pipeline()describe_objects()describe_pipelines()evaluate_expression()get_paginator()get_pipeline_definition()get_waiter()list_pipelines()poll_for_task()put_pipeline_definition()query_objects()remove_tags()report_task_progress()report_task_runner_heartbeat()set_status()set_task_status()validate_pipeline_definition()activate_pipeline(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.activate_pipeline(
pipelineId='string',
parameterValues=[
{
'id': 'string',
'stringValue': 'string'
},
],
startTimestamp=datetime(2015, 1, 1)
)
[REQUIRED]
The ID of the pipeline.
A list of parameter values to pass to the pipeline at activation.
A value or list of parameter values.
The ID of the parameter value.
The field value, expressed as a String.
dict
Response Syntax
{}
Response Structure
(dict) --
Contains the output of ActivatePipeline.
Exceptions
DataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionDataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionAdds or modifies tags for the specified pipeline.
See also: AWS API Documentation
Request Syntax
response = client.add_tags(
pipelineId='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The ID of the pipeline.
[REQUIRED]
The tags to add, as key/value pairs.
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 Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
Contains the output of AddTags.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_pipeline(**kwargs)¶Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
See also: AWS API Documentation
Request Syntax
response = client.create_pipeline(
name='string',
uniqueId='string',
description='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
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.
[REQUIRED]
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.
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 .
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 Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
dict
Response Syntax
{
'pipelineId': 'string'
}
Response Structure
(dict) --
Contains the output of CreatePipeline.
pipelineId (string) --
The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE .
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptiondeactivate_pipeline(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.deactivate_pipeline(
pipelineId='string',
cancelActive=True|False
)
[REQUIRED]
The ID of the pipeline.
CANCELED . If this value is false, the pipeline is deactivated after all running objects finish.dict
Response Syntax
{}
Response Structure
(dict) --
Contains the output of DeactivatePipeline.
Exceptions
DataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionDataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptiondelete_pipeline(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_pipeline(
pipelineId='string'
)
[REQUIRED]
The ID of the pipeline.
Exceptions
DataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptiondescribe_objects(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_objects(
pipelineId='string',
objectIds=[
'string',
],
evaluateExpressions=True|False,
marker='string'
)
[REQUIRED]
The ID of the pipeline that contains the object definitions.
[REQUIRED]
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 .
DescribeObjects with the marker value from the previous call to retrieve the next set of results.dict
Response Syntax
{
'pipelineObjects': [
{
'id': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
},
],
'marker': 'string',
'hasMoreResults': True|False
}
Response Structure
(dict) --
Contains the output of DescribeObjects.
pipelineObjects (list) --
An array of object definitions.
(dict) --
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.
id (string) --
The ID of the object.
name (string) --
The name of the object.
fields (list) --
Key-value pairs that define the properties of the object.
(dict) --
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
key (string) --
The field identifier.
stringValue (string) --
The field value, expressed as a String.
refValue (string) --
The field value, expressed as the identifier of another object.
marker (string) --
The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results.
hasMoreResults (boolean) --
Indicates whether there are more results to return.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptiondescribe_pipelines(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_pipelines(
pipelineIds=[
'string',
]
)
[REQUIRED]
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 .
{
'pipelineDescriptionList': [
{
'pipelineId': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
],
'description': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
]
}
Response Structure
Contains the output of DescribePipelines.
An array of descriptions for the specified pipelines.
Contains pipeline metadata.
The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE .
The name of the pipeline.
A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
The field identifier.
The field value, expressed as a String.
The field value, expressed as the identifier of another object.
Description of the pipeline.
A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
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 Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
Exceptions
DataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionDataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionevaluate_expression(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.evaluate_expression(
pipelineId='string',
objectId='string',
expression='string'
)
[REQUIRED]
The ID of the pipeline.
[REQUIRED]
The ID of the object.
[REQUIRED]
The expression to evaluate.
dict
Response Syntax
{
'evaluatedExpression': 'string'
}
Response Structure
(dict) --
Contains the output of EvaluateExpression.
evaluatedExpression (string) --
The evaluated expression.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.TaskNotFoundExceptionDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_pipeline_definition(**kwargs)¶Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition .
See also: AWS API Documentation
Request Syntax
response = client.get_pipeline_definition(
pipelineId='string',
version='string'
)
[REQUIRED]
The ID of the pipeline.
latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.dict
Response Syntax
{
'pipelineObjects': [
{
'id': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
},
],
'parameterObjects': [
{
'id': 'string',
'attributes': [
{
'key': 'string',
'stringValue': 'string'
},
]
},
],
'parameterValues': [
{
'id': 'string',
'stringValue': 'string'
},
]
}
Response Structure
(dict) --
Contains the output of GetPipelineDefinition.
pipelineObjects (list) --
The objects defined in the pipeline.
(dict) --
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.
id (string) --
The ID of the object.
name (string) --
The name of the object.
fields (list) --
Key-value pairs that define the properties of the object.
(dict) --
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
key (string) --
The field identifier.
stringValue (string) --
The field value, expressed as a String.
refValue (string) --
The field value, expressed as the identifier of another object.
parameterObjects (list) --
The parameter objects used in the pipeline definition.
(dict) --
Contains information about a parameter object.
id (string) --
The ID of the parameter object.
attributes (list) --
The attributes of the parameter object.
(dict) --
The attributes allowed or specified with a parameter object.
key (string) --
The field identifier.
stringValue (string) --
The field value, expressed as a String.
parameterValues (list) --
The parameter values used in the pipeline definition.
(dict) --
A value or list of parameter values.
id (string) --
The ID of the parameter value.
stringValue (string) --
The field value, expressed as a String.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_pipelines(**kwargs)¶Lists the pipeline identifiers for all active pipelines that you have permission to access.
See also: AWS API Documentation
Request Syntax
response = client.list_pipelines(
marker='string'
)
ListPipelines with the marker value from the previous call to retrieve the next set of results.{
'pipelineIdList': [
{
'id': 'string',
'name': 'string'
},
],
'marker': 'string',
'hasMoreResults': True|False
}
Response Structure
Contains the output of ListPipelines.
The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition .
Contains the name and identifier of a pipeline.
The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE .
The name of the pipeline.
The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput again with this marker value. If the value is null, there are no more results.
Indicates whether there are more results that can be obtained by a subsequent call.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionpoll_for_task(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.poll_for_task(
workerGroup='string',
hostname='string',
instanceIdentity={
'document': 'string',
'signature': 'string'
}
)
[REQUIRED]
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.
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.
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.
A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.
dict
Response Syntax
{
'taskObject': {
'taskId': 'string',
'pipelineId': 'string',
'attemptId': 'string',
'objects': {
'string': {
'id': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
}
}
}
}
Response Structure
(dict) --
Contains the output of PollForTask.
taskObject (dict) --
The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId , which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus .
taskId (string) --
An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
pipelineId (string) --
The ID of the pipeline that provided the task.
attemptId (string) --
The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.
objects (dict) --
Connection information for the location where the task runner will publish the output of the task.
(string) --
(dict) --
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.
id (string) --
The ID of the object.
name (string) --
The name of the object.
fields (list) --
Key-value pairs that define the properties of the object.
(dict) --
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
key (string) --
The field identifier.
stringValue (string) --
The field value, expressed as a String.
refValue (string) --
The field value, expressed as the identifier of another object.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.TaskNotFoundExceptionput_pipeline_definition(**kwargs)¶Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.
PutPipelineDefinitionalso 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.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
See also: AWS API Documentation
Request Syntax
response = client.put_pipeline_definition(
pipelineId='string',
pipelineObjects=[
{
'id': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
},
],
parameterObjects=[
{
'id': 'string',
'attributes': [
{
'key': 'string',
'stringValue': 'string'
},
]
},
],
parameterValues=[
{
'id': 'string',
'stringValue': 'string'
},
]
)
[REQUIRED]
The ID of the pipeline.
[REQUIRED]
The objects that define the pipeline. These objects overwrite the existing pipeline definition.
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.
The ID of the object.
The name of the object.
Key-value pairs that define the properties of the object.
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
The field identifier.
The field value, expressed as a String.
The field value, expressed as the identifier of another object.
The parameter objects used with the pipeline.
Contains information about a parameter object.
The ID of the parameter object.
The attributes of the parameter object.
The attributes allowed or specified with a parameter object.
The field identifier.
The field value, expressed as a String.
The parameter values used with the pipeline.
A value or list of parameter values.
The ID of the parameter value.
The field value, expressed as a String.
dict
Response Syntax
{
'validationErrors': [
{
'id': 'string',
'errors': [
'string',
]
},
],
'validationWarnings': [
{
'id': 'string',
'warnings': [
'string',
]
},
],
'errored': True|False
}
Response Structure
(dict) --
Contains the output of PutPipelineDefinition.
validationErrors (list) --
The validation errors that are associated with the objects defined in pipelineObjects .
(dict) --
Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.
id (string) --
The identifier of the object that contains the validation error.
errors (list) --
A description of the validation error.
validationWarnings (list) --
The validation warnings that are associated with the objects defined in pipelineObjects .
(dict) --
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.
id (string) --
The identifier of the object that contains the validation warning.
warnings (list) --
A description of the validation warning.
errored (boolean) --
Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionquery_objects(**kwargs)¶Queries the specified pipeline for the names of objects that match the specified set of conditions.
See also: AWS API Documentation
Request Syntax
response = client.query_objects(
pipelineId='string',
query={
'selectors': [
{
'fieldName': 'string',
'operator': {
'type': 'EQ'|'REF_EQ'|'LE'|'GE'|'BETWEEN',
'values': [
'string',
]
}
},
]
},
sphere='string',
marker='string',
limit=123
)
[REQUIRED]
The ID of the pipeline.
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.
List of selectors that define the query. An object must satisfy all of the selectors to match the query.
A comparision that is used to determine whether a query should return this object.
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.
Contains a logical operation for comparing the value of a field with a specified value.
The logical operation to be performed: equal (EQ ), equal reference (REF_EQ ), less than or equal (LE ), greater than or equal (GE ), or between (BETWEEN ). Equal reference (REF_EQ ) 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.
The comparison operators EQ and REF_EQ act on the following fields:
The comparison operators GE , LE , and BETWEEN act on the following fields:
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".
The value that the actual field value will be compared with.
[REQUIRED]
Indicates whether the query applies to components or instances. The possible values are: COMPONENT , INSTANCE , and ATTEMPT .
QueryObjects with the marker value from the previous call to retrieve the next set of results.QueryObjects will return in a single call. The default value is 100.dict
Response Syntax
{
'ids': [
'string',
],
'marker': 'string',
'hasMoreResults': True|False
}
Response Structure
(dict) --
Contains the output of QueryObjects.
ids (list) --
The identifiers that match the query selectors.
marker (string) --
The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.
hasMoreResults (boolean) --
Indicates whether there are more results that can be obtained by a subsequent call.
Exceptions
DataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionDataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionRemoves existing tags from the specified pipeline.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags(
pipelineId='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ID of the pipeline.
[REQUIRED]
The keys of the tags to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
Contains the output of RemoveTags.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionreport_task_progress(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.report_task_progress(
taskId='string',
fields=[
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
)
[REQUIRED]
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask .
Key-value pairs that define the properties of the ReportTaskProgressInput object.
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
The field identifier.
The field value, expressed as a String.
The field value, expressed as the identifier of another object.
dict
Response Syntax
{
'canceled': True|False
}
Response Structure
(dict) --
Contains the output of ReportTaskProgress.
canceled (boolean) --
If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.TaskNotFoundExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionreport_task_runner_heartbeat(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.report_task_runner_heartbeat(
taskrunnerId='string',
workerGroup='string',
hostname='string'
)
[REQUIRED]
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.
workerGroup . There are no wildcard values permitted in workerGroup ; the string must be an exact, case-sensitive, match.dict
Response Syntax
{
'terminate': True|False
}
Response Structure
(dict) --
Contains the output of ReportTaskRunnerHeartbeat.
terminate (boolean) --
Indicates whether the calling task runner should terminate.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionset_status(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.set_status(
pipelineId='string',
objectIds=[
'string',
],
status='string'
)
[REQUIRED]
The ID of the pipeline that contains the objects.
[REQUIRED]
The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
[REQUIRED]
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 .
None
Exceptions
DataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionDataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionset_task_status(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.set_task_status(
taskId='string',
taskStatus='FINISHED'|'FAILED'|'FALSE',
errorId='string',
errorMessage='string',
errorStackTrace='string'
)
[REQUIRED]
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask .
[REQUIRED]
If FINISHED , the task successfully completed. If FAILED , the task ended unsuccessfully. Preconditions use false.
dict
Response Syntax
{}
Response Structure
(dict) --
Contains the output of SetTaskStatus.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.TaskNotFoundExceptionDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionvalidate_pipeline_definition(**kwargs)¶Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
See also: AWS API Documentation
Request Syntax
response = client.validate_pipeline_definition(
pipelineId='string',
pipelineObjects=[
{
'id': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
},
],
parameterObjects=[
{
'id': 'string',
'attributes': [
{
'key': 'string',
'stringValue': 'string'
},
]
},
],
parameterValues=[
{
'id': 'string',
'stringValue': 'string'
},
]
)
[REQUIRED]
The ID of the pipeline.
[REQUIRED]
The objects that define the pipeline changes to validate against the pipeline.
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.
The ID of the object.
The name of the object.
Key-value pairs that define the properties of the object.
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
The field identifier.
The field value, expressed as a String.
The field value, expressed as the identifier of another object.
The parameter objects used with the pipeline.
Contains information about a parameter object.
The ID of the parameter object.
The attributes of the parameter object.
The attributes allowed or specified with a parameter object.
The field identifier.
The field value, expressed as a String.
The parameter values used with the pipeline.
A value or list of parameter values.
The ID of the parameter value.
The field value, expressed as a String.
dict
Response Syntax
{
'validationErrors': [
{
'id': 'string',
'errors': [
'string',
]
},
],
'validationWarnings': [
{
'id': 'string',
'warnings': [
'string',
]
},
],
'errored': True|False
}
Response Structure
(dict) --
Contains the output of ValidatePipelineDefinition.
validationErrors (list) --
Any validation errors that were found.
(dict) --
Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.
id (string) --
The identifier of the object that contains the validation error.
errors (list) --
A description of the validation error.
validationWarnings (list) --
Any validation warnings that were found.
(dict) --
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.
id (string) --
The identifier of the object that contains the validation warning.
warnings (list) --
A description of the validation warning.
errored (boolean) --
Indicates whether there were validation errors.
Exceptions
DataPipeline.Client.exceptions.InternalServiceErrorDataPipeline.Client.exceptions.InvalidRequestExceptionDataPipeline.Client.exceptions.PipelineNotFoundExceptionDataPipeline.Client.exceptions.PipelineDeletedExceptionThe available paginators are:
DataPipeline.Paginator.DescribeObjectsDataPipeline.Paginator.ListPipelinesDataPipeline.Paginator.QueryObjectsDataPipeline.Paginator.DescribeObjects¶paginator = client.get_paginator('describe_objects')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DataPipeline.Client.describe_objects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
pipelineId='string',
objectIds=[
'string',
],
evaluateExpressions=True|False,
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the pipeline that contains the object definitions.
[REQUIRED]
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 .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'pipelineObjects': [
{
'id': 'string',
'name': 'string',
'fields': [
{
'key': 'string',
'stringValue': 'string',
'refValue': 'string'
},
]
},
],
'hasMoreResults': True|False,
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeObjects.
pipelineObjects (list) --
An array of object definitions.
(dict) --
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.
id (string) --
The ID of the object.
name (string) --
The name of the object.
fields (list) --
Key-value pairs that define the properties of the object.
(dict) --
A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue ) or a reference to another object (RefValue ) but not as both.
key (string) --
The field identifier.
stringValue (string) --
The field value, expressed as a String.
refValue (string) --
The field value, expressed as the identifier of another object.
hasMoreResults (boolean) --
Indicates whether there are more results to return.
NextToken (string) --
A token to resume pagination.
DataPipeline.Paginator.ListPipelines¶paginator = client.get_paginator('list_pipelines')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DataPipeline.Client.list_pipelines().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'pipelineIdList': [
{
'id': 'string',
'name': 'string'
},
],
'hasMoreResults': True|False,
'NextToken': 'string'
}
Response Structure
Contains the output of ListPipelines.
The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition .
Contains the name and identifier of a pipeline.
The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE .
The name of the pipeline.
Indicates whether there are more results that can be obtained by a subsequent call.
A token to resume pagination.
DataPipeline.Paginator.QueryObjects¶paginator = client.get_paginator('query_objects')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DataPipeline.Client.query_objects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
pipelineId='string',
query={
'selectors': [
{
'fieldName': 'string',
'operator': {
'type': 'EQ'|'REF_EQ'|'LE'|'GE'|'BETWEEN',
'values': [
'string',
]
}
},
]
},
sphere='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the pipeline.
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.
List of selectors that define the query. An object must satisfy all of the selectors to match the query.
A comparision that is used to determine whether a query should return this object.
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.
Contains a logical operation for comparing the value of a field with a specified value.
The logical operation to be performed: equal (EQ ), equal reference (REF_EQ ), less than or equal (LE ), greater than or equal (GE ), or between (BETWEEN ). Equal reference (REF_EQ ) 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.
The comparison operators EQ and REF_EQ act on the following fields:
The comparison operators GE , LE , and BETWEEN act on the following fields:
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".
The value that the actual field value will be compared with.
[REQUIRED]
Indicates whether the query applies to components or instances. The possible values are: COMPONENT , INSTANCE , and ATTEMPT .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ids': [
'string',
],
'hasMoreResults': True|False,
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of QueryObjects.
ids (list) --
The identifiers that match the query selectors.
hasMoreResults (boolean) --
Indicates whether there are more results that can be obtained by a subsequent call.
NextToken (string) --
A token to resume pagination.