Skip to content

Type definitions#

Index > DataPipeline > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ParameterValueTypeDef#

# ParameterValueTypeDef definition

class ParameterValueTypeDef(TypedDict):
    id: str,
    stringValue: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeactivatePipelineInputRequestTypeDef#

# DeactivatePipelineInputRequestTypeDef definition

class DeactivatePipelineInputRequestTypeDef(TypedDict):
    pipelineId: str,
    cancelActive: NotRequired[bool],

DeletePipelineInputRequestTypeDef#

# DeletePipelineInputRequestTypeDef definition

class DeletePipelineInputRequestTypeDef(TypedDict):
    pipelineId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeObjectsInputRequestTypeDef#

# DescribeObjectsInputRequestTypeDef definition

class DescribeObjectsInputRequestTypeDef(TypedDict):
    pipelineId: str,
    objectIds: Sequence[str],
    evaluateExpressions: NotRequired[bool],
    marker: NotRequired[str],

DescribePipelinesInputRequestTypeDef#

# DescribePipelinesInputRequestTypeDef definition

class DescribePipelinesInputRequestTypeDef(TypedDict):
    pipelineIds: Sequence[str],

EvaluateExpressionInputRequestTypeDef#

# EvaluateExpressionInputRequestTypeDef definition

class EvaluateExpressionInputRequestTypeDef(TypedDict):
    pipelineId: str,
    objectId: str,
    expression: str,

FieldTypeDef#

# FieldTypeDef definition

class FieldTypeDef(TypedDict):
    key: str,
    stringValue: NotRequired[str],
    refValue: NotRequired[str],

GetPipelineDefinitionInputRequestTypeDef#

# GetPipelineDefinitionInputRequestTypeDef definition

class GetPipelineDefinitionInputRequestTypeDef(TypedDict):
    pipelineId: str,
    version: NotRequired[str],

InstanceIdentityTypeDef#

# InstanceIdentityTypeDef definition

class InstanceIdentityTypeDef(TypedDict):
    document: NotRequired[str],
    signature: NotRequired[str],

ListPipelinesInputRequestTypeDef#

# ListPipelinesInputRequestTypeDef definition

class ListPipelinesInputRequestTypeDef(TypedDict):
    marker: NotRequired[str],

PipelineIdNameTypeDef#

# PipelineIdNameTypeDef definition

class PipelineIdNameTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],

OperatorTypeDef#

# OperatorTypeDef definition

class OperatorTypeDef(TypedDict):
    type: NotRequired[OperatorTypeType],  # (1)
    values: NotRequired[Sequence[str]],
  1. See OperatorTypeType

ParameterAttributeTypeDef#

# ParameterAttributeTypeDef definition

class ParameterAttributeTypeDef(TypedDict):
    key: str,
    stringValue: str,

ValidationErrorTypeDef#

# ValidationErrorTypeDef definition

class ValidationErrorTypeDef(TypedDict):
    id: NotRequired[str],
    errors: NotRequired[List[str]],

ValidationWarningTypeDef#

# ValidationWarningTypeDef definition

class ValidationWarningTypeDef(TypedDict):
    id: NotRequired[str],
    warnings: NotRequired[List[str]],

RemoveTagsInputRequestTypeDef#

# RemoveTagsInputRequestTypeDef definition

class RemoveTagsInputRequestTypeDef(TypedDict):
    pipelineId: str,
    tagKeys: Sequence[str],

ReportTaskRunnerHeartbeatInputRequestTypeDef#

# ReportTaskRunnerHeartbeatInputRequestTypeDef definition

class ReportTaskRunnerHeartbeatInputRequestTypeDef(TypedDict):
    taskrunnerId: str,
    workerGroup: NotRequired[str],
    hostname: NotRequired[str],

SetStatusInputRequestTypeDef#

# SetStatusInputRequestTypeDef definition

class SetStatusInputRequestTypeDef(TypedDict):
    pipelineId: str,
    objectIds: Sequence[str],
    status: str,

SetTaskStatusInputRequestTypeDef#

# SetTaskStatusInputRequestTypeDef definition

class SetTaskStatusInputRequestTypeDef(TypedDict):
    taskId: str,
    taskStatus: TaskStatusType,  # (1)
    errorId: NotRequired[str],
    errorMessage: NotRequired[str],
    errorStackTrace: NotRequired[str],
  1. See TaskStatusType

ActivatePipelineInputRequestTypeDef#

# ActivatePipelineInputRequestTypeDef definition

