GetBlueprintRunCommand

Suggest an Edit

Retrieves the details of a blueprint run.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GlueClient, GetBlueprintRunCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetBlueprintRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetBlueprintRunRequest
  BlueprintName: "STRING_VALUE", // required
  RunId: "STRING_VALUE", // required
};
const command = new GetBlueprintRunCommand(input);
const response = await client.send(command);
// { // GetBlueprintRunResponse
//   BlueprintRun: { // BlueprintRun
//     BlueprintName: "STRING_VALUE",
//     RunId: "STRING_VALUE",
//     WorkflowName: "STRING_VALUE",
//     State: "RUNNING" || "SUCCEEDED" || "FAILED" || "ROLLING_BACK",
//     StartedOn: new Date("TIMESTAMP"),
//     CompletedOn: new Date("TIMESTAMP"),
//     ErrorMessage: "STRING_VALUE",
//     RollbackErrorMessage: "STRING_VALUE",
//     Parameters: "STRING_VALUE",
//     RoleArn: "STRING_VALUE",
//   },
// };

GetBlueprintRunCommand Input

See GetBlueprintRunCommandInput for more details

Parameter
Type
Description
BlueprintName
Required
string | undefined

The name of the blueprint.

RunId
Required
string | undefined

The run ID for the blueprint run you want to retrieve.

GetBlueprintRunCommand Output

See GetBlueprintRunCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BlueprintRun
BlueprintRun | undefined

Returns a BlueprintRun object.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.