Aws/databrew

@swamp/aws/databrewv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS

01README

AWS DATABREW infrastructure models

02Behaviors6

@swamp/aws/databrew/datasetv2026.10.23.1dataset.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name	string	yes	Dataset name
Format?	enum	no	Dataset format
FormatOptions?	object	no	Format options for dataset
Input	object	yes	Input
Source?	enum	no	Source type of the dataset
PathOptions?	object	no	PathOptions
Tags?	array	no

fn create()

Create a DataBrew Dataset

fn get(identifier: string)

Get a DataBrew Dataset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Dataset

fn update()

Update a DataBrew Dataset

fn delete(identifier: string)

Delete a DataBrew Dataset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Dataset

fn sync()

Sync DataBrew Dataset state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataBrew Dataset resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataBrew Dataset resource state

@swamp/aws/databrew/jobv2026.10.23.1job.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DatasetName?	string	no	Dataset name
EncryptionKeyArn?	string	no	Encryption Key Arn
EncryptionMode?	enum	no	Encryption mode
Name	string	yes	Job name
Type	enum	yes	Job type
LogSubscription?	enum	no	Log subscription
MaxCapacity?	number	no	Max capacity
MaxRetries?	number	no	Max retries
Outputs?	array	no
DataCatalogOutputs?	array	no
DatabaseOutputs?	array	no
OutputLocation?	object	no	Output location
ProjectName?	string	no	Project name
Recipe?	object	no
RoleArn	string	yes	Role arn
Tags?	array	no
Timeout?	number	no	Timeout
JobSample?	object	no	Job Sample
ProfileConfiguration?	object	no	Profile Job configuration
ValidationConfigurations?	array	no	Data quality rules configuration

fn create()

Create a DataBrew Job

fn get(identifier: string)

Get a DataBrew Job

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Job

fn update()

Update a DataBrew Job

fn delete(identifier: string)

Delete a DataBrew Job

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Job

fn sync()

Sync DataBrew Job state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataBrew Job resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataBrew Job resource state

@swamp/aws/databrew/projectv2026.10.23.1project.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DatasetName	string	yes	Dataset name
Name	string	yes	Project name
RecipeName	string	yes	Recipe name
RoleArn	string	yes	Role arn
Sample?	object	no	Sample
Tags?	array	no

fn create()

Create a DataBrew Project

fn get(identifier: string)

Get a DataBrew Project

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Project

fn update()

Update a DataBrew Project

fn delete(identifier: string)

Delete a DataBrew Project

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Project

fn sync()

Sync DataBrew Project state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataBrew Project resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataBrew Project resource state

@swamp/aws/databrew/recipev2026.10.23.1recipe.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Description?	string	no	Description of the recipe
Name	string	yes	Recipe name
Steps	array	yes
Tags?	array	no

fn create()

Create a DataBrew Recipe

fn get(identifier: string)

Get a DataBrew Recipe

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Recipe

fn update()

Update a DataBrew Recipe

fn delete(identifier: string)

Delete a DataBrew Recipe

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Recipe

fn sync()

Sync DataBrew Recipe state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataBrew Recipe resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataBrew Recipe resource state

@swamp/aws/databrew/rulesetv2026.10.23.1ruleset.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name	string	yes	Name of the Ruleset
Description?	string	no	Description of the Ruleset
TargetArn	string	yes	Arn of the target resource (dataset) to apply the ruleset to
Rules	array	yes	List of the data quality rules in the ruleset
Tags?	array	no

fn create()

Create a DataBrew Ruleset

fn get(identifier: string)

Get a DataBrew Ruleset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Ruleset

fn update()

Update a DataBrew Ruleset

fn delete(identifier: string)

Delete a DataBrew Ruleset

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Ruleset

fn sync()

Sync DataBrew Ruleset state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataBrew Ruleset resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataBrew Ruleset resource state

@swamp/aws/databrew/schedulev2026.10.23.1schedule.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
JobNames?	array	no
CronExpression	string	yes	Schedule cron
Name	string	yes	Schedule Name
Tags?	array	no

fn create()

Create a DataBrew Schedule

fn get(identifier: string)

Get a DataBrew Schedule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Schedule

fn update()

Update a DataBrew Schedule

fn delete(identifier: string)

Delete a DataBrew Schedule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataBrew Schedule

fn sync()

Sync DataBrew Schedule state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataBrew Schedule resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataBrew Schedule resource state

03Previous Versions19

2026.10.24.1AGPL-3.0-or-laterOct 24, 2026

2026.10.23.1AGPL-3.0-or-later(was none)Oct 24, 2026

Updated: dataset, job, project, recipe, ruleset, schedule

2026.10.13.1Oct 13, 2026

Updated: dataset, job, project, recipe, ruleset, schedule

2026.10.08.1Oct 8, 2026

2026.10.06.1Oct 6, 2026

2026.10.04.1Oct 4, 2026

2026.10.03.1Oct 3, 2026

2026.10.02.1Oct 2, 2026

2026.10.01.1Oct 1, 2026

2026.09.30.1Sep 30, 2026

2026.09.29.1Sep 29, 2026

2026.09.28.1Sep 28, 2026

2026.09.27.1Sep 27, 2026

2026.09.26.1Sep 26, 2026

2026.09.25.1Sep 25, 2026

2026.09.24.1Sep 24, 2026

2026.09.23.1Sep 23, 2026

2026.09.21.1Sep 21, 2026

2026.09.20.1Sep 20, 2026

04Stats

100 / 100

Downloads

Archive size

1.2 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

06Labels

#aws #databrew #cloud #infrastructure