libZSservicesZSamazonka-glueZSamazonka-glue
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Glue.Types.BlueprintRun

Description

 
Synopsis

Documentation

data BlueprintRun Source #

The details of a blueprint run.

See: newBlueprintRun smart constructor.

Constructors

BlueprintRun' 

Fields

  • 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.

  • completedOn :: Maybe POSIX

    The date and time that the blueprint run completed.

  • 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.
  • 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.

  • startedOn :: Maybe POSIX

    The date and time that the blueprint run started.

  • runId :: Maybe Text

    The run ID for this blueprint run.

  • 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.

  • blueprintName :: Maybe Text

    The name of the blueprint.

  • errorMessage :: Maybe Text

    Indicates any errors that are seen while running the blueprint.

  • 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.

Instances

Instances details
Eq BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

Read BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

Show BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

Generic BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

Associated Types

type Rep BlueprintRun :: Type -> Type #

NFData BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

Methods

rnf :: BlueprintRun -> () #

Hashable BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

FromJSON BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

type Rep BlueprintRun Source # 
Instance details

Defined in Amazonka.Glue.Types.BlueprintRun

newBlueprintRun :: BlueprintRun Source #

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: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.

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

$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: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:startedOn:BlueprintRun', blueprintRun_startedOn - The date and time that the blueprint run started.

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

$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:blueprintName:BlueprintRun', blueprintRun_blueprintName - The name of the blueprint.

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

$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.

blueprintRun_workflowName :: Lens' BlueprintRun (Maybe Text) Source #

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_completedOn :: Lens' BlueprintRun (Maybe UTCTime) Source #

The date and time that the blueprint run completed.

blueprintRun_state :: Lens' BlueprintRun (Maybe BlueprintRunState) Source #

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_rollbackErrorMessage :: Lens' BlueprintRun (Maybe Text) Source #

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_startedOn :: Lens' BlueprintRun (Maybe UTCTime) Source #

The date and time that the blueprint run started.

blueprintRun_runId :: Lens' BlueprintRun (Maybe Text) Source #

The run ID for this blueprint run.

blueprintRun_parameters :: Lens' BlueprintRun (Maybe Text) Source #

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_errorMessage :: Lens' BlueprintRun (Maybe Text) Source #

Indicates any errors that are seen while running the blueprint.

blueprintRun_roleArn :: Lens' BlueprintRun (Maybe Text) Source #

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.