class ActivatePipelineInputRequestTypeDef(TypedDict):
    pipelineId: str,
    parameterValues: NotRequired[Sequence[ParameterValueTypeDef]],  # (1)
    startTimestamp: NotRequired[Union[datetime, str]],
  1. See ParameterValueTypeDef

AddTagsInputRequestTypeDef#

# AddTagsInputRequestTypeDef definition

class AddTagsInputRequestTypeDef(TypedDict):
    pipelineId: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreatePipelineInputRequestTypeDef#

# CreatePipelineInputRequestTypeDef definition

class CreatePipelineInputRequestTypeDef(TypedDict):
    name: str,
    uniqueId: str,
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreatePipelineOutputTypeDef#

# CreatePipelineOutputTypeDef definition

class CreatePipelineOutputTypeDef(TypedDict):
    pipelineId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EvaluateExpressionOutputTypeDef#

# EvaluateExpressionOutputTypeDef definition

class EvaluateExpressionOutputTypeDef(TypedDict):
    evaluatedExpression: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

QueryObjectsOutputTypeDef#

# QueryObjectsOutputTypeDef definition

class QueryObjectsOutputTypeDef(TypedDict):
    ids: List[str],
    marker: str,
    hasMoreResults: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReportTaskProgressOutputTypeDef#

# ReportTaskProgressOutputTypeDef definition

class ReportTaskProgressOutputTypeDef(TypedDict):
    canceled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReportTaskRunnerHeartbeatOutputTypeDef#

# ReportTaskRunnerHeartbeatOutputTypeDef definition

class ReportTaskRunnerHeartbeatOutputTypeDef(TypedDict):
    terminate: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeObjectsInputDescribeObjectsPaginateTypeDef#

# DescribeObjectsInputDescribeObjectsPaginateTypeDef definition

class DescribeObjectsInputDescribeObjectsPaginateTypeDef(TypedDict):
    pipelineId: str,
    objectIds: Sequence[str],
    evaluateExpressions: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPipelinesInputListPipelinesPaginateTypeDef#

# ListPipelinesInputListPipelinesPaginateTypeDef definition

class ListPipelinesInputListPipelinesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

PipelineDescriptionTypeDef#

# PipelineDescriptionTypeDef definition

class PipelineDescriptionTypeDef(TypedDict):
    pipelineId: str,
    name: str,
    fields: List[FieldTypeDef],  # (1)
    description: NotRequired[str],
    tags: NotRequired[List[TagTypeDef]],  # (2)
  1. See FieldTypeDef
  2. See TagTypeDef

PipelineObjectTypeDef#

# PipelineObjectTypeDef definition

class PipelineObjectTypeDef(TypedDict):
    id: str,
    name: str,
    fields: List[FieldTypeDef],  # (1)
  1. See FieldTypeDef

ReportTaskProgressInputRequestTypeDef#

# ReportTaskProgressInputRequestTypeDef definition

class ReportTaskProgressInputRequestTypeDef(TypedDict):
    taskId: str,
    fields: NotRequired[Sequence[FieldTypeDef]],  # (1)
  1. See FieldTypeDef

PollForTaskInputRequestTypeDef#

# PollForTaskInputRequestTypeDef definition

class PollForTaskInputRequestTypeDef(TypedDict):
    workerGroup: str,
    hostname: NotRequired[str],
    instanceIdentity: NotRequired[InstanceIdentityTypeDef],  # (1)
  1. See InstanceIdentityTypeDef

ListPipelinesOutputTypeDef#

# ListPipelinesOutputTypeDef definition

class ListPipelinesOutputTypeDef(TypedDict):
    pipelineIdList: List[PipelineIdNameTypeDef],  # (1)
    marker: str,
    hasMoreResults: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineIdNameTypeDef
  2. See ResponseMetadataTypeDef

SelectorTypeDef#

# SelectorTypeDef definition

class SelectorTypeDef(TypedDict):
    fieldName: NotRequired[str],
    operator: NotRequired[OperatorTypeDef],  # (1)
  1. See OperatorTypeDef

ParameterObjectTypeDef#

# ParameterObjectTypeDef definition

class ParameterObjectTypeDef(TypedDict):
    id: str,
    attributes: List[ParameterAttributeTypeDef],  # (1)
  1. See ParameterAttributeTypeDef

PutPipelineDefinitionOutputTypeDef#

# PutPipelineDefinitionOutputTypeDef definition

class PutPipelineDefinitionOutputTypeDef(TypedDict):
    validationErrors: List[ValidationErrorTypeDef],  # (1)
    validationWarnings: List[ValidationWarningTypeDef],  # (2)
    errored: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ValidationErrorTypeDef
  2. See ValidationWarningTypeDef
  3. See ResponseMetadataTypeDef

