Amazonka.Glue.Types.BlueprintRun

Documentation

data BlueprintRun

The details of a blueprint run.

See: newBlueprintRun smart constructor.

Constructors

BlueprintRun'

Fields

• blueprintName :: Maybe Text

  The name of the blueprint.

• completedOn :: Maybe POSIX

  The date and time that the blueprint run completed.

• errorMessage :: Maybe Text

  Indicates any errors that are seen while running the blueprint.

• parameters :: Maybe Text

  The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.

• roleArn :: Maybe Text

  The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.

• rollbackErrorMessage :: Maybe Text

  If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.

• runId :: Maybe Text

  The run ID for this blueprint run.

• startedOn :: Maybe POSIX

  The date and time that the blueprint run started.

• state :: Maybe BlueprintRunState

  The state of the blueprint run. Possible values are:

  • Running — The blueprint run is in progress.
  • Succeeded — The blueprint run completed successfully.
  • Failed — The blueprint run failed and rollback is complete.
  • Rolling Back — The blueprint run failed and rollback is in progress.
• workflowName :: Maybe Text

  The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.

Instances

FromJSON BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

parseJSON :: Value -> Parser BlueprintRun

parseJSONList :: Value -> Parser [BlueprintRun]

Generic BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Associated Types

type Rep BlueprintRun :: Type -> Type

Methods

from :: BlueprintRun -> Rep BlueprintRun x

to :: Rep BlueprintRun x -> BlueprintRun

Read BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

readsPrec :: Int -> ReadS BlueprintRun

readList :: ReadS [BlueprintRun]

readPrec :: ReadPrec BlueprintRun

readListPrec :: ReadPrec [BlueprintRun]

Show BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

showsPrec :: Int -> BlueprintRun -> ShowS

show :: BlueprintRun -> String

showList :: [BlueprintRun] -> ShowS

NFData BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

rnf :: BlueprintRun -> ()

Eq BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

(==) :: BlueprintRun -> BlueprintRun -> Bool

(/=) :: BlueprintRun -> BlueprintRun -> Bool

Hashable BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

hashWithSalt :: Int -> BlueprintRun -> Int

hash :: BlueprintRun -> Int

type Rep BlueprintRun

Defined in Amazonka.Glue.Types.BlueprintRun

type Rep BlueprintRun = D1 ('MetaData "BlueprintRun" "Amazonka.Glue.Types.BlueprintRun" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "BlueprintRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blueprintName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "completedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "rollbackErrorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "runId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "startedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlueprintRunState)) :*: S1 ('MetaSel ('Just "workflowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newBlueprintRun :: BlueprintRun

Create a value of BlueprintRun with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blueprintName:BlueprintRun', blueprintRun_blueprintName - The name of the blueprint.

$sel:completedOn:BlueprintRun', blueprintRun_completedOn - The date and time that the blueprint run completed.

$sel:errorMessage:BlueprintRun', blueprintRun_errorMessage - Indicates any errors that are seen while running the blueprint.

$sel:parameters:BlueprintRun', blueprintRun_parameters - The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.

$sel:roleArn:BlueprintRun', blueprintRun_roleArn - The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.

$sel:rollbackErrorMessage:BlueprintRun', blueprintRun_rollbackErrorMessage - If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.

$sel:runId:BlueprintRun', blueprintRun_runId - The run ID for this blueprint run.

$sel:startedOn:BlueprintRun', blueprintRun_startedOn - The date and time that the blueprint run started.

$sel:state:BlueprintRun', blueprintRun_state - The state of the blueprint run. Possible values are:

• Running — The blueprint run is in progress.
• Succeeded — The blueprint run completed successfully.
• Failed — The blueprint run failed and rollback is complete.
• Rolling Back — The blueprint run failed and rollback is in progress.

$sel:workflowName:BlueprintRun', blueprintRun_workflowName - The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.

blueprintRun_blueprintName :: Lens' BlueprintRun (Maybe Text)

The name of the blueprint.

blueprintRun_completedOn :: Lens' BlueprintRun (Maybe UTCTime)

The date and time that the blueprint run completed.

blueprintRun_errorMessage :: Lens' BlueprintRun (Maybe Text)

Indicates any errors that are seen while running the blueprint.

blueprintRun_parameters :: Lens' BlueprintRun (Maybe Text)

The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.

blueprintRun_roleArn :: Lens' BlueprintRun (Maybe Text)

The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.

blueprintRun_rollbackErrorMessage :: Lens' BlueprintRun (Maybe Text)

If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.

blueprintRun_runId :: Lens' BlueprintRun (Maybe Text)

The run ID for this blueprint run.

blueprintRun_startedOn :: Lens' BlueprintRun (Maybe UTCTime)

The date and time that the blueprint run started.

blueprintRun_state :: Lens' BlueprintRun (Maybe BlueprintRunState)

The state of the blueprint run. Possible values are:

• Running — The blueprint run is in progress.
• Succeeded — The blueprint run completed successfully.
• Failed — The blueprint run failed and rollback is complete.
• Rolling Back — The blueprint run failed and rollback is in progress.

blueprintRun_workflowName :: Lens' BlueprintRun (Maybe Text)

The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.