CreateBlueprintCommand

Registers a blueprint with Glue.

Example Syntax

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

import { GlueClient, CreateBlueprintCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, CreateBlueprintCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // CreateBlueprintRequest
  Name: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  BlueprintLocation: "STRING_VALUE", // required
  Tags: { // TagsMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateBlueprintCommand(input);
const response = await client.send(command);
// { // CreateBlueprintResponse
//   Name: "STRING_VALUE",
// };

CreateBlueprintCommand Input

See CreateBlueprintCommandInput for more details

Parameter
Type
Description
BlueprintLocation
Required
string | undefined

Specifies a path in Amazon S3 where the blueprint is published.

Name
Required
string | undefined

The name of the blueprint.

Description
string | undefined

A description of the blueprint.

Tags
Record<string, string> | undefined

The tags to be applied to this blueprint.

CreateBlueprintCommand Output

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

Returns the name of the blueprint that was registered.

Throws

Name
Fault
Details
AlreadyExistsException
client

A resource to be created or added already exists.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

ResourceNumberLimitExceededException
client

A resource numerical limit was exceeded.

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