ValidatePipelineDefinitionOutputTypeDef#

# ValidatePipelineDefinitionOutputTypeDef definition

class ValidatePipelineDefinitionOutputTypeDef(TypedDict):
    validationErrors: List[ValidationErrorTypeDef],  # (1)
    validationWarnings: List[ValidationWarningTypeDef],  # (2)
    errored: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ValidationErrorTypeDef
  2. See ValidationWarningTypeDef
  3. See ResponseMetadataTypeDef

DescribePipelinesOutputTypeDef#

# DescribePipelinesOutputTypeDef definition

class DescribePipelinesOutputTypeDef(TypedDict):
    pipelineDescriptionList: List[PipelineDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeObjectsOutputTypeDef#

# DescribeObjectsOutputTypeDef definition

class DescribeObjectsOutputTypeDef(TypedDict):
    pipelineObjects: List[PipelineObjectTypeDef],  # (1)
    marker: str,
    hasMoreResults: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineObjectTypeDef
  2. See ResponseMetadataTypeDef

TaskObjectTypeDef#

# TaskObjectTypeDef definition

class TaskObjectTypeDef(TypedDict):
    taskId: NotRequired[str],
    pipelineId: NotRequired[str],
    attemptId: NotRequired[str],
    objects: NotRequired[Dict[str, PipelineObjectTypeDef]],  # (1)
  1. See PipelineObjectTypeDef

QueryTypeDef#

# QueryTypeDef definition

class QueryTypeDef(TypedDict):
    selectors: NotRequired[Sequence[SelectorTypeDef]],  # (1)
  1. See SelectorTypeDef

GetPipelineDefinitionOutputTypeDef#

# GetPipelineDefinitionOutputTypeDef definition

class GetPipelineDefinitionOutputTypeDef(TypedDict):
    pipelineObjects: List[PipelineObjectTypeDef],  # (1)
    parameterObjects: List[ParameterObjectTypeDef],  # (2)
    parameterValues: List[ParameterValueTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See PipelineObjectTypeDef
  2. See ParameterObjectTypeDef
  3. See ParameterValueTypeDef
  4. See ResponseMetadataTypeDef

PutPipelineDefinitionInputRequestTypeDef#

# PutPipelineDefinitionInputRequestTypeDef definition

class PutPipelineDefinitionInputRequestTypeDef(TypedDict):
    pipelineId: str,
    pipelineObjects: Sequence[PipelineObjectTypeDef],  # (1)
    parameterObjects: NotRequired[Sequence[ParameterObjectTypeDef]],  # (2)
    parameterValues: NotRequired[Sequence[ParameterValueTypeDef]],  # (3)
  1. See PipelineObjectTypeDef
  2. See ParameterObjectTypeDef
  3. See ParameterValueTypeDef

ValidatePipelineDefinitionInputRequestTypeDef#

# ValidatePipelineDefinitionInputRequestTypeDef definition

class ValidatePipelineDefinitionInputRequestTypeDef(TypedDict):
    pipelineId: str,
    pipelineObjects: Sequence[PipelineObjectTypeDef],  # (1)
    parameterObjects: NotRequired[Sequence[ParameterObjectTypeDef]],  # (2)
    parameterValues: NotRequired[Sequence[ParameterValueTypeDef]],  # (3)
  1. See PipelineObjectTypeDef
  2. See ParameterObjectTypeDef
  3. See ParameterValueTypeDef

PollForTaskOutputTypeDef#

# PollForTaskOutputTypeDef definition

class PollForTaskOutputTypeDef(TypedDict):
    taskObject: TaskObjectTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TaskObjectTypeDef
  2. See ResponseMetadataTypeDef

QueryObjectsInputQueryObjectsPaginateTypeDef#

# QueryObjectsInputQueryObjectsPaginateTypeDef definition

class QueryObjectsInputQueryObjectsPaginateTypeDef(TypedDict):
    pipelineId: str,
    sphere: str,
    query: NotRequired[QueryTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QueryTypeDef
  2. See PaginatorConfigTypeDef

QueryObjectsInputRequestTypeDef#

# QueryObjectsInputRequestTypeDef definition

class QueryObjectsInputRequestTypeDef(TypedDict):
    pipelineId: str,
    sphere: str,
    query: NotRequired[QueryTypeDef],  # (1)
    marker: NotRequired[str],
    limit: NotRequired[int],
  1. See QueryTypeDef