- Notifications
You must be signed in to change notification settings - Fork 5.8k
DynamoDB examples cleanup #1241
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edits for descriptions, comment strings.
| @@ -0,0 +1,82 @@ | |||
| //Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the date range for copyright--no longer required to use.
| @@ -0,0 +1,82 @@ | |||
| //Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | |||
| | |||
| /* ABOUT THIS NODE.JS EXAMPLE:This sample is part of the SDK for JavaScript Developer Guide topic at | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(need a space following "EXAMPLE:" )
edit: ...This example is part...the AWS SDK for...
| //Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| | ||
| /* ABOUT THIS NODE.JS EXAMPLE:This sample is part of the SDK for JavaScript Developer Guide topic at | ||
| // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-query-scan.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need ending punctuation after URL.
| /* ABOUT THIS NODE.JS EXAMPLE:This sample is part of the SDK for JavaScript Developer Guide topic at | ||
| // https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-query-scan.html | ||
| Purpose: | ||
| ddb_batchwriteritem_tv.js populates the table used for the match query example https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-query-scan.html . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(remove the space between "html" and ending punctuation)
| // snippet-start:[dynamodb.JavaScript.v3.batch.BatchWriterItemTV] | ||
| // Import required AWS-SDK clients and commands for Node.js | ||
| const {DynamoDBClient, BatchWriteItemCommand } = require("@aws-sdk/client-dynamodb"); | ||
| // Set the AWS region |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...AWS Region
| node ddb_query.js REGION | ||
| */ | ||
| // snippet-start:[dynamodb.JavaScript.v3.table.query] | ||
| // Import required AWS-SDK clients and commands for Node.js |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AWS SDK
| // Import required AWS-SDK clients and commands for Node.js | ||
| const {DynamoDBClient, | ||
| QueryCommand} = require("@aws-sdk/client-dynamodb"); | ||
| // Set the AWS region |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...AWS Region
| @@ -0,0 +1,34 @@ | |||
| --- | |||
| # Amazon Elastic Compute Cloud (ddb) basic usage examples | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(ddb)? does this refer to DynamoDB, or is it the wrong acronym, should be Amazon EC2? If latter, then use the short name and no ddb:
Amazon EC2 basic usage examples
| @@ -1,49 +1,49 @@ | |||
| --- | |||
| # Amazon Elastic Compute Cloud (EC2) basic usage examples | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazon EC2 basic usage examples
| @@ -1,43 +1,43 @@ | |||
| --- | |||
| # Amazon Simple Storage Service (S3) examples | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazon S3 examples
Refactored and updated for V3 JS SDK.
Added Unit Tests
The submitter has added the default copyright notice to all files.
The submitter has added unit tests for all code paths, run all of them, and they all pass.
The submitter has run a linter on the code, and all of the submitter's team's minimum rules pass.
The submitter has added the team's minimum usage documentation to the code.
The submitter has had their Editor edit all comments and strings, and the submitter has incorporated any and all resulting edits.
The submitter has added all of the submitter's team's related API reporting metadata.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.