diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000000..00d5484470b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +## [Unreleased] + +## [0.1.0-M0] - 03/19/2021 + +**WARNING: Beta releases may contain bugs and no guarantee is made about API stability. They are not recommended for production use!** + +This is the initial beta release of AWS SDK Kotlin. It represents an early look at the overall API surface. + + +See the [Getting Started Guide](docs/GettingStarted.md) for how to work with beta releases and examples. + + +### Services in this release + +* DynamoDB +* Polly +* Translate +* Cognito Identity Provider +* Secrets Manager + * NOTE: Default idempotency token provider will not currently work, you'll need to override the config to create or update secrets until [#180](https://github.com/awslabs/smithy-kotlin/issues/180) is implemented +* KMS +* Lambda + +NOTES: +* We currently can (theoretically) support any JSON based AWS protocol. If there is a service you would like to see added in a future release (before developer preview) please reach out and let us know. +* No customizations are currently implemented, some SDK's may not behave 100% correctly without such support. +* Retries, waiters, paginators, and other features are not yet implemented + +### Features +* Coroutine API +* DSL Builders +* Default (environment or config) or static credential providers only. Additional providers will be added in later releases. +* JVM only support (multiplatform support is on the roadmap) \ No newline at end of file diff --git a/README.md b/README.md index fd646acbde9..2e735be1461 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # AWS SDK for Kotlin - ## License This library is licensed under the Apache 2.0 License. +## Getting Started + +See the [Getting Started Guide](docs/GettingStarted.md) + + ## Development ### Generate SDK(s) diff --git a/build.gradle.kts b/build.gradle.kts index 3e5e126a890..58c9d4ec342 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -21,7 +21,8 @@ dependencies { val lintPaths = listOf( "codegen/smithy-aws-kotlin-codegen/**/*.kt", - "client-runtime/**/*.kt" + "client-runtime/**/*.kt", + "examples/**/*.kt" ) tasks.register("ktlint") { @@ -48,4 +49,4 @@ tasks.register("showRepos") { println("All repos:") println(repositories.map { it.name }) } -} \ No newline at end of file +} diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md new file mode 100644 index 00000000000..018be43c57c --- /dev/null +++ b/docs/GettingStarted.md @@ -0,0 +1,73 @@ +# Beta Release Quickstart + +Beta releases of the AWS Kotlin SDK are published as a complete maven local repository with all associated dependencies. + + +1. Download the [latest release](https://github.com/awslabs/aws-sdk-kotlin/releases) from Github + +2. Unzip the repository somewhere on your local machine + +```sh +> unzip aws-sdk-kotlin-0.1.0-M0.zip +``` + +There should be a folder named `aws-sdk-kotlin-repo` + +3. Add the local repository to your Gradle or Maven configuration + +#### Gradle Users + +```kt +# file: my-project/build.gradle.kts + + +repositories { + maven { + name = "kotlinSdkLocal" + url = uri("/path/to/aws-sdk-kotlin-repo/m2") + } + mavenCentral() +} +``` + +#### Maven Users +```xml + +... + + + kotlinSdkLocal + Beta AWS Kotlin SDK Repo + /path/to/aws-sdk-kotlin-repo/m2 + + +... + + +``` + + +4. Add services to your project + +```kt + +val awsKotlinSdkVersion = "0.1.0-M0" +// OR put it in gradle.properties +// val awsKotlinSdkVersion by project + +dependencies { + implementation(kotlin("stdlib")) + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3") + + implementation("aws.sdk.kotlin:dynamodb:$awsKotlinSdkVersion") +} +``` + + +4. Checkout the `examples` directory + + +## Giving Feedback + +* Slack - Join #aws-sdk-kotlin-interest to share feedback and get updates on SDK development +* Submit [issues](https://github.com/awslabs/aws-sdk-kotlin/issues) \ No newline at end of file diff --git a/examples/build.gradle.kts b/examples/build.gradle.kts new file mode 100644 index 00000000000..ef6d35ca4a6 --- /dev/null +++ b/examples/build.gradle.kts @@ -0,0 +1,21 @@ +plugins { + kotlin("jvm") version "1.4.31" +} + +allprojects { + group = "aws.sdk.kotlin.example" + version = "1.0-SNAPSHOT" + + repositories { + maven { + name = "kotlinSdkLocal" + url = uri(TODO("set your local repository path")) + // e.g. + //url = uri("file:///tmp/aws-sdk-kotlin-repo/m2") + } + mavenCentral() + } +} + + + diff --git a/examples/dynamodb-movies/build.gradle.kts b/examples/dynamodb-movies/build.gradle.kts new file mode 100644 index 00000000000..c31a2a97636 --- /dev/null +++ b/examples/dynamodb-movies/build.gradle.kts @@ -0,0 +1,12 @@ +plugins { + kotlin("jvm") +} + +val awsSdkKotlinVersion: String by project + +dependencies { + implementation(kotlin("stdlib")) + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3") + implementation("aws.sdk.kotlin:dynamodb:$awsSdkKotlinVersion") + implementation("com.google.code.gson:gson:2.8.6") +} diff --git a/examples/dynamodb-movies/src/main/kotlin/aws/sdk/kotlin/example/Main.kt b/examples/dynamodb-movies/src/main/kotlin/aws/sdk/kotlin/example/Main.kt new file mode 100644 index 00000000000..d55025a2026 --- /dev/null +++ b/examples/dynamodb-movies/src/main/kotlin/aws/sdk/kotlin/example/Main.kt @@ -0,0 +1,159 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ +package aws.sdk.kotlin.example + +import aws.sdk.kotlin.runtime.AwsServiceException +import aws.sdk.kotlin.services.dynamodb.DynamodbClient +import aws.sdk.kotlin.services.dynamodb.model.* +import com.google.gson.JsonElement +import com.google.gson.JsonParser +import kotlinx.coroutines.delay +import kotlinx.coroutines.runBlocking +import java.lang.IllegalStateException + +/** + * Partial implementation of: https://docs.amazonaws.cn/en_us/amazondynamodb/latest/developerguide/GettingStarted.Java.html + */ +fun main() = runBlocking { + val client = DynamodbClient { region = "us-east-2" } + + val tableName = "dynamo-movies-example" + + try { + createMoviesTable(client, tableName) + + client.waitForTableReady(tableName) + + loadMoviesTable(client, tableName) + + val films2222 = client.moviesInYear(tableName, 2222) + check(films2222.count == 0) + + val films2013 = client.moviesInYear(tableName, 2013) + check(films2013.count == 2) + + val titles = films2013.items?.mapNotNull { (it["title"] as? AttributeValue.S)?.value } + println("2013 film titles:") + println(titles) + } catch (ex: AwsServiceException) { + println(ex) + } + + client.close() +} + +suspend fun createMoviesTable(client: DynamodbClient, name: String) { + val tableExists = client.listTables(ListTablesRequest {}).tableNames?.contains(name) ?: false + if (tableExists) return + + val req = CreateTableRequest { + tableName = name + keySchema = listOf( + KeySchemaElement { + attributeName = "year" + keyType = KeyType.Hash + }, + KeySchemaElement { + attributeName = "title" + keyType = KeyType.Range + } + ) + + attributeDefinitions = listOf( + AttributeDefinition { + attributeName = "year" + attributeType = ScalarAttributeType.N + }, + AttributeDefinition { + attributeName = "title" + attributeType = ScalarAttributeType.S + } + ) + provisionedThroughput { + readCapacityUnits = 10 + writeCapacityUnits = 10 + } + } + + val resp = client.createTable(req) + println("created table: ${resp.tableDescription?.tableArn}") +} + +// no waiters support (yet) +suspend fun DynamodbClient.waitForTableReady(name: String) { + while (true) { + try { + val req = DescribeTableRequest { tableName = name } + if (describeTable(req).table?.tableStatus != TableStatus.Creating) { + println("table ready") + return + } + } catch (ex: AwsServiceException) { + if (!ex.isRetryable) throw ex + } + println("waiting for table to be ready...") + delay(1000) + } +} + +suspend fun loadMoviesTable(client: DynamodbClient, name: String) { + // load items into table + val data = getResourceAsText("data.json") + val elements = JsonParser.parseString(data).asJsonArray + elements.forEach { + // map the json element -> AttributeValue + val attrValue = jsonElementToAttributeValue(it) as? AttributeValue.M ?: throw IllegalStateException("expected a top level object value") + val req = PutItemRequest { + tableName = name + item = attrValue.value + } + + client.putItem(req) + } +} + +suspend fun DynamodbClient.moviesInYear(name: String, year: Int): QueryResponse { + val req = QueryRequest { + tableName = name + keyConditionExpression = "#yr = :yyyy" + expressionAttributeNames = mapOf( + "#yr" to "year" + ) + expressionAttributeValues = mapOf( + ":yyyy" to AttributeValue.N(year.toString()) + ) + } + return query(req) +} + +// utility/support functions + +fun getResourceAsText(path: String): String = + object {}.javaClass.getResource(path).readText() + +// map json to attribute values +fun jsonElementToAttributeValue(element: JsonElement): AttributeValue = when { + element.isJsonNull -> AttributeValue.NULL(true) + element.isJsonPrimitive -> { + val primitive = element.asJsonPrimitive + when { + primitive.isBoolean -> AttributeValue.BOOL(primitive.asBoolean) + primitive.isString -> AttributeValue.S(primitive.asString) + else -> { + check(primitive.isNumber) { "expected number" } + AttributeValue.N(primitive.asString) + } + } + } + element.isJsonArray -> AttributeValue.L(element.asJsonArray.map(::jsonElementToAttributeValue)) + element.isJsonObject -> { + AttributeValue.M( + element.asJsonObject.entrySet().associate { + it.key to jsonElementToAttributeValue(it.value) + } + ) + } + else -> throw IllegalStateException("unknown json element type: $element") +} diff --git a/examples/dynamodb-movies/src/main/resources/aws/sdk/kotlin/example/data.json b/examples/dynamodb-movies/src/main/resources/aws/sdk/kotlin/example/data.json new file mode 100644 index 00000000000..315aa202aad --- /dev/null +++ b/examples/dynamodb-movies/src/main/resources/aws/sdk/kotlin/example/data.json @@ -0,0 +1,53 @@ +[ + { + "year": 2013, + "title": "Turn It Down, Or Else!", + "info": { + "directors": [ + "Alice Smith", + "Bob Jones" + ], + "release_date": "2013-01-18T00:00:00Z", + "rating": 6.2, + "genres": [ + "Comedy", + "Drama" + ], + "image_url": "http://ia.media-imdb.com/images/N/O9ERWAU7FS797AJ7LU8HN09AMUP908RLlo5JF90EWR7LJKQ7@@._V1_SX400_.jpg", + "plot": "A rock band plays their music at high volumes, annoying the neighbors.", + "rank": 11, + "running_time_secs": 5215, + "actors": [ + "David Matthewman", + "Ann Thomas", + "Jonathan G. Neff" + ] + } + }, + { + "year": 2013, + "title": "Rush", + "info": { + "directors": [ + "Ron Howard" + ], + "release_date": "2013-09-02T00:00:00Z", + "rating": 8.3, + "genres": [ + "Action", + "Biography", + "Drama", + "Sport" + ], + "image_url": "http://ia.media-imdb.com/images/M/MV5BMTQyMDE0MTY0OV5BMl5BanBnXkFtZTcwMjI2OTI0OQ@@._V1_SX400_.jpg", + "plot": "A re-creation of the merciless 1970s rivalry between Formula One rivals James Hunt and Niki Lauda.", + "rank": 2, + "running_time_secs": 7380, + "actors": [ + "Daniel Bruhl", + "Chris Hemsworth", + "Olivia Wilde" + ] + } + } +] diff --git a/examples/gradle.properties b/examples/gradle.properties new file mode 100644 index 00000000000..236c1c067a6 --- /dev/null +++ b/examples/gradle.properties @@ -0,0 +1,4 @@ + +# AWS SDK +awsSdkKotlinVersion=0.1.0-M0 + diff --git a/examples/gradle/wrapper/gradle-wrapper.jar b/examples/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000..e708b1c023e Binary files /dev/null and b/examples/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/gradle/wrapper/gradle-wrapper.properties b/examples/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000..442d9132ea3 --- /dev/null +++ b/examples/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/gradlew b/examples/gradlew new file mode 100755 index 00000000000..4f906e0c811 --- /dev/null +++ b/examples/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/examples/gradlew.bat b/examples/gradlew.bat new file mode 100644 index 00000000000..ac1b06f9382 --- /dev/null +++ b/examples/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/settings.gradle.kts b/examples/settings.gradle.kts new file mode 100644 index 00000000000..0cfef73a710 --- /dev/null +++ b/examples/settings.gradle.kts @@ -0,0 +1,3 @@ +rootProject.name = "aws-sdk-kotlin-examples" + +include(":dynamodb-movies") diff --git a/settings.gradle.kts b/settings.gradle.kts index 414252d1957..b56e103e604 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -5,9 +5,7 @@ pluginManagement { repositories { - maven { url = uri("https://dl.bintray.com/kotlin/kotlin-eap") } - maven { url = uri("https://kotlin.bintray.com/kotlinx") } - + mavenCentral() gradlePluginPortal() }