Skip to content

Conversation

scmacdon
Copy link
Contributor

@scmacdon scmacdon commented Mar 21, 2022

aws-doc-sdk-examples Pull Request

Thank you for making a submission to the aws-doc-sdk-examples repository. For more information about submitting pull requests to this repository, see Guidelines for contributing.

NOTE: This PR template contains three sections. Depending on the reason for your pull request, please fill out the section that applies to you and then remove the other two sections.

New SDK Code Example

The submitter has:

  • Added the default copyright notice to all files.
  • Created unit tests for all paths through the code and they all pass.
  • Run a linter against all code and implemented the resulting suggestions.
  • Added minimum usage documentation as comments in the code.
  • Had comments and strings reviewed and incorporated suggested changes.
  • Had the code reviewed and implemented the reviewer's suggested changes.

Existing Example Update

The submitter has:

  • Confirmed that the correct copyright is included in all files.
  • Major code changes have been reviewed, and the submitter has incorporated review comments.
  • Changed or added comments and strings have been reviewed, and the submitter has incorporated any and all suggested edits.

Resolve Issue

Issue #

Description of Changes

Please describe the changes you have made here.

  • I have tested my changes and created unit tests for new code paths.
  • Changes have been reviewed, and all reviewer comments have been incorporated.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@scmacdon scmacdon self-assigned this Mar 21, 2022
Copy link
Contributor

@lkdavies lkdavies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Editorial comments

Comment on lines 29 to 30
* Prior to running this code example, create an Amazon DynamoDB table named Contact with this column:
* 1. id - The id of the record that is the key
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Before running this code example, create an Amazon DynamoDB table named Contact with the following column:
    1. id - The id of the record that is the key.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

*
* Also, ensure that you have set up your development environment, including your credentials.
*
* For information, see this documentation topic:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For more information, see the following documentation topic:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

* 1. id - The id of the record that is the key
*
*
* Also, ensure that you have set up your development environment, including your credentials.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • You should also set up your development environment, including your credentials.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

try {
DynamoDbTable<Contact> contactTable = (DynamoDbTable<Contact>) enhancedClient.table("Contact", TableSchema.fromBean(Contact.class));

// Create a list
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add ending punctuation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

names.add("LAM");
names.add("Madison");

// Populate the Table
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// Populate the table.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -0,0 +1,66 @@
# Amazon Kendra code examples for the AWS SDK for Kotlin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazon Kendra code examples for the SDK for Kotlin

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

# Amazon Kendra code examples for the AWS SDK for Kotlin

## Overview
This README discusses how to run and test the Kotlin code examples for Amazon Kendra.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kotlin --> AWS SDK for Kotlin

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

- **indexName** - The name for the new index.
- **dataSourceName** - The name for the new data source.
- **indexDescription** - The description for the index.
- **indexRoleArn** – An Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Identity and Access Management (IAM) --> AWS Identity and Access Management (IAM)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

- **s3BucketName** - An Amazon S3 bucket name used as your data source.
- **dataSourceDescription** – A description for the data source.
- **text** – The text used to perform a query operation.
- **dataSourceRoleArn** – The ARN of am IAM role with permission to access the data source.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • dataSourceRoleArn – The Amazon Resource Name (ARN) of an IAM role with permission to access the data source.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

- **dataSourceRoleArn** – The ARN of am IAM role with permission to access the data source.

## Additional resources
* [Developer guide - AWS SDK for Kotlin](https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize "Guide"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@brmur brmur merged commit 3d56d62 into awsdocs:main Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants