Glue / Client / get_blueprint_runs

get_blueprint_runs#

Glue.Client.get_blueprint_runs(**kwargs)#

Retrieves the details of blueprint runs for a specified blueprint.

See also: AWS API Documentation

Request Syntax

response = client.get_blueprint_runs(
    BlueprintName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • BlueprintName (string) –

    [REQUIRED]

    The name of the blueprint.

  • NextToken (string) – A continuation token, if this is a continuation request.

  • MaxResults (integer) – The maximum size of a list to return.

Return type:

dict

Returns:

Response Syntax

{
    'BlueprintRuns': [
        {
            'BlueprintName': 'string',
            'RunId': 'string',
            'WorkflowName': 'string',
            'State': 'RUNNING'|'SUCCEEDED'|'FAILED'|'ROLLING_BACK',
            'StartedOn': datetime(2015, 1, 1),
            'CompletedOn': datetime(2015, 1, 1),
            'ErrorMessage': 'string',
            'RollbackErrorMessage': 'string',
            'Parameters': 'string',
            'RoleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • BlueprintRuns (list) –

      Returns a list of BlueprintRun objects.

      • (dict) –

        The details of a blueprint run.

        • BlueprintName (string) –

          The name of the blueprint.

        • RunId (string) –

          The run ID for this blueprint run.

        • WorkflowName (string) –

          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.

        • State (string) –

          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.

        • StartedOn (datetime) –

          The date and time that the blueprint run started.

        • CompletedOn (datetime) –

          The date and time that the blueprint run completed.

        • ErrorMessage (string) –

          Indicates any errors that are seen while running the blueprint.

        • RollbackErrorMessage (string) –

          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.

        • Parameters (string) –

          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 (string) –

          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.

    • NextToken (string) –

      A continuation token, if not all blueprint runs have been returned.

Exceptions