SageMaker Pipeline Definition JSON Schema

Type: object
No Additional Properties

root Version
Type: enum (of string)

Must be one of:

  • "2020-12-01"

root Metadata
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z0-9\-_]{1,128}$
root Metadata ^[A-Za-z0-9\-_]{1,128}$
Type: string

Must be at least 0 characters long

Must be at most 1024 characters long

root Parameters
Type: array
No Additional Items

Each item of this array must be:

root Parameters Parameters items

root Parameters Parameters items oneOf StringParameter
Type: object
No Additional Properties

root Parameters Parameters items oneOf item 0 Name
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Parameters Parameters items oneOf item 0 Description
Type: string

Must be at least 0 characters long

Must be at most 4096 characters long

root Parameters Parameters items oneOf item 0 DefaultValue
Type: string

Must be at most 4096 characters long

root Parameters Parameters items oneOf item 0 Type
Type: enum (of string)

Must be one of:

  • "String"
root Parameters Parameters items oneOf IntegerParameter
Type: object
No Additional Properties

root Parameters Parameters items oneOf item 1 Name
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Parameters Parameters items oneOf item 1 Description
Type: string

Must be at least 0 characters long

Must be at most 4096 characters long

root Parameters Parameters items oneOf item 1 Type
Type: enum (of string)

Must be one of:

  • "Integer"
root Parameters Parameters items oneOf FloatParameter
Type: object
No Additional Properties

root Parameters Parameters items oneOf item 2 Name
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Parameters Parameters items oneOf item 2 Description
Type: string

Must be at least 0 characters long

Must be at most 4096 characters long

root Parameters Parameters items oneOf item 2 Type
Type: enum (of string)

Must be one of:

  • "Float"
root Parameters Parameters items oneOf BooleanParameter
Type: object
No Additional Properties

root Parameters Parameters items oneOf item 3 Name
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Parameters Parameters items oneOf item 3 Description
Type: string

Must be at least 0 characters long

Must be at most 4096 characters long

root Parameters Parameters items oneOf item 3 Type
Type: enum (of string)

Must be one of:

  • "Boolean"

root Steps
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items

root Steps Steps items oneOf ConditionStep
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Name
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Steps Steps items oneOf item 0 Type
Type: enum (of string)

Must be one of:

  • "Condition"

root Steps Steps items oneOf item 0 DependsOn
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 DependsOn StepName
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Steps Steps items oneOf item 0 DisplayName
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Steps Steps items oneOf item 0 Description
Type: string

Must be at least 0 characters long

Must be at most 4096 characters long

root Steps Steps items oneOf item 0 Arguments
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments Conditions
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf BinaryCondition
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 LeftValue

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 LeftValue anyOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 LeftValue anyOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 LeftValue anyOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 LeftValue anyOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 RightValue

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 RightValue anyOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 RightValue anyOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 RightValue anyOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 RightValue anyOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 0 Type
Type: enum (of string)

Must be one of:

  • "GreaterThan"
  • "LessThan"
  • "LessThanOrEqualTo"
  • "GreaterThanOrEqualTo"
  • "Equals"
  • "NotEquals"
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf InCondition
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 Type
Type: enum (of string)

Must be one of:

  • "In"
  • "NotIn"

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 Value

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 Value oneOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 Value oneOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 Value oneOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 Value oneOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 In
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 In In items

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 In In items oneOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 In In items oneOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 In In items oneOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 1 In In items oneOf FloatArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf OrCondition
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Type
Type: enum (of string)

Must be one of:

  • "Or"

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf BinaryCondition
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 LeftValue

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 LeftValue anyOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 LeftValue anyOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 LeftValue anyOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 LeftValue anyOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 RightValue

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 RightValue anyOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 RightValue anyOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 RightValue anyOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 RightValue anyOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 0 Type
Type: enum (of string)

Must be one of:

  • "GreaterThan"
  • "LessThan"
  • "LessThanOrEqualTo"
  • "GreaterThanOrEqualTo"
  • "Equals"
  • "NotEquals"
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf InCondition
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 Value

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 Value oneOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 Value oneOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 Value oneOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 Value oneOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 In
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 In In items

root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 In In items oneOf StringArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 In In items oneOf BooleanArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 In In items oneOf IntegerArgumentValue
Type: object
root Steps Steps items oneOf item 0 Arguments Conditions Conditions items oneOf item 2 Conditions Conditions items anyOf item 1 In In items oneOf FloatArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments IfSteps
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf TrainingStep
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Name
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Type
Type: enum (of string)

Must be one of:

  • "Training"

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 DependsOn
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 DependsOn StepName
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 DisplayName
Type: string
Must match regular expression: ^[A-Za-z0-9\-_]{1,64}$

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Description
Type: string

Must be at least 0 characters long

Must be at most 4096 characters long

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 RetryPolicies
Type: array
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 RetryPolicies RetryPolicy
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 RetryPolicies RetryPolicies items ExceptionType
Type: enum (of string)

Must be one of:

  • "Step.SERVICE_FAULT"
  • "Step.THROTTLING"
  • "SageMaker.JOB_INTERNAL_ERROR"
  • "SageMaker.CAPACITY_ERROR"
  • "SageMaker.RESOURCE_LIMIT"
  • "Emr.RESOURCE_LIMIT"

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments AlgorithmSpecification
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments AlgorithmSpecification MetricDefinitions
Type: array of object
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments AlgorithmSpecification MetricDefinitions MetricDefinitions items
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments DebugHookConfig
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments DebugHookConfig CollectionConfigurations
Type: array of object
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments DebugHookConfig CollectionConfigurations CollectionConfigurations items
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments DebugRuleConfigurations
Type: array of object
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments DebugRuleConfigurations DebugRuleConfigurations items
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments HyperParameters
Type: object

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments HyperParameters StringArgumentValue
Type: object

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments InputDataConfig
Type: array of object
No Additional Items

Each item of this array must be:

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments InputDataConfig InputDataConfig items
Type: object

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments InputDataConfig InputDataConfig items DataSource
Type: object

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments InputDataConfig InputDataConfig items DataSource FileSystemDataSource
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments InputDataConfig InputDataConfig items DataSource S3DataSource
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments ResourceConfig
Type: object
No Additional Properties

root Steps Steps items oneOf item 0 Arguments IfSteps IfSteps items oneOf item 0 Arguments StoppingCondition
Type: object
No Additional Properties