Skip to main content

@swamp/aws/athena

v2026.04.23.3

AWS ATHENA infrastructure models

Repository

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

Labels

awsathenacloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/athena

@swamp/aws/athena/capacity-reservationv2026.04.23.2capacity_reservation.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe reservation name.
TargetDpusnumberThe number of DPUs to request to be allocated to the reservation.
CapacityAssignmentConfiguration?objectAssignment configuration to assign workgroups to a reservation
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a Athena CapacityReservation
getGet a Athena CapacityReservation
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena CapacityReservation
updateUpdate a Athena CapacityReservation
deleteDelete a Athena CapacityReservation
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena CapacityReservation
syncSync Athena CapacityReservation state from AWS

Resources

state(infinite)— Athena CapacityReservation resource state
@swamp/aws/athena/data-catalogv2026.04.23.2data_catalog.ts

Global Arguments

ArgumentTypeDescription
NamestringThe 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?stringA description of the data catalog to be created.
Parameters?recordSpecifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type.
Tags?arrayA list of comma separated tags to add to the data catalog that is created.
TypeenumThe 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?enumThe 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?stringThe type of connection for a FEDERATED data catalog
Error?stringText of the error that occurred during data catalog creation or deletion.
createCreate a Athena DataCatalog
getGet a Athena DataCatalog
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena DataCatalog
updateUpdate a Athena DataCatalog
deleteDelete a Athena DataCatalog
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena DataCatalog
syncSync Athena DataCatalog state from AWS

Resources

state(infinite)— Athena DataCatalog resource state
@swamp/aws/athena/named-queryv2026.04.23.2named_query.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Name?stringThe query name.
DatabasestringThe database to which the query belongs.
Description?stringThe query description.
QueryStringstringThe contents of the query with all query statements.
WorkGroup?stringThe name of the workgroup that contains the named query.
createCreate a Athena NamedQuery
getGet a Athena NamedQuery
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena NamedQuery
deleteDelete a Athena NamedQuery
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena NamedQuery
syncSync Athena NamedQuery state from AWS

Resources

state(infinite)— Athena NamedQuery resource state
@swamp/aws/athena/prepared-statementv2026.04.23.2prepared_statement.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
StatementNamestringThe name of the prepared statement.
WorkGroupstringThe name of the workgroup to which the prepared statement belongs.
Description?stringThe description of the prepared statement.
QueryStatementstringThe query string for the prepared statement.
createCreate a Athena PreparedStatement
getGet a Athena PreparedStatement
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena PreparedStatement
updateUpdate a Athena PreparedStatement
deleteDelete a Athena PreparedStatement
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena PreparedStatement
syncSync Athena PreparedStatement state from AWS

Resources

state(infinite)— Athena PreparedStatement resource state
@swamp/aws/athena/work-groupv2026.04.23.2work_group.ts

Global Arguments

ArgumentTypeDescription
NamestringThe workGroup name.
Description?stringThe workgroup description.
Tags?arrayOne or more tags, separated by commas, that you want to attach to the workgroup as you create it
WorkGroupConfiguration?objectThe workgroup configuration
WorkGroupConfigurationUpdates?objectThe workgroup configuration update object
State?enumThe state of the workgroup: ENABLED or DISABLED.
RecursiveDeleteOption?booleanThe option to delete the workgroup and its contents even if the workgroup contains any named queries.
createCreate a Athena WorkGroup
getGet a Athena WorkGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena WorkGroup
updateUpdate a Athena WorkGroup
deleteDelete a Athena WorkGroup
ArgumentTypeDescription
identifierstringThe primary identifier of the Athena WorkGroup
syncSync Athena WorkGroup state from AWS

Resources

state(infinite)— Athena WorkGroup resource state