Skip to content

DataPipelineClient#

Index > DataPipeline > DataPipelineClient

Auto-generated documentation for DataPipeline type annotations stubs module types-boto3-datapipeline.

DataPipelineClient#

Type annotations and code completion for boto3.client("datapipeline"). boto3 documentation

# DataPipelineClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("datapipeline")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalServiceError,
    client.exceptions.InvalidRequestException,
    client.exceptions.PipelineDeletedException,
    client.exceptions.PipelineNotFoundException,
    client.exceptions.TaskNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_datapipeline.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("datapipeline").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("datapipeline").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

# activate_pipeline method definition

def activate_pipeline(
    self,
    *,
    pipelineId: str,
    parameterValues: Sequence[ParameterValueTypeDef] = ...,  # (1)
    startTimestamp: TimestampTypeDef = ...,
) -> Dict[str, Any]:
    ...
  1. See Sequence[ParameterValueTypeDef]
# activate_pipeline method usage example with argument unpacking

kwargs: ActivatePipelineInputTypeDef = {  # (1)
    "pipelineId": ...,
}

parent.activate_pipeline(**kwargs)
  1. See ActivatePipelineInputTypeDef

add_tags#

Adds or modifies tags for the specified pipeline.

Type annotations and code completion for boto3.client("datapipeline").add_tags method. boto3 documentation

# add_tags method definition

