guide refresh

awsdocs · Nov 25, 2020 · dfc628e · dfc628e
1 parent f2b47f6
commit dfc628e
Show file tree

Hide file tree

Showing 36 changed files with 342 additions and 142 deletions.
diff --git a/doc_source/examples-asynchronous.rst → doc_source/asynchronous.rst b/doc_source/examples-asynchronous.rst → doc_source/asynchronous.rst
diff --git a/doc_source/credentials.rst b/doc_source/credentials.rst
@@ -93,7 +93,7 @@ To use AWS credentials, supply them in at least one of the
 preceding locations. For information about setting credentials, see the following topics:
 
 * To supply credentials in the :emphasis:`environment` or in the default
-  :emphasis:`credential profiles file`, see :doc:`setup-credentials`.
+  :emphasis:`credential profiles file`, see :ref:`setup-credentials`.
 
 * To set Java :emphasis:`system properties`, see the
   `System Properties <http://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html>`_
@@ -228,3 +228,6 @@ The following example creates a new service client that uses credentials that yo
    S3Client s32 = S3Client.builder()
                           .credentialsProvider(StaticCredentialsProvider.create(awsCreds))
                           .build();
+.. toctree::
+
+   ec2-iam-roles
diff --git a/doc_source/java-dg-roles.rst → doc_source/ec2-iam-roles.rst b/doc_source/java-dg-roles.rst → doc_source/ec2-iam-roles.rst
diff --git a/doc_source/examples-cloudwatch.rst b/doc_source/examples-cloudwatch.rst
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-##################################
-|CW| examples using the |sdk-java|
-##################################
+#################
+Working with |CW|
+#################
 
 .. meta::
    :description: Programming Amazon Cloudwatch by using the AWS SDK for Java 2.x

diff --git a/doc_source/examples-cognito.rst b/doc_source/examples-cognito.rst
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-##############
-|COG| examples
-##############
+##################
+Working with |COG|
+##################
 
 .. meta::
    :description: How to use the AWS SDK for Java to work with Amazon Cognito.

diff --git a/doc_source/examples-dynamodb.rst b/doc_source/examples-dynamodb.rst
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-#############################################
-|ddb| Examples Using the |sdk-java|
-#############################################
+##################
+Working with |ddb|
+##################
 
 .. meta::
    :description: Programming Amazon DynamoDB using the AWS SDK for Java 2.x

diff --git a/doc_source/examples-ec2.rst b/doc_source/examples-ec2.rst
@@ -1,4 +1,4 @@
-.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
    International License (the "License"). You may not use this file except in compliance with the
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-#############################################
-|EC2| Examples Using the |sdk-java|
-#############################################
+##################
+Working with |EC2|
+##################
 
 .. meta::
    :description: Programming Amazon EC2 by using the AWS SDK for Java 2.x

diff --git a/doc_source/examples-iam.rst b/doc_source/examples-iam.rst
@@ -1,4 +1,4 @@
-.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
    International License (the "License"). You may not use this file except in compliance with the
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-###################################
-|IAM| Examples Using the |sdk-java|
-###################################
+##################
+Working with |IAM|
+##################
 
 .. meta::
    :description: Programming AWS Identity and Access Management using the AWS SDK for Java 2.x

diff --git a/doc_source/examples-kinesis.rst b/doc_source/examples-kinesis.rst
@@ -1,4 +1,4 @@
-.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
    International License (the "License"). You may not use this file except in compliance with the
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-##################################
-|AK| Examples Using the |sdk-java|
-##################################
+#################
+Working with |AK|
+#################
 
 .. meta::
    :description: Programming Amazon Kinesis using the AWS SDK for Java 2.x

diff --git a/doc_source/examples-pinpoint.rst b/doc_source/examples-pinpoint.rst
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-##################
-|PINlong| examples
-##################
+######################
+Working with |PINlong|
+######################
 
 .. meta::
    :description: How to use the AWS SDK for Java to work with |PINlong|.

diff --git a/doc_source/examples-sqs.rst b/doc_source/examples-sqs.rst
@@ -1,4 +1,4 @@
-.. Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
    International License (the "License"). You may not use this file except in compliance with the
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-###########################################
-|sqs| Examples Using the |sdk-java|
-###########################################
+##################
+Working with |sqs|
+##################
 
 .. meta::
    :description: Programming Amazon SQS using the AWS SDK for Java 2.x

diff --git a/doc_source/examples-transcribe.rst b/doc_source/examples-transcribe.rst
@@ -1,4 +1,4 @@
-.. Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
    International License (the "License"). You may not use this file except in compliance with the
