Skip to content

Datapipeline Classes

ActivatePipelineInput

pipelineId

  • Type:
  • Required: Yes

parameterValues

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

startTimestamp

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

AddTagsInput

pipelineId

  • Type:
  • Required: Yes

tags

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

BaseValidatorModel

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

CreatePipelineInput

name

  • Type:
  • Required: Yes

uniqueId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

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

CreatePipelineOutput

pipelineId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeactivatePipelineInput

pipelineId

  • Type:
  • Required: Yes

cancelActive

  • Type: typing.Optional[bool]

DeletePipelineInput

pipelineId

  • Type:
  • Required: Yes

DescribeObjectsInput

pipelineId

  • Type:
  • Required: Yes

objectIds

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

evaluateExpressions

  • Type: typing.Optional[bool]

marker

  • Type: typing.Optional[str]

DescribeObjectsInputPaginate

pipelineId

  • Type:
  • Required: Yes

objectIds

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

evaluateExpressions

  • Type: typing.Optional[bool]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PaginatorConfig]

DescribeObjectsOutput

pipelineObjects

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

marker

  • Type:
  • Required: Yes

hasMoreResults

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribePipelinesInput

pipelineIds

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

DescribePipelinesOutput

pipelineDescriptionList

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

ResponseMetadata

  • Type:
  • Required: Yes

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

EvaluateExpressionInput

pipelineId

  • Type:
  • Required: Yes

objectId

  • Type:
  • Required: Yes

expression

  • Type:
  • Required: Yes

EvaluateExpressionOutput

evaluatedExpression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Field

key

  • Type:
  • Required: Yes

stringValue

  • Type: typing.Optional[str]

refValue

  • Type: typing.Optional[str]

GetPipelineDefinitionInput

pipelineId

  • Type:
  • Required: Yes

version

  • Type: typing.Optional[str]

GetPipelineDefinitionOutput

pipelineObjects

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

parameterObjects

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

parameterValues

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

ResponseMetadata

  • Type:
  • Required: Yes

InstanceIdentity

document

  • Type: typing.Optional[str]

signature

  • Type: typing.Optional[str]

ListPipelinesInput

marker

  • Type: typing.Optional[str]

ListPipelinesInputPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PaginatorConfig]

ListPipelinesOutput

pipelineIdList

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

marker

  • Type:
  • Required: Yes

hasMoreResults

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Operator

type

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

values

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

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ParameterAttribute

key

  • Type:
  • Required: Yes

stringValue

  • Type:
  • Required: Yes

ParameterObject

id

  • Type:
  • Required: Yes

attributes

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

ParameterObjectOutput

id

  • Type:
  • Required: Yes

attributes

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

ParameterValue

id

  • Type:
  • Required: Yes

stringValue

  • Type:
  • Required: Yes

PipelineDescription

pipelineId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

fields

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

description

  • Type: typing.Optional[str]

tags

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

PipelineIdName

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

PipelineObject

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

fields

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

PipelineObjectOutput

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

fields

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

PollForTaskInput

workerGroup

  • Type:
  • Required: Yes

hostname

  • Type: typing.Optional[str]

instanceIdentity

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.InstanceIdentity]

PollForTaskOutput

taskObject

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutPipelineDefinitionInput

pipelineId

  • Type:
  • Required: Yes

pipelineObjects

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PipelineObject, aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PipelineObjectOutput]]
  • Required: Yes

parameterObjects

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.ParameterObject, aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.ParameterObjectOutput]]]

parameterValues

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

PutPipelineDefinitionOutput

validationErrors

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

validationWarnings

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

errored

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Query

selectors

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

QueryObjectsInput

pipelineId

  • Type:
  • Required: Yes

sphere

  • Type:
  • Required: Yes

query

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.Query]

marker

  • Type: typing.Optional[str]

limit

  • Type: typing.Optional[int]

QueryObjectsInputPaginate

pipelineId

  • Type:
  • Required: Yes

sphere

  • Type:
  • Required: Yes

query

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.Query]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PaginatorConfig]

QueryObjectsOutput

ids

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

marker

  • Type:
  • Required: Yes

hasMoreResults

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RemoveTagsInput

pipelineId

  • Type:
  • Required: Yes

tagKeys

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

ReportTaskProgressInput

taskId

  • Type:
  • Required: Yes

fields

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

ReportTaskProgressOutput

canceled

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ReportTaskRunnerHeartbeatInput

taskrunnerId

  • Type:
  • Required: Yes

workerGroup

  • Type: typing.Optional[str]

hostname

  • Type: typing.Optional[str]

ReportTaskRunnerHeartbeatOutput

terminate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

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

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

Selector

fieldName

  • Type: typing.Optional[str]

operator

  • Type: typing.Optional[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.Operator]

SetStatusInput

pipelineId

  • Type:
  • Required: Yes

objectIds

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

status

  • Type:
  • Required: Yes

SetTaskStatusInput

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]

Tag

key

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

TaskObject

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.datapipeline_classes.PipelineObjectOutput]]

ValidatePipelineDefinitionInput

pipelineId

  • Type:
  • Required: Yes

pipelineObjects

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PipelineObject, aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.PipelineObjectOutput]]
  • Required: Yes

parameterObjects

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.ParameterObject, aws_resource_validator.pydantic_models.datapipeline.datapipeline_classes.ParameterObjectOutput]]]

parameterValues

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

ValidatePipelineDefinitionOutput

validationErrors

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

validationWarnings

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

errored

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidationError

id

  • Type: typing.Optional[str]

errors

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

ValidationWarning

id

  • Type: typing.Optional[str]

warnings

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