def add_tags(
    self,
    *,
    pipelineId: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# add_tags method usage example with argument unpacking

kwargs: AddTagsInputTypeDef = {  # (1)
    "pipelineId": ...,
    "tags": ...,
}

parent.add_tags(**kwargs)
  1. See AddTagsInputTypeDef

create_pipeline#

Creates a new, empty pipeline.

Type annotations and code completion for boto3.client("datapipeline").create_pipeline method. boto3 documentation

# create_pipeline method definition

def create_pipeline(
    self,
    *,
    name: str,
    uniqueId: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePipelineOutputTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreatePipelineOutputTypeDef
# create_pipeline method usage example with argument unpacking

kwargs: CreatePipelineInputTypeDef = {  # (1)
    "name": ...,
    "uniqueId": ...,
}

parent.create_pipeline(**kwargs)
  1. See CreatePipelineInputTypeDef

deactivate_pipeline#

Deactivates the specified running pipeline.

Type annotations and code completion for boto3.client("datapipeline").deactivate_pipeline method. boto3 documentation

# deactivate_pipeline method definition

def deactivate_pipeline(
    self,
    *,
    pipelineId: str,
    cancelActive: bool = ...,
) -> Dict[str, Any]:
    ...
# deactivate_pipeline method usage example with argument unpacking

kwargs: DeactivatePipelineInputTypeDef = {  # (1)
    "pipelineId": ...,
}

parent.deactivate_pipeline(**kwargs)
  1. See DeactivatePipelineInputTypeDef

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

# delete_pipeline method definition

def delete_pipeline(
    self,
    *,
    pipelineId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_pipeline method usage example with argument unpacking

kwargs: DeletePipelineInputTypeDef = {  # (1)
    "pipelineId": ...,
}

parent.delete_pipeline(**kwargs)
  1. See DeletePipelineInputTypeDef

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

# describe_objects method definition

def describe_objects(
    self,
    *,
    pipelineId: str,
    objectIds: Sequence[str],
    evaluateExpressions: bool = ...,
    marker: str = ...,
) -> DescribeObjectsOutputTypeDef:  # (1)
    ...
  1. See DescribeObjectsOutputTypeDef
# describe_objects method usage example with argument unpacking

kwargs: DescribeObjectsInputTypeDef = {  # (1)
    "pipelineId": ...,
    "objectIds": ...,
}

parent.describe_objects(**kwargs)
  1. See DescribeObjectsInputTypeDef

describe_pipelines#

Retrieves metadata about one or more pipelines.

Type annotations and code completion for boto3.client("datapipeline").describe_pipelines method. boto3 documentation

# describe_pipelines method definition

def describe_pipelines(
    self,
    *,
    pipelineIds: Sequence[str],
) -> DescribePipelinesOutputTypeDef:  # (1)
    ...
  1. See DescribePipelinesOutputTypeDef
# describe_pipelines method usage example with argument unpacking

kwargs: DescribePipelinesInputTypeDef = {  # (1)
    "pipelineIds": ...,
}

parent.describe_pipelines(**kwargs)
  1. See DescribePipelinesInputTypeDef

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

# evaluate_expression method definition

def evaluate_expression(
    self,
    *,
    pipelineId: str,
    objectId: str,
    expression: str,
) -> EvaluateExpressionOutputTypeDef:  # (1)
    ...
  1. See EvaluateExpressionOutputTypeDef
# evaluate_expression method usage example with argument unpacking

kwargs: EvaluateExpressionInputTypeDef = {  # (1)
    "pipelineId": ...,
    "objectId": ...,
    "expression": ...,
}

parent.evaluate_expression(**kwargs)
  1. See EvaluateExpressionInputTypeDef

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

# get_pipeline_definition method definition

def get_pipeline_definition(
    self,
    *,
    pipelineId: str,
    version: str = ...,
) -> GetPipelineDefinitionOutputTypeDef:  # (1)
    ...
  1. See GetPipelineDefinitionOutputTypeDef
# get_pipeline_definition method usage example with argument unpacking

kwargs: GetPipelineDefinitionInputTypeDef = {  # (1)
    "pipelineId": ...,
}

parent.get_pipeline_definition(**kwargs)
  1. See GetPipelineDefinitionInputTypeDef

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

# list_pipelines method definition

def list_pipelines(
    self,
    *,
    marker: str = ...,
) -> ListPipelinesOutputTypeDef:  # (1)
    ...
  1. See ListPipelinesOutputTypeDef
# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesInputTypeDef = {  # (1)
    "marker": ...,
}

parent.list_pipelines(**kwargs)
  1. See ListPipelinesInputTypeDef

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

# poll_for_task method definition

def poll_for_task(
    self,
    *,
    workerGroup: str,
    hostname: str = ...,
    instanceIdentity: InstanceIdentityTypeDef = ...,  # (1)
) -> PollForTaskOutputTypeDef:  # (2)
    ...
  1. See InstanceIdentityTypeDef
  2. See PollForTaskOutputTypeDef
# poll_for_task method usage example with argument unpacking

kwargs: PollForTaskInputTypeDef = {  # (1)
    "workerGroup": ...,
}

parent.poll_for_task(**kwargs)
  1. See PollForTaskInputTypeDef

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

# put_pipeline_definition method definition

def put_pipeline_definition(
    self,
    *,
    pipelineId: str,
    pipelineObjects: Sequence[PipelineObjectUnionTypeDef],  # (1)
    parameterObjects: Sequence[ParameterObjectUnionTypeDef] = ...,  # (2)
    parameterValues: Sequence[ParameterValueTypeDef] = ...,  # (3)
) -> PutPipelineDefinitionOutputTypeDef:  # (4)
    ...
  1. See Sequence[PipelineObjectUnionTypeDef]
  2. See Sequence[ParameterObjectUnionTypeDef]
  3. See Sequence[ParameterValueTypeDef]
  4. See PutPipelineDefinitionOutputTypeDef
# put_pipeline_definition method usage example with argument unpacking

kwargs: PutPipelineDefinitionInputTypeDef = {  # (1)
    "pipelineId": ...,
    "pipelineObjects": ...,
}

parent.put_pipeline_definition(**kwargs)
  1. See PutPipelineDefinitionInputTypeDef

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

# query_objects method definition

def query_objects(
    self,
    *,
    pipelineId: str,
    sphere: str,
    query: QueryTypeDef = ...,  # (1)
    marker: str = ...,
    limit: int = ...,
) -> QueryObjectsOutputTypeDef:  # (2)
    ...
  1. See QueryTypeDef
  2. See QueryObjectsOutputTypeDef
# query_objects method usage example with argument unpacking

kwargs: QueryObjectsInputTypeDef = {  # (1)
    "pipelineId": ...,
    "sphere": ...,
}

parent.query_objects(**kwargs)
  1. See QueryObjectsInputTypeDef

remove_tags#

Removes existing tags from the specified pipeline.

Type annotations and code completion for boto3.client("datapipeline").remove_tags method. boto3 documentation

# remove_tags method definition

def remove_tags(
    self,
    *,
    pipelineId: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# remove_tags method usage example with argument unpacking

kwargs: RemoveTagsInputTypeDef = {  # (1)
    "pipelineId": ...,
    "tagKeys": ...,
}

parent.remove_tags(**kwargs)
  1. See RemoveTagsInputTypeDef

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

# report_task_progress method definition

def report_task_progress(
    self,
    *,
    taskId: str,
    fields: Sequence[FieldTypeDef] = ...,  # (1)
) -> ReportTaskProgressOutputTypeDef:  # (2)
    ...
  1. See Sequence[FieldTypeDef]
  2. See ReportTaskProgressOutputTypeDef
# report_task_progress method usage example with argument unpacking

kwargs: ReportTaskProgressInputTypeDef = {  # (1)
    "taskId": ...,
}

parent.report_task_progress(**kwargs)
  1. See ReportTaskProgressInputTypeDef

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

# report_task_runner_heartbeat method definition

def report_task_runner_heartbeat(
    self,
    *,
    taskrunnerId: str,
    workerGroup: str = ...,
    hostname: str = ...,
) -> ReportTaskRunnerHeartbeatOutputTypeDef:  # (1)
    ...
  1. See ReportTaskRunnerHeartbeatOutputTypeDef
# report_task_runner_heartbeat method usage example with argument unpacking

kwargs: ReportTaskRunnerHeartbeatInputTypeDef = {  # (1)
    "taskrunnerId": ...,
}

parent.report_task_runner_heartbeat(**kwargs)
  1. See ReportTaskRunnerHeartbeatInputTypeDef

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

# set_status method definition

def set_status(
    self,
    *,
    pipelineId: str,
    objectIds: Sequence[str],
    status: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# set_status method usage example with argument unpacking

kwargs: SetStatusInputTypeDef = {  # (1)
    "pipelineId": ...,
    "objectIds": ...,
    "status": ...,
}

parent.set_status(**kwargs)
  1. See SetStatusInputTypeDef

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

# set_task_status method definition

def set_task_status(
    self,
    *,
    taskId: str,
    taskStatus: TaskStatusType,  # (1)
    errorId: str = ...,
    errorMessage: str = ...,
    errorStackTrace: str = ...,
) -> Dict[str, Any]:
    ...
  1. See TaskStatusType
# set_task_status method usage example with argument unpacking

kwargs: SetTaskStatusInputTypeDef = {  # (1)
    "taskId": ...,
    "taskStatus": ...,
}

parent.set_task_status(**kwargs)
  1. See SetTaskStatusInputTypeDef

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

# validate_pipeline_definition method definition

def validate_pipeline_definition(
    self,
    *,
    pipelineId: str,
    pipelineObjects: Sequence[PipelineObjectUnionTypeDef],  # (1)
    parameterObjects: Sequence[ParameterObjectUnionTypeDef] = ...,  # (2)
    parameterValues: Sequence[ParameterValueTypeDef] = ...,  # (3)
) -> ValidatePipelineDefinitionOutputTypeDef:  # (4)
    ...
  1. See Sequence[PipelineObjectUnionTypeDef]
  2. See Sequence[ParameterObjectUnionTypeDef]
  3. See Sequence[ParameterValueTypeDef]
  4. See ValidatePipelineDefinitionOutputTypeDef
# validate_pipeline_definition method usage example with argument unpacking

kwargs: ValidatePipelineDefinitionInputTypeDef = {  # (1)
    "pipelineId": ...,
    "pipelineObjects": ...,
}

parent.validate_pipeline_definition(**kwargs)
  1. See ValidatePipelineDefinitionInputTypeDef

get_paginator#

Type annotations and code completion for boto3.client("datapipeline").get_paginator method with overloads.