Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/awslabs/aws-sdk-kotlin
Multiplatform AWS SDK for Kotlin
https://github.com/awslabs/aws-sdk-kotlin
aws kotlin
Last synced: 1 day ago
JSON representation
Multiplatform AWS SDK for Kotlin
- Host: GitHub
- URL: https://github.com/awslabs/aws-sdk-kotlin
- Owner: awslabs
- License: apache-2.0
- Created: 2018-02-13T03:17:58.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T15:33:58.000Z (1 day ago)
- Last Synced: 2025-01-10T16:36:01.395Z (1 day ago)
- Topics: aws, kotlin
- Language: Kotlin
- Homepage:
- Size: 202 MB
- Stars: 427
- Watchers: 17
- Forks: 49
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-github-repos - awslabs/aws-sdk-kotlin - Multiplatform AWS SDK for Kotlin (Kotlin)
README
# AWS SDK for Kotlin
[![Apache 2 licensed][apache-badge]][apache-url] [![Maven][maven-badge]][maven-url]
[apache-badge]: https://img.shields.io/badge/license-APACHE2-blue.svg
[apache-url]: https://github.com/awslabs/aws-sdk-kotlin/blob/main/LICENSE
[maven-badge]: https://img.shields.io/maven-central/v/aws.sdk.kotlin/s3.svg?label=Maven
[maven-url]: https://search.maven.org/search?q=g:aws.sdk.kotlin
This repo contains the AWS SDK for Kotlin and its [public roadmap](https://github.com/awslabs/aws-sdk-kotlin/projects/2).
## Getting Started
* [SDK Homepage](https://aws.amazon.com/sdk-for-kotlin/)
* [Developer Guide](https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/home.html)
* [API Reference](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
* [Samples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin)
See the [Getting Started Guide](docs/GettingStarted.md) to learn how to use the AWS SDK for Kotlin in your program.
## Feedback
The SDK uses **GitHub Issues** to track feature requests and issues with the SDK. In addition, we use **GitHub Projects**
to provide a high level overview of our roadmap and the features we are actively working on.
You can provide feedback or report a bug by submitting an [issue](https://github.com/awslabs/aws-sdk-kotlin/issues/new/choose).
This is the preferred mechanism to give feedback so that other users can engage in the conversation, +1 issues, etc.
## Contributing
If you are interested in contributing to the AWS SDK for Kotlin, please take a look at [CONTRIBUTING](CONTRIBUTING.md)
## Versioning
See our [VERSIONING](VERSIONING.md) policy for how the SDK is versioned.
## Development
### Generate SDK(s)
Generated sources are not checked into the repository, you first have to generate the clients before you can build them.
A [step-by-step guide](docs/generate-sdk.md) is available that demonstrates building the AWS DynamoDB service, or if
you have a good working knowledge of Gradle, see below:
```sh
./gradlew --no-daemon :codegen:sdk:bootstrap
```
NOTE: This task will respect the AWS services specified by project properties. See options below.
NOTE: To re-run codegen for the same set of services multiple times add the `--rerun-tasks` flag.
After generating the services you care about they are available to build:
e.g.
```sh
./gradlew :services:lambda:build
```
Where the task follows the pattern: `:services:SERVICE:build`
To see list of all projects run `./gradlew projects`
##### Generating a single service
See the [Build Properties](#build-properties) below to specify this in a config file.
```sh
./gradlew --no-daemon -Paws.services=+lambda :codegen:sdk:bootstrap
```
##### Testing Locally
Testing generated services generally requires publishing artifacts (e.g. client-runtime) of `smithy-kotlin`, `aws-crt-kotlin`, and `aws-sdk-kotin` to maven local.
#### Generating API Documentation
API documentation is generated using [Dokka](http://kotlin.github.io/dokka) which is the official documentation tool maintained by JetBrains for documenting Kotlin code.
Unlike Java, Kotlin uses its own [KDoc](https://kotlinlang.org/docs/kotlin-doc.html) format.
To generate API reference documentation for the AWS Kotlin SDK:
```sh
./gradlew --no-daemon --no-parallel dokkaHtmlMultiModule
```
This will output HTML formatted documentation to `build/dokka/htmlMultiModule`
NOTE: You currently need an HTTP server to view the documentation in browser locally. You can either use the builtin server in Intellij or use your favorite local server (e.g. `python3 -m http.server`). See [Kotlin/dokka#1795](https://github.com/Kotlin/dokka/issues/1795)
### Build Properties
You can define a `local.properties` config file at the root of the project to modify build behavior.
|Property|Description|
|---|---|
|`compositeProjects`|Specify paths to repos the SDK depends upon such as `smithy-kotlin`|
|`aws.services`|Specify inclusions (+ prefix) and exclusions (- prefix) of service names to generate|
|`aws.protocols`|Specify inclusions (+ prefix) and exclusions (- prefix) of AWS protocols to generate|
#### Composite Projects
Dependencies of the SDK can be added as composite build such that multiple repos may appear as one
holistic source project in the IDE.
```ini
# comma separated list of paths to `includeBuild()`
# This is useful for local development of smithy-kotlin in particular
compositeProjects=../smithy-kotlin
```
#### Generating Specific Services Based on Name or Protocol
A comma separated list of services to include or exclude for generation from codegen/sdk/aws-models may
be specified with the `aws.services` property. A list of protocols of services to generate may be specified
with the `aws.protocols` property.
Included services require a '+' character prefix and excluded services require a '-' character.
If any items are specified for inclusion, only specified included members will be generated. If no items
are specified for inclusion, all members not excluded will be generated.
When unspecified all services found in the directory specified by the `modelsDir` property are generated.
Service names match the filenames in the models directory `service.VERSION.json`.
Some example entries for `local.properties`:
```ini
# Generate only AWS Lambda:
aws.services=+lambda
```
```ini
# Generate all services but AWS location and AWS DynamoDB:
aws.services=-location,-dynamodb
```
```ini
# Generate all services except those using the restJson1 protocol:
aws.protocols=-restJson1
```
### Debugging
See [Debugging](docs/debugging.md)
## Security
Please refer to our [security policy](https://github.com/awslabs/aws-sdk-kotlin/security/policy).
## Supported targets
The SDK supports the following targets:
* [JVM](docs/targets.md#jvm)
* [Android](docs/targets.md#android)
* [GraalVM](docs/targets.md#graalvm)