Skip to content

Datapipeline Classes

ActivatePipelineInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

parameterValues

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterValueTypeDef]]

startTimestamp

  • Type: typing.Union[datetime.datetime, str, NoneType]

AddTagsInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

tags

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.TagTypeDef]
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CreatePipelineInputRequestTypeDef

name

  • Type:
  • Required: Yes

uniqueId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.TagTypeDef]]

CreatePipelineOutputTypeDef

pipelineId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeactivatePipelineInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

cancelActive

  • Type: typing.Optional[bool]

DeletePipelineInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

DescribeObjectsInputDescribeObjectsPaginateTypeDef

pipelineId

  • Type:
  • Required: Yes

objectIds

  • Type: typing.Sequence[str]
  • Required: Yes

evaluateExpressions

  • Type: typing.Optional[bool]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.PaginatorConfigTypeDef]

DescribeObjectsInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

objectIds

  • Type: typing.Sequence[str]
  • Required: Yes

evaluateExpressions

  • Type: typing.Optional[bool]

marker

  • Type: typing.Optional[str]

DescribeObjectsOutputTypeDef

pipelineObjects

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.PipelineObjectTypeDef]
  • Required: Yes

marker

  • Type:
  • Required: Yes

hasMoreResults

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribePipelinesInputRequestTypeDef

pipelineIds

  • Type: typing.Sequence[str]
  • Required: Yes

DescribePipelinesOutputTypeDef

pipelineDescriptionList

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.PipelineDescriptionTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EmptyResponseMetadataTypeDef

ResponseMetadata

  • Type:
  • Required: Yes

EvaluateExpressionInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

objectId

  • Type:
  • Required: Yes

expression

  • Type:
  • Required: Yes

EvaluateExpressionOutputTypeDef

evaluatedExpression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

FieldTypeDef

key

  • Type:
  • Required: Yes

stringValue

  • Type: typing.Optional[str]

refValue

  • Type: typing.Optional[str]

GetPipelineDefinitionInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

version

  • Type: typing.Optional[str]

GetPipelineDefinitionOutputTypeDef

pipelineObjects

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.PipelineObjectTypeDef]
  • Required: Yes

parameterObjects

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterObjectTypeDef]
  • Required: Yes

parameterValues

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterValueTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

InstanceIdentityTypeDef

document

  • Type: typing.Optional[str]

signature

  • Type: typing.Optional[str]

ListPipelinesInputListPipelinesPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.PaginatorConfigTypeDef]

ListPipelinesInputRequestTypeDef

marker

  • Type: typing.Optional[str]

ListPipelinesOutputTypeDef

pipelineIdList

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.PipelineIdNameTypeDef]
  • Required: Yes

marker

  • Type:
  • Required: Yes

hasMoreResults

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

OperatorTypeDef

type

  • Type: typing.Optional[typing.Literal['BETWEEN', 'EQ', 'GE', 'LE', 'REF_EQ']]

values

  • Type: typing.Optional[typing.Sequence[str]]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ParameterAttributeTypeDef

key

  • Type:
  • Required: Yes

stringValue

  • Type:
  • Required: Yes

ParameterObjectTypeDef

id

  • Type:
  • Required: Yes

attributes

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterAttributeTypeDef]
  • Required: Yes

ParameterValueTypeDef

id

  • Type:
  • Required: Yes

stringValue

  • Type:
  • Required: Yes

PipelineDescriptionTypeDef

pipelineId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

fields

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.FieldTypeDef]
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.TagTypeDef]]

PipelineIdNameTypeDef

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

PipelineObjectTypeDef

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

fields

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.FieldTypeDef]
  • Required: Yes

PollForTaskInputRequestTypeDef

workerGroup

  • Type:
  • Required: Yes

hostname

  • Type: typing.Optional[str]

instanceIdentity

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.InstanceIdentityTypeDef]

PollForTaskOutputTypeDef

taskObject

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutPipelineDefinitionInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

pipelineObjects

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.PipelineObjectTypeDef]
  • Required: Yes

parameterObjects

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterObjectTypeDef]]

parameterValues

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterValueTypeDef]]

PutPipelineDefinitionOutputTypeDef

validationErrors

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ValidationErrorTypeDef]
  • Required: Yes

validationWarnings

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ValidationWarningTypeDef]
  • Required: Yes

errored

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

QueryObjectsInputQueryObjectsPaginateTypeDef

pipelineId

  • Type:
  • Required: Yes

sphere

  • Type:
  • Required: Yes

query

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.QueryTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.PaginatorConfigTypeDef]

QueryObjectsInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

sphere

  • Type:
  • Required: Yes

query

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.QueryTypeDef]

marker

  • Type: typing.Optional[str]

limit

  • Type: typing.Optional[int]

QueryObjectsOutputTypeDef

ids

  • Type: typing.List[str]
  • Required: Yes

marker

  • Type:
  • Required: Yes

hasMoreResults

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

QueryTypeDef

selectors

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.SelectorTypeDef]]

RemoveTagsInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

ReportTaskProgressInputRequestTypeDef

taskId

  • Type:
  • Required: Yes

fields

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.FieldTypeDef]]

ReportTaskProgressOutputTypeDef

canceled

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ReportTaskRunnerHeartbeatInputRequestTypeDef

taskrunnerId

  • Type:
  • Required: Yes

workerGroup

  • Type: typing.Optional[str]

hostname

  • Type: typing.Optional[str]

ReportTaskRunnerHeartbeatOutputTypeDef

terminate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

SelectorTypeDef

fieldName

  • Type: typing.Optional[str]

operator

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline_classes.OperatorTypeDef]

SetStatusInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

objectIds

  • Type: typing.Sequence[str]
  • Required: Yes

status

  • Type:
  • Required: Yes

SetTaskStatusInputRequestTypeDef

taskId

  • Type:
  • Required: Yes

taskStatus

  • Type: typing.Literal['FAILED', 'FALSE', 'FINISHED']
  • Required: Yes

errorId

  • Type: typing.Optional[str]

errorMessage

  • Type: typing.Optional[str]

errorStackTrace

  • Type: typing.Optional[str]

TagTypeDef

key

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

TaskObjectTypeDef

taskId

  • Type: typing.Optional[str]

pipelineId

  • Type: typing.Optional[str]

attemptId

  • Type: typing.Optional[str]

objects

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.datapipeline_classes.PipelineObjectTypeDef]]

ValidatePipelineDefinitionInputRequestTypeDef

pipelineId

  • Type:
  • Required: Yes

pipelineObjects

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.PipelineObjectTypeDef]
  • Required: Yes

parameterObjects

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterObjectTypeDef]]

parameterValues

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.datapipeline_classes.ParameterValueTypeDef]]

ValidatePipelineDefinitionOutputTypeDef

validationErrors

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ValidationErrorTypeDef]
  • Required: Yes

validationWarnings

  • Type: typing.List[aws_resource_validator.pydantic_models.datapipeline_classes.ValidationWarningTypeDef]
  • Required: Yes

errored

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidationErrorTypeDef

id

  • Type: typing.Optional[str]

errors

  • Type: typing.Optional[typing.List[str]]

ValidationWarningTypeDef

id

  • Type: typing.Optional[str]

warnings

  • Type: typing.Optional[typing.List[str]]