Aws/athena
@swamp/aws/athenav2026.10.25.1
01README
AWS ATHENA infrastructure models
02Behaviors
@swamp/aws/athena/capacity-reservationv2026.10.23.1capacity_reservation.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The reservation name. |
| TargetDpus | number | The number of DPUs to request to be allocated to the reservation. |
| CapacityAssignmentConfiguration? | object | Assignment configuration to assign workgroups to a reservation |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a Athena CapacityReservation
fn get(identifier: string)
Get a Athena CapacityReservation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena CapacityReservation |
fn update()
Update a Athena CapacityReservation
fn delete(identifier: string)
Delete a Athena CapacityReservation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena CapacityReservation |
fn sync()
Sync Athena CapacityReservation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Athena CapacityReservation resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Athena CapacityReservation resource state
@swamp/aws/athena/data-catalogv2026.10.23.1data_catalog.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. |
| Description? | string | A description of the data catalog to be created. |
| Parameters? | record | Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. |
| Tags? | array | A list of comma separated tags to add to the data catalog that is created. |
| Type | enum | The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass. |
| Status? | enum | The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously. |
| ConnectionType? | string | The type of connection for a FEDERATED data catalog |
| Error? | string | Text of the error that occurred during data catalog creation or deletion. |
fn create()
Create a Athena DataCatalog
fn get(identifier: string)
Get a Athena DataCatalog
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena DataCatalog |
fn update()
Update a Athena DataCatalog
fn delete(identifier: string)
Delete a Athena DataCatalog
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena DataCatalog |
fn sync()
Sync Athena DataCatalog state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Athena DataCatalog resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Athena DataCatalog resource state
@swamp/aws/athena/named-queryv2026.10.23.1named_query.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name? | string | The query name. |
| Database | string | The database to which the query belongs. |
| Description? | string | The query description. |
| QueryString | string | The contents of the query with all query statements. |
| WorkGroup? | string | The name of the workgroup that contains the named query. |
fn create()
Create a Athena NamedQuery
fn get(identifier: string)
Get a Athena NamedQuery
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena NamedQuery |
fn delete(identifier: string)
Delete a Athena NamedQuery
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena NamedQuery |
fn sync()
Sync Athena NamedQuery state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Athena NamedQuery resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Athena NamedQuery resource state
@swamp/aws/athena/prepared-statementv2026.10.23.1prepared_statement.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| StatementName | string | The name of the prepared statement. |
| WorkGroup | string | The name of the workgroup to which the prepared statement belongs. |
| Description? | string | The description of the prepared statement. |
| QueryStatement | string | The query string for the prepared statement. |
fn create()
Create a Athena PreparedStatement
fn get(identifier: string)
Get a Athena PreparedStatement
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena PreparedStatement |
fn update()
Update a Athena PreparedStatement
fn delete(identifier: string)
Delete a Athena PreparedStatement
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena PreparedStatement |
fn sync()
Sync Athena PreparedStatement state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Athena PreparedStatement resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Athena PreparedStatement resource state
@swamp/aws/athena/work-groupv2026.10.23.1work_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The workGroup name. |
| Description? | string | The workgroup description. |
| Tags? | array | One or more tags, separated by commas, that you want to attach to the workgroup as you create it |
| WorkGroupConfiguration? | object | The workgroup configuration |
| WorkGroupConfigurationUpdates? | object | The workgroup configuration update object |
| State? | enum | The state of the workgroup: ENABLED or DISABLED. |
| RecursiveDeleteOption? | boolean | The option to delete the workgroup and its contents even if the workgroup contains any named queries. |
fn create()
Create a Athena WorkGroup
fn get(identifier: string)
Get a Athena WorkGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena WorkGroup |
fn update()
Update a Athena WorkGroup
fn delete(identifier: string)
Delete a Athena WorkGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Athena WorkGroup |
fn sync()
Sync Athena WorkGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Athena WorkGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Athena WorkGroup resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: capacity_reservation, data_catalog, named_query, prepared_statement, work_group
2026.10.13.1
- Updated: capacity_reservation, data_catalog, named_query, prepared_statement, work_group
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
2026.09.20.1
04Stats
A
100 / 100
Downloads
136
Archive size
1.0 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
05Platforms
06Labels