@@ -8,9 +8,9 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-#############################################
-|TSC| Examples Using the |sdk-java|
-#############################################
+##################
+Working with |TSC|
+##################
 
 .. meta::
    :description: Programming Amazon DynamoDB using the AWS SDK for Java 2.x

diff --git a/doc_source/examples.rst b/doc_source/examples.rst
@@ -31,42 +31,40 @@ For instructions, see the "Proposing new code examples" section in the
 .. toctree::
    :maxdepth: 1
 
-   Working with Amazon S3 <examples-s3>
-   Working with Amazon DynamoDB <examples-dynamodb>
-   Working with Amazon EC2 <examples-ec2>
-   Working with Amazon IAM <examples-iam>
-   examples-asynchronous
-   examples-pagination
-   Working with Amazon Athena <examples-athena>
-   Working with Amazon CloudWatch <examples-cloudwatch>
-   Working with Amazon CloudTrail <examples-cloudtrail>
-   Working with Amazon Cognito <examples-cognito>
-   Working with Amazon Comprehend <examples-comprehend>
-   Working with Amazon EventBridge <examples-eventbridge>
-   Working with Amazon Firehose <examples-firehose>
-   Working with Amazon Forecast <examples-forecast>
-   Working with Amazon S3 Glacier <examples-glacier>
-   Working with AWS Glue <examples-glue>
-   Working with Amazon Kinesis <examples-kinesis>
-   Working with Amazon KMS <examples-kms>
-   Working with AWS Lambda <examples-lambda>
-   Working with Amazon MediaConvert <examples-mediaconvert>
-   Working with Amazon MediaStore <examples-mediastore>
-   Working with Amazon MigrationHub <examples-migrationhub>
-   Working with Amazon Personalize <examples-personalize>
-   Working with Amazon Pinpoint <examples-pinpoint>
-   Working with Amazon Polly <examples-polly>
-   Working with Amazon RDS <examples-rds>
-   Working with Amazon Redshift <examples-redshift>
-   Working with Amazon Rekognition <examples-rekognition>
-   Working with Amazon SageMaker <examples-sagemaker>
-   Working with Amazon Secrets Manager <examples-secretsmanager>
-   Working with Amazon Simple Email Service <examples-ses>
-   Working with Amazon Simple Notification Service <examples-simple-notification-service>
-   Working with Amazon SQS <examples-sqs>
-   Working with AWS Systems Manager <examples-ssm>
-   Working with Amazon Simple Workflow Service <examples-swf>
-   Working with Amazon Textract <examples-textract>
-   Working with Amazon Transcribe <examples-transcribe>
-   Working with Amazon Translate <examples-translate>
-   Working with Amazon WorkDocs <examples-workdocs>
+   Amazon S3 <examples-s3>
+   Amazon DynamoDB <examples-dynamodb>
+   Amazon EC2 <examples-ec2>
+   Amazon IAM <examples-iam>
+   Amazon Athena <examples-athena>
+   Amazon CloudWatch <examples-cloudwatch>
+   Amazon CloudTrail <examples-cloudtrail>
+   Amazon Cognito <examples-cognito>
+   Amazon Comprehend <examples-comprehend>
+   Amazon EventBridge <examples-eventbridge>
+   Amazon Firehose <examples-firehose>
+   Amazon Forecast <examples-forecast>
+   Amazon S3 Glacier <examples-glacier>
+   AWS Glue <examples-glue>
+   Amazon Kinesis <examples-kinesis>
+   Amazon KMS <examples-kms>
+   AWS Lambda <examples-lambda>
+   Amazon MediaConvert <examples-mediaconvert>
+   Amazon MediaStore <examples-mediastore>
+   Amazon MigrationHub <examples-migrationhub>
+   Amazon Personalize <examples-personalize>
+   Amazon Pinpoint <examples-pinpoint>
+   Amazon Polly <examples-polly>
+   Amazon RDS <examples-rds>
+   Amazon Redshift <examples-redshift>
+   Amazon Rekognition <examples-rekognition>
+   Amazon SageMaker <examples-sagemaker>
+   Amazon Secrets Manager <examples-secretsmanager>
+   Amazon Simple Email Service <examples-ses>
+   Amazon Simple Notification Service <examples-simple-notification-service>
+   Amazon SQS <examples-sqs>
+   AWS Systems Manager <examples-ssm>
+   Amazon Simple Workflow Service <examples-swf>
+   Amazon Textract <examples-textract>
+   Amazon Transcribe <examples-transcribe>
+   Amazon Translate <examples-translate>
+   Amazon WorkDocs <examples-workdocs>
diff --git a/doc_source/get-started.rst b/doc_source/get-started.rst
@@ -128,11 +128,11 @@ Configure your development environment with your Access Key ID and the Secret Ac
    #. In the text file you just created, replace *YOUR_AWS_ACCESS_KEY* with your unique AWS access
       key ID, and replace *YOUR_AWS_SECRET_ACCESS_KEY* with your unique AWS secret access key.
 
