Skip to content

BlueprintRun

Source code in docs_src/capo_glue/types/blueprint_run.py
class BlueprintRun(TypedDict, closed=True):
    blueprint_name: NotRequired[
        "capo_glue.types.orchestration_name_string.OrchestrationNameString"
    ]
    """<p>The name of the blueprint.</p>"""
    run_id: NotRequired["capo_glue.types.id_string.IdString"]
    """<p>The run ID for this blueprint run.</p>"""
    workflow_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>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.</p>"""
    state: NotRequired["capo_glue.types.blueprint_run_state.BlueprintRunState"]
    """<p>The state of the blueprint run. Possible values are:</p> <ul> <li> <p>Running — The blueprint run is in progress.</p> </li> <li> <p>Succeeded — The blueprint run completed successfully.</p> </li> <li> <p>Failed — The blueprint run failed and rollback is complete.</p> </li> <li> <p>Rolling Back — The blueprint run failed and rollback is in progress.</p> </li> </ul>"""
    started_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time that the blueprint run started.</p>"""
    completed_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time that the blueprint run completed.</p>"""
    error_message: NotRequired["capo_glue.types.message_string.MessageString"]
    """<p>Indicates any errors that are seen while running the blueprint.</p>"""
    rollback_error_message: NotRequired["capo_glue.types.message_string.MessageString"]
    """<p>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.</p>"""
    parameters: NotRequired["capo_glue.types.blueprint_parameters.BlueprintParameters"]
    """<p>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 <code>Blueprint$ParameterSpec</code>.</p>"""
    role_arn: NotRequired[
        "capo_glue.types.orchestration_iam_role_arn.OrchestrationIAMRoleArn"
    ]
    """<p>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.</p>"""

blueprint_name instance-attribute

blueprint_name: NotRequired[OrchestrationNameString]

The name of the blueprint.

completed_on instance-attribute

completed_on: NotRequired[TimestampValue]

The date and time that the blueprint run completed.

error_message instance-attribute

error_message: NotRequired[MessageString]

Indicates any errors that are seen while running the blueprint.

parameters instance-attribute

parameters: NotRequired[BlueprintParameters]

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.

role_arn instance-attribute

role_arn: NotRequired[OrchestrationIAMRoleArn]

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.

rollback_error_message instance-attribute

rollback_error_message: NotRequired[MessageString]

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.

run_id instance-attribute

run_id: NotRequired[IdString]

The run ID for this blueprint run.

started_on instance-attribute

started_on: NotRequired[TimestampValue]

The date and time that the blueprint run started.

state instance-attribute

state: NotRequired[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.

workflow_name instance-attribute

workflow_name: NotRequired[NameString]

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.