DataPipelineClient
Index > DataPipeline > DataPipelineClient
Auto-generated documentation for DataPipeline type annotations stubs module mypy-boto3-datapipeline.
DataPipelineClient
Type annotations and code completion for boto3.client("datapipeline")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_datapipeline.client import DataPipelineClient
def get_datapipeline_client() -> DataPipelineClient:
return Session().client("datapipeline")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("datapipeline").exceptions
structure.
client = boto3.client("datapipeline")
try:
do_something(client)
except (
client.ClientError,
client.InternalServiceError,
client.InvalidRequestException,
client.PipelineDeletedException,
client.PipelineNotFoundException,
client.TaskNotFoundException,
) as e:
print(e)
from mypy_boto3_datapipeline.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
activate_pipeline
Validates the specified pipeline and starts processing pipeline tasks.
Type annotations and code completion for boto3.client("datapipeline").activate_pipeline
method.
boto3 documentation
def activate_pipeline(
self,
*,
pipelineId: str,
parameterValues: Sequence[ParameterValueTypeDef] = ..., # (1)
startTimestamp: Union[datetime, str] = ...,
) -> Dict[str, Any]:
...
kwargs: ActivatePipelineInputRequestTypeDef = { # (1)
"pipelineId": ...,
}
parent.activate_pipeline(**kwargs)
add_tags
Adds or modifies tags for the specified pipeline.
Type annotations and code completion for boto3.client("datapipeline").add_tags
method.
boto3 documentation
def add_tags(
self,
*,
pipelineId: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: AddTagsInputRequestTypeDef = { # (1)
"pipelineId": ...,
"tags": ...,
}
parent.add_tags(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("datapipeline").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("datapipeline").close
method.
boto3 documentation
create_pipeline
Creates a new, empty pipeline.
Type annotations and code completion for boto3.client("datapipeline").create_pipeline
method.
boto3 documentation
def create_pipeline(
self,
*,
name: str,
uniqueId: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePipelineOutputTypeDef: # (2)
...
kwargs: CreatePipelineInputRequestTypeDef = { # (1)
"name": ...,
"uniqueId": ...,
}
parent.create_pipeline(**kwargs)
deactivate_pipeline
Deactivates the specified running pipeline.
Type annotations and code completion for boto3.client("datapipeline").deactivate_pipeline
method.
boto3 documentation
def deactivate_pipeline(
self,
*,
pipelineId: str,
cancelActive: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeactivatePipelineInputRequestTypeDef = { # (1)
"pipelineId": ...,
}
parent.deactivate_pipeline(**kwargs)
delete_pipeline
Deletes a pipeline, its pipeline definition, and its run history.
Type annotations and code completion for boto3.client("datapipeline").delete_pipeline
method.
boto3 documentation
def delete_pipeline(
self,
*,
pipelineId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePipelineInputRequestTypeDef = { # (1)
"pipelineId": ...,
}
parent.delete_pipeline(**kwargs)
describe_objects
Gets the object definitions for a set of objects associated with the pipeline.
Type annotations and code completion for boto3.client("datapipeline").describe_objects
method.
boto3 documentation
def describe_objects(
self,
*,
pipelineId: str,
objectIds: Sequence[str],
evaluateExpressions: bool = ...,
marker: str = ...,
) -> DescribeObjectsOutputTypeDef: # (1)
...
kwargs: DescribeObjectsInputRequestTypeDef = { # (1)
"pipelineId": ...,
"objectIds": ...,
}
parent.describe_objects(**kwargs)
describe_pipelines
Retrieves metadata about one or more pipelines.
Type annotations and code completion for boto3.client("datapipeline").describe_pipelines
method.
boto3 documentation
def describe_pipelines(
self,
*,
pipelineIds: Sequence[str],
) -> DescribePipelinesOutputTypeDef: # (1)
...
kwargs: DescribePipelinesInputRequestTypeDef = { # (1)
"pipelineIds": ...,
}
parent.describe_pipelines(**kwargs)
evaluate_expression
Task runners call EvaluateExpression
to evaluate a string in the context of
the specified object.
Type annotations and code completion for boto3.client("datapipeline").evaluate_expression
method.
boto3 documentation
def evaluate_expression(
self,
*,
pipelineId: str,
objectId: str,
expression: str,
) -> EvaluateExpressionOutputTypeDef: # (1)
...
kwargs: EvaluateExpressionInputRequestTypeDef = { # (1)
"pipelineId": ...,
"objectId": ...,
"expression": ...,
}
parent.evaluate_expression(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("datapipeline").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_pipeline_definition
Gets the definition of the specified pipeline.
Type annotations and code completion for boto3.client("datapipeline").get_pipeline_definition
method.
boto3 documentation
def get_pipeline_definition(
self,
*,
pipelineId: str,
version: str = ...,
) -> GetPipelineDefinitionOutputTypeDef: # (1)
...
kwargs: GetPipelineDefinitionInputRequestTypeDef = { # (1)
"pipelineId": ...,
}
parent.get_pipeline_definition(**kwargs)
list_pipelines
Lists the pipeline identifiers for all active pipelines that you have permission to access.
Type annotations and code completion for boto3.client("datapipeline").list_pipelines
method.
boto3 documentation
def list_pipelines(
self,
*,
marker: str = ...,
) -> ListPipelinesOutputTypeDef: # (1)
...
kwargs: ListPipelinesInputRequestTypeDef = { # (1)
"marker": ...,
}
parent.list_pipelines(**kwargs)
poll_for_task
Task runners call PollForTask
to receive a task to perform from AWS Data
Pipeline.
Type annotations and code completion for boto3.client("datapipeline").poll_for_task
method.
boto3 documentation
def poll_for_task(
self,
*,
workerGroup: str,
hostname: str = ...,
instanceIdentity: InstanceIdentityTypeDef = ..., # (1)
) -> PollForTaskOutputTypeDef: # (2)
...
kwargs: PollForTaskInputRequestTypeDef = { # (1)
"workerGroup": ...,
}
parent.poll_for_task(**kwargs)
put_pipeline_definition
Adds tasks, schedules, and preconditions to the specified pipeline.
Type annotations and code completion for boto3.client("datapipeline").put_pipeline_definition
method.
boto3 documentation
def put_pipeline_definition(
self,
*,
pipelineId: str,
pipelineObjects: Sequence[PipelineObjectTypeDef], # (1)
parameterObjects: Sequence[ParameterObjectTypeDef] = ..., # (2)
parameterValues: Sequence[ParameterValueTypeDef] = ..., # (3)
) -> PutPipelineDefinitionOutputTypeDef: # (4)
...
- See PipelineObjectTypeDef
- See ParameterObjectTypeDef
- See ParameterValueTypeDef
- See PutPipelineDefinitionOutputTypeDef
kwargs: PutPipelineDefinitionInputRequestTypeDef = { # (1)
"pipelineId": ...,
"pipelineObjects": ...,
}
parent.put_pipeline_definition(**kwargs)
query_objects
Queries the specified pipeline for the names of objects that match the specified set of conditions.
Type annotations and code completion for boto3.client("datapipeline").query_objects
method.
boto3 documentation
def query_objects(
self,
*,
pipelineId: str,
sphere: str,
query: QueryTypeDef = ..., # (1)
marker: str = ...,
limit: int = ...,
) -> QueryObjectsOutputTypeDef: # (2)
...
kwargs: QueryObjectsInputRequestTypeDef = { # (1)
"pipelineId": ...,
"sphere": ...,
}
parent.query_objects(**kwargs)
remove_tags
Removes existing tags from the specified pipeline.
Type annotations and code completion for boto3.client("datapipeline").remove_tags
method.
boto3 documentation
def remove_tags(
self,
*,
pipelineId: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: RemoveTagsInputRequestTypeDef = { # (1)
"pipelineId": ...,
"tagKeys": ...,
}
parent.remove_tags(**kwargs)
report_task_progress
Task runners call ReportTaskProgress
when assigned a task to acknowledge that
it has the task.
Type annotations and code completion for boto3.client("datapipeline").report_task_progress
method.
boto3 documentation
def report_task_progress(
self,
*,
taskId: str,
fields: Sequence[FieldTypeDef] = ..., # (1)
) -> ReportTaskProgressOutputTypeDef: # (2)
...
kwargs: ReportTaskProgressInputRequestTypeDef = { # (1)
"taskId": ...,
}
parent.report_task_progress(**kwargs)
report_task_runner_heartbeat
Task runners call ReportTaskRunnerHeartbeat
every 15 minutes to indicate that
they are operational.
Type annotations and code completion for boto3.client("datapipeline").report_task_runner_heartbeat
method.
boto3 documentation
def report_task_runner_heartbeat(
self,
*,
taskrunnerId: str,
workerGroup: str = ...,
hostname: str = ...,
) -> ReportTaskRunnerHeartbeatOutputTypeDef: # (1)
...
kwargs: ReportTaskRunnerHeartbeatInputRequestTypeDef = { # (1)
"taskrunnerId": ...,
}
parent.report_task_runner_heartbeat(**kwargs)
set_status
Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.
Type annotations and code completion for boto3.client("datapipeline").set_status
method.
boto3 documentation
def set_status(
self,
*,
pipelineId: str,
objectIds: Sequence[str],
status: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: SetStatusInputRequestTypeDef = { # (1)
"pipelineId": ...,
"objectIds": ...,
"status": ...,
}
parent.set_status(**kwargs)
set_task_status
Task runners call SetTaskStatus
to notify AWS Data Pipeline that a task is
completed and provide information about the final status.
Type annotations and code completion for boto3.client("datapipeline").set_task_status
method.
boto3 documentation
def set_task_status(
self,
*,
taskId: str,
taskStatus: TaskStatusType, # (1)
errorId: str = ...,
errorMessage: str = ...,
errorStackTrace: str = ...,
) -> Dict[str, Any]:
...
- See TaskStatusType
kwargs: SetTaskStatusInputRequestTypeDef = { # (1)
"taskId": ...,
"taskStatus": ...,
}
parent.set_task_status(**kwargs)
validate_pipeline_definition
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
Type annotations and code completion for boto3.client("datapipeline").validate_pipeline_definition
method.
boto3 documentation
def validate_pipeline_definition(
self,
*,
pipelineId: str,
pipelineObjects: Sequence[PipelineObjectTypeDef], # (1)
parameterObjects: Sequence[ParameterObjectTypeDef] = ..., # (2)
parameterValues: Sequence[ParameterValueTypeDef] = ..., # (3)
) -> ValidatePipelineDefinitionOutputTypeDef: # (4)
...
- See PipelineObjectTypeDef
- See ParameterObjectTypeDef
- See ParameterValueTypeDef
- See ValidatePipelineDefinitionOutputTypeDef
kwargs: ValidatePipelineDefinitionInputRequestTypeDef = { # (1)
"pipelineId": ...,
"pipelineObjects": ...,
}
parent.validate_pipeline_definition(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("datapipeline").get_paginator
method with overloads.
client.get_paginator("describe_objects")
-> DescribeObjectsPaginatorclient.get_paginator("list_pipelines")
-> ListPipelinesPaginatorclient.get_paginator("query_objects")
-> QueryObjectsPaginator