-   #. Save the file without a file extension. Refer to the following table for the correct location and file name based on
-      your operating system.
+   #. Save the file without a file extension. Refer to the following table for the correct location
+      and file name based on your operating system.
 
       +---------------------+----------------------------------------------------------------------+
-      | Operating system    | File name                                                             |
+      | Operating system    | File name                                                            |
       +=====================+======================================================================+
       | Windows             | :file:`C:\\Users\\<yourUserName>\\.aws\\credentials`                 |
       +---------------------+----------------------------------------------------------------------+

diff --git a/doc_source/java-dg-exceptions.rst → doc_source/handling-exceptions.rst b/doc_source/java-dg-exceptions.rst → doc_source/handling-exceptions.rst
diff --git a/doc_source/configuration-http-crt.rst → doc_source/http-configuration-crt.rst b/doc_source/configuration-http-crt.rst → doc_source/http-configuration-crt.rst
diff --git a/doc_source/configuration-http-netty.rst → doc_source/http-configuration-netty.rst b/doc_source/configuration-http-netty.rst → doc_source/http-configuration-netty.rst
diff --git a/doc_source/configuration-http.rst → doc_source/http-configuration.rst b/doc_source/configuration-http.rst → doc_source/http-configuration.rst
@@ -38,8 +38,8 @@ For a full list of options you can set with these clients, see the
    :maxdepth: 1
    :titlesonly:
 
-   configuration-http-crt
-   configuration-http-netty
+   http-configuration-crt
+   http-configuration-netty
 
 
 Setting maximum connections

diff --git a/doc_source/index.rst b/doc_source/index.rst
@@ -23,8 +23,8 @@
    AWS SDK for Java 2.x <home>
    Quick start <get-started>
    Setting up <setup>
-   Configuring the SDK <configuration>
-   Code examples <examples>
+   Using the SDK <using>
+   Working with Amazon Web Services <examples>
    Security <security>
    document-history
 

diff --git a/doc_source/java-dg-jvm-ttl.rst → doc_source/jvm-ttl-dns.rst b/doc_source/java-dg-jvm-ttl.rst → doc_source/jvm-ttl-dns.rst
diff --git a/...source/configuration-lambda-starttime.rst → doc_source/lambda-optimize-starttime.rst b/...source/configuration-lambda-starttime.rst → doc_source/lambda-optimize-starttime.rst
diff --git a/doc_source/java-dg-logging.rst → doc_source/logging-slf4j.rst b/doc_source/java-dg-logging.rst → doc_source/logging-slf4j.rst
diff --git a/doc_source/configuration-metrics-list.rst → doc_source/metrics-list.rst b/doc_source/configuration-metrics-list.rst → doc_source/metrics-list.rst
diff --git a/doc_source/configuration-metrics.rst → doc_source/metrics.rst b/doc_source/configuration-metrics.rst → doc_source/metrics.rst
@@ -8,16 +8,16 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-#######################
-Configuring SDK metrics
-#######################
+####################
+Enabling SDK metrics
+####################
 
 .. meta::
    :description: How to enable and configure metrics collection and publishing for the AWS SDK for
    Java v2
    :keywords: AWS SDK for Java, metrics, configuration, service client, collect, data, CloudWatch
 
-With the AWS SDK for Java version 2 (v2), you can collect metrics about the service clients in your
+With the AWS SDK for Java 2.x, you can collect metrics about the service clients in your
 application, analyze the output in Amazon CloudWatch, and then act on it.
 
 By default, metrics collection is disabled in the SDK. This topic helps you to enable and configure
@@ -27,7 +27,7 @@ it.
    :titlesonly:
    :maxdepth: 1
 
-   configuration-metrics-list
+   metrics-list
 
 Prerequisites
 =============

diff --git a/doc_source/examples-pagination.rst → doc_source/pagination.rst b/doc_source/examples-pagination.rst → doc_source/pagination.rst
@@ -23,7 +23,7 @@ you had to use to retrieve the next page of results. New in the |sdk-java-v2| ar
 autopagination methods that make multiple
 service calls to get the next page of results for you automatically.
 You only have to write code that processes the results. Additionally both types of methods
