AWS AmazonS3 documentation change
Summary
Replaced detailed Java code example with a simplified description and reference link to API documentation
Security assessment
The change removes a code sample and replaces it with general guidance and a reference link. There is no evidence of security vulnerability fixes or security feature additions. This appears to be routine documentation simplification.
Diff
diff --git a/AmazonS3/latest/userguide/using-select.md b/AmazonS3/latest/userguide/using-select.md index be14d79da..77e499ba8 100644 --- a//AmazonS3/latest/userguide/using-select.md +++ b//AmazonS3/latest/userguide/using-select.md @@ -43,101 +43,5 @@ Java -The following Java code returns the value of the first column for each record that is stored in an object that contains data stored in CSV format. It also requests `Progress` and `Stats` messages to be returned. You must provide a valid bucket name and an object that contains data in CSV format. - -For instructions on creating and testing a working sample, see [Getting Started](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/getting-started.html) in the AWS SDK for Java Developer Guide. - - - package com.amazonaws; - - import com.amazonaws.services.s3.AmazonS3; - import com.amazonaws.services.s3.AmazonS3ClientBuilder; - import com.amazonaws.services.s3.model.CSVInput; - import com.amazonaws.services.s3.model.CSVOutput; - import com.amazonaws.services.s3.model.CompressionType; - import com.amazonaws.services.s3.model.ExpressionType; - import com.amazonaws.services.s3.model.InputSerialization; - import com.amazonaws.services.s3.model.OutputSerialization; - import com.amazonaws.services.s3.model.SelectObjectContentEvent; - import com.amazonaws.services.s3.model.SelectObjectContentEventVisitor; - import com.amazonaws.services.s3.model.SelectObjectContentRequest; - import com.amazonaws.services.s3.model.SelectObjectContentResult; - - import java.io.File; - import java.io.FileOutputStream; - import java.io.InputStream; - import java.io.OutputStream; - import java.util.concurrent.atomic.AtomicBoolean; - - import static com.amazonaws.util.IOUtils.copy; - - /** - * This example shows how to query data from S3Select and consume the response in the form of an - * InputStream of records and write it to a file. - */ - - public class RecordInputStreamExample { - - private static final String BUCKET_NAME = "${my-s3-bucket}"; - private static final String CSV_OBJECT_KEY = "${my-csv-object-key}"; - private static final String S3_SELECT_RESULTS_PATH = "${my-s3-select-results-path}"; - private static final String QUERY = "select s._1 from S3Object s"; - - public static void main(String[] args) throws Exception { - final AmazonS3 s3Client = AmazonS3ClientBuilder.defaultClient(); - - SelectObjectContentRequest request = generateBaseCSVRequest(BUCKET_NAME, CSV_OBJECT_KEY, QUERY); - final AtomicBoolean isResultComplete = new AtomicBoolean(false); - - try (OutputStream fileOutputStream = new FileOutputStream(new File (S3_SELECT_RESULTS_PATH)); - SelectObjectContentResult result = s3Client.selectObjectContent(request)) { - InputStream resultInputStream = result.getPayload().getRecordsInputStream( - new SelectObjectContentEventVisitor() { - @Override - public void visit(SelectObjectContentEvent.StatsEvent event) - { - System.out.println( - "Received Stats, Bytes Scanned: " + event.getDetails().getBytesScanned() - + " Bytes Processed: " + event.getDetails().getBytesProcessed()); - } - - /* - * An End Event informs that the request has finished successfully. - */ - @Override - public void visit(SelectObjectContentEvent.EndEvent event) - { - isResultComplete.set(true); - System.out.println("Received End Event. Result is complete."); - } - } - ); - - copy(resultInputStream, fileOutputStream); - } - - /* - * The End Event indicates all matching records have been transmitted. - * If the End Event is not received, the results may be incomplete. - */ - if (!isResultComplete.get()) { - throw new Exception("S3 Select request was incomplete as End Event was not received."); - } - } - - private static SelectObjectContentRequest generateBaseCSVRequest(String bucket, String key, String query) { - SelectObjectContentRequest request = new SelectObjectContentRequest(); - request.setBucketName(bucket); - request.setKey(key); - request.setExpression(query); - request.setExpressionType(ExpressionType.SQL); - - InputSerialization inputSerialization = new InputSerialization(); - inputSerialization.setCsv(new CSVInput()); - inputSerialization.setCompressionType(CompressionType.NONE); - request.setInputSerialization(inputSerialization); - - OutputSerialization outputSerialization = new OutputSerialization(); - outputSerialization.setCsv(new CSVOutput()); - request.setOutputSerialization(outputSerialization); - - return request; - } - } +To use Amazon S3 Select with the AWS SDK for Java, you can return the value of the first column for each record that is stored in an object that contains data stored in CSV format. You can also request `Progress` and `Stats` messages to be returned. You must provide a valid bucket name and an object that contains data in CSV format. + +To use Amazon S3 Select with the AWS SDK for Java, you can return the value of the first column for each record that is stored in an object that contains data stored in CSV format. You can also request `Progress` and `Stats` messages to be returned. You must provide a valid bucket name and an object that contains data in CSV format. + +For examples of how to use Amazon S3 Select with the AWS SDK for Java, see [Select content from an object](https://docs.aws.amazon.com/AmazonS3/latest/API/s3_example_s3_SelectObjectContent_section.html) in the _Amazon S3 API Reference_.