-have synchronous and asynchronous versions. See :doc:`basics-async` for more detail about
+have synchronous and asynchronous versions. See :doc:`examples-asynchronous` for more detail about
 asynchronous clients.
 
 The following examples use |S3| and |DDBlong| operations to demonstrate the

diff --git a/doc_source/java-dg-region-selection.rst → doc_source/region-selection.rst b/doc_source/java-dg-region-selection.rst → doc_source/region-selection.rst
diff --git a/doc_source/compliance-validation.rst → ...source/security-compliance-validation.rst b/doc_source/compliance-validation.rst → ...source/security-compliance-validation.rst
diff --git a/doc_source/data-protection.rst → doc_source/security-data-protection.rst b/doc_source/data-protection.rst → doc_source/security-data-protection.rst
diff --git a/doc_source/infrastructure-security.rst → doc_source/security-infrastructure.rst b/doc_source/infrastructure-security.rst → doc_source/security-infrastructure.rst
diff --git a/doc_source/disaster-recovery-resiliency.rst → doc_source/security-resilience.rst b/doc_source/disaster-recovery-resiliency.rst → doc_source/security-resilience.rst
diff --git a/doc_source/security.rst b/doc_source/security.rst
@@ -24,9 +24,9 @@ Security for the |sdk-java|
    :maxdepth: 1
    :titlesonly:
 
-   Data protection <data-protection>
+   Data protection <security-data-protection>
    Enforcing TLS 1.2 <security-java-tls>
    Identity and access management <security-iam>
-   Compliance validation <compliance-validation>
-   Resilience <disaster-recovery-resiliency>
-   Infrastructure security <infrastructure-security>
+   Compliance validation <security-compliance-validation>
+   Resilience <security-resilience>
+   Infrastructure security <security-infrastructure>
diff --git a/doc_source/setup-project-gradle.rst b/doc_source/setup-project-gradle.rst
@@ -8,22 +8,22 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-#########################
-Using the SDK with Gradle
-#########################
+###########################
+Setting up a Gradle project
+###########################
 
 .. meta::
    :description:  How to use Gradle to set up your AWS SDK for Java v2 project
    :keywords: AWS SDK for Java, v2, Gradle, BOM, install, download, setup
 
 
-You can use Gradle_ to configure and build AWS SDK for Java projects.
+You can use Gradle_ to set up and build AWS SDK for Java projects.
 
 To manage SDK dependencies for your Gradle project, import the Maven bill of materials (BOM) for
 the |sdk-java| into the :file:`build.gradle` file.
 
-.. note:: In the following examples, replace *2.X.X* in the :file:`build.gradle` file with a valid
-          version of the AWS SDK for Java v2. Find the latest version in the
+.. note:: In the following examples, replace *2.15.0* in the :file:`build.gradle` file with the
+          latest version of the AWS SDK for Java v2. Find the latest version in the
           :aws-java-class-root:`AWS SDK for Java API Reference version 2.x<>`.
 
 .. topic:: To configure the |sdk-java| for Gradle version 5.0 or later
@@ -34,7 +34,7 @@ the |sdk-java| into the :file:`build.gradle` file.
 
           ...
           dependencies {
-            implementation platform('software.amazon.awssdk:bom:2.X.X')
+            implementation platform('software.amazon.awssdk:bom:2.15.0')
 
             // Declare individual SDK dependencies without version
             ...
@@ -74,7 +74,7 @@ The following is an example of a complete :file:`build.gradle` file that include
    }
 
    dependencies {
-     implementation platform('software.amazon.awssdk:bom:2.X.X')
+     implementation platform('software.amazon.awssdk:bom:2.15.0')
      implementation 'software.amazon.awssdk:kinesis'
      testImplementation group: 'junit', name: 'junit', version: '4.11'
    }

diff --git a/doc_source/setup-project-maven.rst b/doc_source/setup-project-maven.rst
@@ -8,11 +8,11 @@
    either express or implied. See the License for the specific language governing permissions and
    limitations under the License.
 
-###############################
-Using the SDK with Apache Maven
-###############################
+##################################
+Setting up an Apache Maven project
+##################################
 
-You can use |mvnlong|_ to configure and build |sdk-java| projects, or to build the SDK itself.
+You can use |mvnlong|_ to set up and build |sdk-java| projects, or to build the SDK itself.
 
 Prerequisites
 =============